Merge pull request numpy#19559 from BvB93/pytest

ENH: Add annotations for `__path__` and `PytestTester`

Author: mattip

numpy/__init__.pyi

@@ -9,6 +9,7 @@ from abc import abstractmethod
 from types import TracebackType, MappingProxyType
 from contextlib import ContextDecorator
 
+from numpy._pytesttester import PytestTester
 from numpy.core.multiarray import flagsobj
 from numpy.core._internal import _ctypes
 from numpy.core.getlimits import MachArLike
@@ -625,6 +626,7 @@ __all__: List[str]
 __path__: List[str]
 __version__: str
 __git_version__: str
+test: PytestTester
 
 # TODO: Move placeholders to their respective module once
 # their annotations are properly implemented

numpy/_pytesttester.pyi

@@ -0,0 +1,18 @@
+from typing import List, Iterable
+from typing_extensions import Literal as L
+
+__all__: List[str]
+
+class PytestTester:
+    module_name: str
+    def __init__(self, module_name: str) -> None: ...
+    def __call__(
+        self,
+        label: L["fast", "full"] = ...,
+        verbose: int = ...,
+        extra_argv: None | Iterable[str] = ...,
+        doctests: L[False] = ...,
+        coverage: bool = ...,
+        durations: int = ...,
+        tests: None | Iterable[str] = ...,
+    ) -> bool: ...

numpy/f2py/__init__.pyi

@@ -3,6 +3,8 @@ import subprocess
 from typing import Any, List, Iterable, Dict, overload
 from typing_extensions import TypedDict, Literal as L
 
+from numpy._pytesttester import PytestTester
+
 class _F2PyDictBase(TypedDict):
     csrc: List[str]
     h: List[str]
@@ -13,6 +15,7 @@ class _F2PyDict(_F2PyDictBase, total=False):
 
 __all__: List[str]
 __path__: List[str]
+test: PytestTester
 
 def run_main(comline_list: Iterable[str]) -> Dict[str, _F2PyDict]: ...
 

numpy/fft/__init__.pyi

@@ -1,6 +1,10 @@
 from typing import Any, List
 
+from numpy._pytesttester import PytestTester
+
 __all__: List[str]
+__path__: List[str]
+test: PytestTester
 
 def fft(a, n=..., axis=..., norm=...): ...
 def ifft(a, n=..., axis=..., norm=...): ...

numpy/lib/__init__.pyi

@@ -1,6 +1,8 @@
 import math as math
 from typing import Any, List
 
+from numpy._pytesttester import PytestTester
+
 from numpy import (
     ndenumerate as ndenumerate,
     ndindex as ndindex,
@@ -237,6 +239,8 @@ from numpy.core.multiarray import (
 )
 
 __all__: List[str]
+__path__: List[str]
+test: PytestTester
 
 __version__ = version
 emath = scimath

numpy/linalg/__init__.pyi

@@ -1,6 +1,10 @@
 from typing import Any, List
 
+from numpy._pytesttester import PytestTester
+
 __all__: List[str]
+__path__: List[str]
+test: PytestTester
 
 class LinAlgError(Exception): ...
 

numpy/ma/__init__.pyi

@@ -1,5 +1,7 @@
 from typing import Any, List
 
+from numpy._pytesttester import PytestTester
+
 from numpy.ma import extras as extras
 
 from numpy.ma.core import (
@@ -230,3 +232,5 @@ from numpy.ma.extras import (
 )
 
 __all__: List[str]
+__path__: List[str]
+test: PytestTester

numpy/matrixlib/__init__.pyi

@@ -1,10 +1,14 @@
 from typing import Any, List
 
+from numpy._pytesttester import PytestTester
+
 from numpy import (
     matrix as matrix,
 )
 
 __all__: List[str]
+__path__: List[str]
+test: PytestTester
 
 def bmat(obj, ldict=..., gdict=...): ...
 def asmatrix(data, dtype=...): ...

numpy/polynomial/__init__.pyi

@@ -1,5 +1,7 @@
 from typing import List
 
+from numpy._pytesttester import PytestTester
+
 from numpy.polynomial import (
     chebyshev as chebyshev,
     hermite as hermite,
@@ -16,5 +18,7 @@ from numpy.polynomial.legendre import Legendre as Legendre
 from numpy.polynomial.polynomial import Polynomial as Polynomial
 
 __all__: List[str]
+__path__: List[str]
+test: PytestTester
 
 def set_default_printstyle(style): ...

numpy/random/__init__.pyi

@@ -1,5 +1,7 @@
 from typing import List
 
+from numpy._pytesttester import PytestTester
+
 from numpy.random._generator import Generator as Generator
 from numpy.random._generator import default_rng as default_rng
 from numpy.random._mt19937 import MT19937 as MT19937
@@ -66,3 +68,5 @@ from numpy.random.mtrand import (
 )
 
 __all__: List[str]
+__path__: List[str]
+test: PytestTester