🎨 _typing: DRY Falsy and Truthy type aliases (#390)

Author: jorenham

scipy-stubs/_lib/_elementwise_iterative_method.pyi

@@ -1,11 +1,12 @@
 from collections.abc import Callable, Iterable, Mapping, Sequence
 from types import ModuleType
-from typing import Any, Concatenate, Final, Literal, TypeAlias
+from typing import Any, Concatenate, Final, TypeAlias
 from typing_extensions import TypeVar
 
 import numpy as np
 import optype as op
 import optype.numpy as onp
+from scipy._typing import Falsy
 from ._util import _RichResult
 
 ###
@@ -35,7 +36,7 @@ def _initialize(
     func: _FuncRealT,
     xs: Sequence[onp.ToFloat1D],
     args: tuple[onp.ToFloat1D, ...],
-    complex_ok: Literal[False] = False,
+    complex_ok: Falsy = False,
     preserve_shape: bool | None = None,
     xp: _ModuleT | None = None,
 ) -> tuple[

scipy-stubs/_typing.pyi

@@ -20,6 +20,7 @@ __all__ = [
     "ConvMode",
     "EnterNoneMixin",
     "EnterSelfMixin",
+    "Falsy",
     "FileLike",
     "FileModeRW",
     "FileModeRWA",
@@ -28,6 +29,7 @@ __all__ = [
     "OrderCF",
     "OrderKACF",
     "ToRNG",
+    "Truthy",
     "_FortranFunction",
 ]
 
@@ -64,6 +66,10 @@ FileLike: TypeAlias = FileName | IO[_ByteSOrStr]
 FileModeRW: TypeAlias = Literal["r", "w"]
 FileModeRWA: TypeAlias = Literal[FileModeRW, "a"]
 
+# TODO(jorenham): Include `np.bool[L[False]]` once we have `numpy>=2.2`
+Falsy: TypeAlias = Literal[False, 0]
+Truthy: TypeAlias = Literal[True, 1]
+
 # keep in sync with `numpy._typing._scalars`
 AnyBool: TypeAlias = bool | np.bool_ | Literal[0, 1]
 

scipy-stubs/cluster/hierarchy.pyi

@@ -7,6 +7,7 @@ import numpy as np
 import optype.numpy as onp
 import optype.typing as opt
 from scipy._lib._disjoint_set import DisjointSet
+from scipy._typing import Falsy, Truthy
 from scipy.spatial.distance import _Metric
 
 __all__ = [
@@ -141,9 +142,9 @@ def cut_tree(
 
 #
 @overload
-def to_tree(Z: onp.ToArray2D, rd: Literal[False] = False) -> ClusterNode: ...
+def to_tree(Z: onp.ToArray2D, rd: Falsy = False) -> ClusterNode: ...
 @overload
-def to_tree(Z: onp.ToArray2D, rd: Literal[True]) -> tuple[ClusterNode, list[ClusterNode]]: ...
+def to_tree(Z: onp.ToArray2D, rd: Truthy) -> tuple[ClusterNode, list[ClusterNode]]: ...
 
 #
 def optimal_leaf_ordering(Z: onp.ToArray2D, y: onp.ToArrayND, metric: _Metric = "euclidean") -> _LinkageArray: ...

scipy-stubs/integrate/_bvp.pyi

@@ -4,9 +4,12 @@ from typing_extensions import TypeVar
 
 import numpy as np
 import optype.numpy as onp
+from scipy._typing import Falsy, Truthy
 from scipy.interpolate import PPoly
 from scipy.sparse import csc_matrix
 
+###
+
 _SCT_fc = TypeVar("_SCT_fc", bound=np.inexact[Any], default=np.float64 | np.complex128)
 
 _FunRHS: TypeAlias = Callable[[onp.Array1D, onp.Array2D[_SCT_fc]], onp.ArrayND[_SCT_fc]]
@@ -225,7 +228,7 @@ def wrap_functions(
     bc: _FunBCR[_SCT_fc],
     fun_jac: _FunRHS_jac[_SCT_fc] | None,
     bc_jac: _FunBCR_jac[_SCT_fc] | None,
-    k: Literal[False, 0],
+    k: Falsy,
     a: onp.ToFloat,
     S: onp.Array2D[np.float64] | None,
     D: onp.Array2D[np.float64] | None,
@@ -237,7 +240,7 @@ def wrap_functions(
     bc: _FunBCR_p[_SCT_fc],
     fun_jac: _FunRHS_jac_p[_SCT_fc] | None,
     bc_jac: _FunBCR_jac_p[_SCT_fc] | None,
-    k: Literal[True, 1],
+    k: Truthy,
     a: onp.ToFloat,
     S: onp.Array2D[np.float64] | None,
     D: onp.Array2D[np.float64] | None,

scipy-stubs/integrate/_ivp/base.pyi

@@ -3,6 +3,7 @@ from typing import Any, ClassVar, Final, Generic, Literal, TypeVar, overload
 
 import numpy as np
 import optype.numpy as onp
+from scipy._typing import Truthy
 
 _VT = TypeVar("_VT", bound=onp.ArrayND[np.inexact[Any]], default=onp.ArrayND[np.inexact[Any]])
 
@@ -32,7 +33,7 @@ class OdeSolver:
         y0: onp.ToFloatND,
         t_bound: onp.ToFloat,
         vectorized: bool,
-        support_complex: bool = False,
+        support_complex: onp.ToBool = False,
     ) -> None: ...
     @overload
     def __init__(
@@ -43,7 +44,7 @@ class OdeSolver:
         y0: onp.ToComplexND,
         t_bound: onp.ToFloat,
         vectorized: bool,
-        support_complex: Literal[True],
+        support_complex: Truthy,
     ) -> None: ...
     @property
     def step_size(self, /) -> float | None: ...

scipy-stubs/integrate/_ivp/ivp.pyi

@@ -5,6 +5,7 @@ from typing_extensions import TypedDict, TypeVar, Unpack
 import numpy as np
 import optype.numpy as onp
 from scipy._lib._util import _RichResult
+from scipy._typing import Falsy, Truthy
 from scipy.sparse import sparray, spmatrix
 from .base import DenseOutput, OdeSolver
 from .common import OdeSolution
@@ -78,7 +79,7 @@ def solve_ivp(
     t_eval: onp.ToFloat1D | None = None,
     dense_output: bool = False,
     events: _Events[_SCT_cf] | None = None,
-    vectorized: Literal[False, 0] = False,
+    vectorized: Falsy = False,
     args: tuple[object, ...] | None = None,
     **options: Unpack[_SolverOptions],
 ) -> OdeResult[_SCT_cf]: ...
@@ -92,7 +93,7 @@ def solve_ivp(
     dense_output: bool = False,
     events: _Events[_SCT_cf] | None = None,
     *,
-    vectorized: Literal[True, 1],
+    vectorized: Truthy,
     args: tuple[object, ...] | None = None,
     **options: Unpack[_SolverOptions],
 ) -> OdeResult[_SCT_cf]: ...

scipy-stubs/integrate/_odepack_py.pyi

@@ -3,6 +3,7 @@ from typing_extensions import TypeVar, TypeVarTuple, Unpack
 
 import numpy as np
 import optype.numpy as onp
+from scipy._typing import Falsy, Truthy
 from ._typing import ODEInfoDict
 
 __all__ = ["ODEintWarning", "odeint"]
@@ -31,7 +32,7 @@ def odeint(
     args: tuple[()] = (),
     Dfun: _ODEFunc[_YT] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
-    full_output: Literal[False, 0] = 0,
+    full_output: Falsy = 0,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -46,7 +47,7 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[False, 0] = False,
+    tfirst: Falsy = False,
 ) -> onp.Array2D[np.floating[Any]]: ...
 @overload
 def odeint(
@@ -56,7 +57,7 @@ def odeint(
     args: tuple[()] = (),
     Dfun: _ODEFunc[_YT] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
-    full_output: Literal[False, 0] = 0,
+    full_output: Falsy = 0,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -72,7 +73,7 @@ def odeint(
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
     *,
-    tfirst: Literal[True, 1],
+    tfirst: Truthy,
 ) -> onp.Array2D[np.floating[Any]]: ...
 @overload
 def odeint(
@@ -83,7 +84,7 @@ def odeint(
     Dfun: _ODEFunc[_YT] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
     *,
-    full_output: Literal[True, 1],
+    full_output: Truthy,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -98,7 +99,7 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[False, 0] = False,
+    tfirst: Falsy = False,
 ) -> tuple[onp.Array2D[np.floating[Any]], ODEInfoDict]: ...
 @overload
 def odeint(
@@ -109,7 +110,7 @@ def odeint(
     Dfun: _ODEFunc[_YT] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
     *,
-    full_output: Literal[True, 1],
+    full_output: Truthy,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -124,7 +125,7 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[True, 1],
+    tfirst: Truthy,
 ) -> tuple[onp.Array2D[np.floating[Any]], ODEInfoDict]: ...
 
 # specified args
@@ -136,7 +137,7 @@ def odeint(
     args: tuple[Unpack[_Ts]] = ...,
     Dfun: _ODEFunc[_YT, Unpack[_Ts]] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
-    full_output: Literal[False, 0] = 0,
+    full_output: Falsy = 0,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -151,7 +152,7 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[False, 0] = False,
+    tfirst: Falsy = False,
 ) -> onp.Array2D[np.floating[Any]]: ...
 @overload
 def odeint(
@@ -161,7 +162,7 @@ def odeint(
     args: tuple[Unpack[_Ts]] = ...,
     Dfun: _ODEFuncInv[_YT, Unpack[_Ts]] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
-    full_output: Literal[False, 0] = 0,
+    full_output: Falsy = 0,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -177,7 +178,7 @@ def odeint(
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
     *,
-    tfirst: Literal[True, 1],
+    tfirst: Truthy,
 ) -> onp.Array2D[np.floating[Any]]: ...
 @overload
 def odeint(
@@ -188,7 +189,7 @@ def odeint(
     Dfun: _ODEFunc[_YT, Unpack[_Ts]] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
     *,
-    full_output: Literal[True, 1],
+    full_output: Truthy,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -203,7 +204,7 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[False, 0] = False,
+    tfirst: Falsy = False,
 ) -> tuple[onp.Array2D[np.floating[Any]], ODEInfoDict]: ...
 @overload
 def odeint(
@@ -214,7 +215,7 @@ def odeint(
     Dfun: _ODEFuncInv[_YT, Unpack[_Ts]] | None = None,
     col_deriv: Literal[0, 1] | bool = 0,
     *,
-    full_output: Literal[True, 1],
+    full_output: Truthy,
     ml: int | None = None,
     mu: int | None = None,
     rtol: float | None = None,
@@ -229,5 +230,5 @@ def odeint(
     mxordn: int = 12,
     mxords: int = 5,
     printmessg: Literal[0, 1] | bool = 0,
-    tfirst: Literal[True, 1],
+    tfirst: Truthy,
 ) -> tuple[onp.Array2D[np.floating[Any]], ODEInfoDict]: ...

scipy-stubs/integrate/_quad_vec.pyi

@@ -6,6 +6,7 @@ from typing_extensions import Never, TypeVar, override
 import numpy as np
 import optype as op
 import optype.numpy as onp
+from scipy._typing import Falsy, Truthy
 
 _S = TypeVar("_S")
 _T = TypeVar("_T")
@@ -18,9 +19,6 @@ _FloatingND: TypeAlias = onp.ArrayND[np.floating[Any]] | _Floating
 
 _Fun: TypeAlias = Callable[Concatenate[float, ...], _T] | Callable[Concatenate[np.float64, ...], _T]
 
-_Falsy: TypeAlias = Literal[False, 0] | None
-_Truthy: TypeAlias = Literal[True, 1]
-
 _Norm: TypeAlias = Literal["max", "2"]
 _Quadrature: TypeAlias = Literal["gk21", "gk15", "trapezoid"]
 
@@ -89,7 +87,7 @@ def quad_vec(  # scalar function, full_output=False (default)
     workers: onp.ToJustInt | _DoesMap = 1,
     points: onp.ToFloat1D | None = None,
     quadrature: _Quadrature | None = None,
-    full_output: _Falsy = False,
+    full_output: Falsy = False,
     *,
     args: tuple[object, ...] = (),
 ) -> tuple[_Floating, float]: ...
@@ -107,7 +105,7 @@ def quad_vec(
     points: onp.ToFloat1D | None = None,
     quadrature: _Quadrature | None = None,
     *,
-    full_output: _Truthy,
+    full_output: Truthy,
     args: tuple[object, ...] = (),
 ) -> tuple[np.floating[Any], float, _Bunch[np.floating[Any]]]: ...
 @overload  # vector function, full_output=False (default)
@@ -124,7 +122,7 @@ def quad_vec(
     points: onp.ToFloat1D | None = None,
     quadrature: _Quadrature | None = None,
     *,
-    full_output: _Falsy,
+    full_output: Falsy,
     args: tuple[object, ...] = (),
 ) -> tuple[onp.Array1D[np.floating[Any]], float]: ...
 @overload  # vector function, full_output=True
@@ -141,6 +139,6 @@ def quad_vec(
     points: onp.ToFloat1D | None = None,
     quadrature: _Quadrature | None = None,
     *,
-    full_output: _Truthy,
+    full_output: Truthy,
     args: tuple[object, ...] = (),
 ) -> tuple[onp.Array1D[np.floating[Any]], float, _Bunch[np.floating[Any]]]: ...