MAINT: stats: fix lint and mypy checks

tirthasheshpatel · Jul 15, 2021 · 89c9a98 · 89c9a98
1 parent 01015cd
commit 89c9a98
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 4 deletions.
diff --git a/doc/source/tutorial/stats/sampling_dau.rst b/doc/source/tutorial/stats/sampling_dau.rst
@@ -80,9 +80,12 @@ table which can be changed by passing a ``urn_factor`` parameter.
 
 .. note:: It is recommended to keep this parameter under 2.
 
+Please see [1]_ and [2]_ for more details on this method.
+
 
 References
 ----------
+
 .. [1] UNU.RAN reference manual, Section 5.8.2,
        "DAU - (Discrete) Alias-Urn method",
        http://statmath.wu.ac.at/software/unuran/doc/unuran.html#DAU

diff --git a/doc/source/tutorial/stats/sampling_tdr.rst b/doc/source/tutorial/stats/sampling_tdr.rst
@@ -174,6 +174,9 @@ found in `Section 5.3.16 of the UNU.RAN user manual
 <http://statmath.wu.ac.at/software/unuran/doc/unuran.html#TDR>`__.
 
 
+Please see [1]_, [2]_, and [3]_ for more details on this method.
+
+
 References
 ----------
 

diff --git a/scipy/stats/__init__.py b/scipy/stats/__init__.py
@@ -379,6 +379,7 @@
    NumericalInverseHermite
    TransformedDensityRejection
    DiscreteAliasUrn
+   UNURANError
 
 Circular statistical functions
 ------------------------------

diff --git a/scipy/stats/_unuran/unuran_wrapper.pyi b/scipy/stats/_unuran/unuran_wrapper.pyi
@@ -12,6 +12,10 @@ ArrayLike0D = Union[bool, int, float, complex, str, bytes, np.generic]
 __all__: List[str]
 
 
+class UNURANError(RuntimeError):
+    ...
+
+
 class Method:
     @overload
     def rvs(self, size: None = ...) -> float | int: ...  # type: ignore[misc]

diff --git a/scipy/stats/_unuran/unuran_wrapper.pyx.templ b/scipy/stats/_unuran/unuran_wrapper.pyx.templ
@@ -45,6 +45,7 @@ cdef extern from "unuran_callback.h":
 
 
 class UNURANError(RuntimeError):
+    """Raised when an error occurs in the UNU.RAN library."""
     pass
 
 

diff --git a/scipy/stats/tests/test_sampling.py b/scipy/stats/tests/test_sampling.py
@@ -44,7 +44,7 @@ class common_discr_dist:
     # Returning wrong type
     (lambda x: [], TypeError, r"must be real number, not list"),
     # Undefined name inside the function
-    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]
+    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]  # noqa: F821
     # Infinite value returned => Overflow error.
     (lambda x: np.inf, UNURANError, r"50 : PDF\(x\) overflow"),
     # NaN value => internal error in UNU.RAN
@@ -68,7 +68,7 @@ class common_discr_dist:
     # Returning wrong type
     (lambda x: [], TypeError, r"must be real number, not list"),
     # Undefined name inside the function
-    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]
+    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]  # noqa: F821
     # signature of dPDF wrong
     (lambda: 1.0, TypeError, r"takes 0 positional arguments but 1 was given")
 ]
@@ -83,7 +83,7 @@ class common_discr_dist:
     (lambda x: np.nan, UNURANError, r"240 : unknown error"),
     (lambda x: 0.0, UNURANError, r"240 : unknown error"),
     # Undefined name inside the function
-    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]
+    (lambda x: foo, NameError, r"name 'foo' is not defined"),  # type: ignore[name-defined]  # noqa: F821
     # Returning wrong type
     (lambda x: [], TypeError, r"must be real number, not list"),
     # probabilities < 0
@@ -509,7 +509,7 @@ def test_basic(self, distname, params):
         (lambda x: 0.0, ValueError,
          r"must contain at least one non-zero value"),
         # Undefined name inside the function
-        (lambda x: foo, NameError,  # type: ignore[name-defined]
+        (lambda x: foo, NameError,  # type: ignore[name-defined]  # noqa: F821
          r"name 'foo' is not defined"),
         # Returning wrong type.
         (lambda x: [], ValueError,