MAINT: stats: use renamed _biasedurn and add deprecation warning

.gitignore

@@ -278,6 +278,8 @@ scipy/stats/mvnmodule.c
 scipy/stats/statlibmodule.c
 scipy/stats/vonmises_cython.c
 scipy/stats/_stats.c
+scipy/stats/_biasedurn.cxx
+scipy/stats/_biasedurn.pyx
 scipy/stats/biasedurn.cxx
 scipy/stats/biasedurn.pyx
 scipy/stats/_sobol.c

mypy.ini

@@ -173,7 +173,7 @@ ignore_missing_imports = True
 [mypy-scipy.optimize._trlib._trlib]
 ignore_missing_imports = True
 
-[mypy-scipy.stats.biasedurn]
+[mypy-scipy.stats._biasedurn]
 ignore_missing_imports = True
 
 [mypy-scipy.stats._boost.*]

scipy/stats/_discrete_distns.py

@@ -16,7 +16,7 @@
  rv_discrete, _ncx2_pdf, _ncx2_cdf, get_distribution_names,
  _check_shape)
 import scipy.stats._boost as _boost
-from .biasedurn import (_PyFishersNCHypergeometric,
+from ._biasedurn import (_PyFishersNCHypergeometric,
  _PyWalleniusNCHypergeometric,
  _PyStochasticLib3)
 

scipy/stats/_generate_pyx.py

@@ -16,7 +16,7 @@ def isNPY_OLD():
 
 def make_biasedurn():
  '''Substitute True/False values for NPY_OLD Cython build variable.'''
- biasedurn_base = (pathlib.Path(__file__).parent / 'biasedurn').absolute()
+ biasedurn_base = (pathlib.Path(__file__).parent / '_biasedurn').absolute()
  with open(biasedurn_base.with_suffix('.pyx.templ'), 'r') as src:
  contents = src.read()
  with open(biasedurn_base.with_suffix('.pyx'), 'w') as dest:

scipy/stats/biasedurn.py

@@ -0,0 +1,29 @@
+# This file is not meant for public use and will be removed in SciPy v2.0.0.
+
+
+import warnings
+from . import _biasedurn
+
+
+__all__ = [ # noqa: F822
+ '_PyFishersNCHypergeometric',
+ '_PyWalleniusNCHypergeometric',
+ '_PyStochasticLib3'
+]
+
+
+def __dir__():
+ return __all__
+
+
+def __getattr__(name):
+ if name not in __all__:
+ raise AttributeError(
+ "scipy.stats.biasedurn is deprecated and has no attribute "
+ f"{name}.")
+
+ warnings.warn("the `scipy.stats.biasedurn` namespace is deprecated and "
+ "will be removed in SciPy v2.0.0.",
+ category=DeprecationWarning, stacklevel=2)
+
+ return getattr(_biasedurn, name)

scipy/stats/mvn.py

@@ -21,7 +21,7 @@ def __getattr__(name):
  if name not in __all__:
  raise AttributeError(
  "scipy.stats.mvn is deprecated and has no attribute "
- f"{name}. Try looking in scipy.special instead.")
+ f"{name}. Try looking in scipy.stats instead.")
 
  warnings.warn(f"Please use `{name}` from the `scipy.stats` namespace, "
  "the `scipy.stats.mvn` namespace is deprecated.",

scipy/stats/setup.py

@@ -56,7 +56,7 @@ def configuration(parent_package='', top_path=None):
  config.ext_modules.append(ext)
 
  # add BiasedUrn module
- config.add_data_files('biasedurn.pxd')
+ config.add_data_files('_biasedurn.pxd')
  from _generate_pyx import isNPY_OLD # type: ignore[import]
  NPY_OLD = isNPY_OLD()
 
@@ -70,9 +70,9 @@ def configuration(parent_package='', top_path=None):
  biasedurn_libdirs += get_info('npymath')['library_dirs']
 
  ext = config.add_extension(
- 'biasedurn',
+ '_biasedurn',
  sources=[
- 'biasedurn.cxx',
+ '_biasedurn.cxx',
  'biasedurn/impls.cpp',
  'biasedurn/fnchyppr.cpp',
  'biasedurn/wnchyppr.cpp',

scipy/stats/statlib.py

@@ -20,7 +20,7 @@ def __getattr__(name):
  if name not in __all__:
  raise AttributeError(
  "scipy.stats.statlib is deprecated and has no attribute "
- f"{name}. Try looking in scipy.special instead.")
+ f"{name}. Try looking in scipy.stats instead.")
 
  warnings.warn(f"Please use `{name}` from the `scipy.stats` namespace, "
  "the `scipy.stats.statlib` namespace is deprecated.",