8000 TYP: type hint ``numpy.polynomial`` by jorenham · Pull Request #26897 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

TYP: type hint numpy.polynomial #26897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jul 23, 2024
Merged

TYP: type hint numpy.polynomial #26897

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e1e9df2
TYP: type hint `numpy.polynomial`
jorenham Jul 10, 2024
b3df5ae
TYP: annotate `ABCPolyBase.basis_name` in `numpy.polynomial._polybase…
jorenham Jul 10, 2024
d0ad0e5
TYP: allow more scalar types in the `polynomial._polytypes._Interval`…
jorenham Jul 10, 2024
252cf3f
TYP: rename "reveal" type-tests `polyutils.pyi` to `polynomial_polyut…
jorenham Jul 10, 2024
8e105bf
TYP: consistent type alias naming and overload signatures in `numpy.p…
jorenham Jul 10, 2024
a7a72e1
TYP: extract common array annotations expressions into type aliases
jorenham Jul 10, 2024
388b0b3
TYP: initial type-tests for the polynomial classes in `numpy.polynomial`
jorenham Jul 10, 2024
5d41e11
TYP: type-tests and related fixes for the `numpy.polynomial` classes
jorenham Jul 12, 2024
19b3265
TYP: A better story around the internal type aliases of ``numpy.poly…
jorenham Jul 16, 2024
2d2482d
TYP: Simple true-negative type-tests for the low-level ``numpy.polyno…
jorenham Jul 16, 2024
6de9cb2
TYP: Add type-tests for ``numpy.polynomial`` convenience class ops
jorenham Jul 16, 2024
c59ef5b
TYP: Fix several minor typing inconsistencies in ``numpy.polynomial``
jorenham Jul 16, 2024
3c9fe75
TYP: Add type tests for ``numpy.polynomial`` shared series methods
jorenham Jul 16, 2024
56a9226
TYP: Fix the type-tests, and remove ``numpy.polynomial`` "fail" tests…
jorenham Jul 16, 2024
ef3278a
TYP: Add type tests for the ``numpy.polynomial`` series-specific met…
jorenham Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
TYP: A better story around the internal type aliases of ``numpy.polyn… 
…omial``
  • Loading branch information
@jorenham
jorenham committed Jul 22, 2024
commit 19b3265a62d7bc533c52a47c353548955cbdba2f
172 changes: 90 additions & 82 deletions numpy/polynomial/_polybase.pyi
View file
Open in desktop
55CE
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ from typing import (
TYPE_CHECKING,
Any,
ClassVar,
Final,
Generic,
Literal,
SupportsIndex,
Expand All @@ -16,26 +17,29 @@ from typing import (

import numpy as np
import numpy.typing as npt
from numpy._typing import (
_FloatLike_co,
_NumberLike_co,

_ArrayLikeFloat_co,
_ArrayLikeComplex_co,
_ArrayLikeObject_co,
)

from ._polytypes import (
_AnyComplexSeries1D,
_AnyIntArg,
_AnyComplexScalar,
_AnyComplexSeriesND,
_AnyIntSeries1D,
_AnyObjectSeries1D,
_AnyObjectSeriesND,
_AnyRealScalar,
_AnyRealSeries1D,
_AnyScalar,
_AnySeries1D,
_AnySeriesND,
_Array1D,
_AnyInt,
_CoefLike_co,

_Array2,
_CoefArray1D,
_ComplexArrayND,
_SupportsLenAndGetItem,
_Tuple2,

_Series,
_CoefSeries,

_SeriesLikeInt_co,
_SeriesLikeCoef_co,

_ArrayLikeCoef_co,
)

if sys.version_info >= (3, 11):
Expand All @@ -45,15 +49,17 @@ elif TYPE_CHECKING:
else:
LiteralString: TypeAlias = str

__all__ = ["ABCPolyBase"]

__all__: Final[Sequence[str]] = ("ABCPolyBase",)


_NameCo = TypeVar("_NameCo", bound=None | LiteralString, covariant=True)
_Self = TypeVar("_Self", bound="ABCPolyBase")

_AnyOther: TypeAlias = ABCPolyBase | _AnyScalar | _AnySeries1D
_AnyOther: TypeAlias = ABCPolyBase | _CoefLike_co | _SeriesLikeCoef_co
_Hundred: TypeAlias = Literal[100]


class ABCPolyBase(Generic[_NameCo], metaclass=abc.ABCMeta):
__hash__: ClassVar[None] # type: ignore[assignment]
__array_ufunc__: ClassVar[None]
Expand All @@ -64,7 +70,7 @@ class ABCPolyBase(Generic[_NameCo], metaclass=abc.ABCMeta):
_use_unicode: ClassVar[bool]

basis_name: _NameCo
coef: _CoefArray1D
coef: _CoefSeries
domain: _Array2[np.inexact[Any] | np.object_]
window: _Array2[np.inexact[Any] | np.object_]

Expand All @@ -73,38 +79,40 @@ class ABCPolyBase(Generic[_NameCo], metaclass=abc.ABCMeta):
def symbol(self, /) -> LiteralString: ...

def __init__(
self, /,
coef: _AnySeries1D,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
self,
/,
coef: _SeriesLikeCoef_co,
domain: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> None: ...

@overload
def __call__( # type: ignore[overload-overlap]
self, /,
arg: complex | np.complexfloating[Any, Any]
) -> np.complex128: ...
@overload
def __call__(
self, /,
arg: _AnyComplexScalar,
self,
/,
arg: _FloatLike_co,
) -> np.float64 | np.complex128: ...
@overload
def __call__(self, /, arg: _NumberLike_co) -> np.complex128: ...
@overload
def __call__(
self, /,
arg: _AnyObjectSeriesND,
) -> npt.NDArray[np.object_]: ...
self,
/,
arg: _ArrayLikeFloat_co,
) -> npt.NDArray[np.float64 | np.complex128 | np.object_]: ...
@overload
def __call__(
self, /,
arg: _AnyComplexSeriesND,
self,
/,
arg: _ArrayLikeComplex_co,
) -> npt.NDArray[np.complex128 | np.object_]: ...
@overload
def __call__(
self, /,
arg: _AnySeries1D,
) -> npt.NDArray[np.float64 | np.complex128 | np.object_]: ...
self,
/,
arg: _ArrayLikeObject_co,
) -> npt.NDArray[np.object_]: ...

def __str__(self, /) -> str: ...
def __repr__(self, /) -> str: ...
Expand Down Expand Up @@ -145,127 +153,127 @@ class ABCPolyBase(Generic[_NameCo], metaclass=abc.ABCMeta):
def copy(self: _Self, /) -> _Self: ...
def degree(self, /) -> int: ...
def cutdeg(self: _Self, /) -> _Self: ...
def trim(self: _Self, /, tol: _AnyRealScalar = ...) -> _Self: ...
def truncate(self: _Self, /, size: _AnyIntArg) -> _Self: ...
def trim(self: _Self, /, tol: _FloatLike_co = ...) -> _Self: ...
def truncate(self: _Self, /, size: _AnyInt) -> _Self: ...

@overload
def convert(
self,
domain: None | _AnySeries1D,
domain: None | _SeriesLikeCoef_co,
kind: type[_Self], /,
window: None | _AnySeries1D = ...,
window: None | _SeriesLikeCoef_co = ...,
) -> _Self: ...
@overload
def convert(
self, /,
domain: None | _AnySeries1D = ...,
domain: None | _SeriesLikeCoef_co = ...,
*,
kind: type[_Self],
window: None | _AnySeries1D = ...,
window: None | _SeriesLikeCoef_co = ...,
) -> _Self: ...
@overload
def convert(
self: _Self, /,
domain: None | _AnySeries1D = ...,
domain: None | _SeriesLikeCoef_co = ...,
kind: type[_Self] = ...,
window: None | _AnySeries1D = ...,
window: None | _SeriesLikeCoef_co = ...,
) -> _Self: ...

def mapparms(self, /) -> _Tuple2[Any]: ...

def integ(
self: _Self, /,
m: SupportsIndex = ...,
k: _AnyComplexScalar | _SupportsLenAndGetItem[_AnyComplexScalar] = ...,
lbnd: None | _AnyComplexScalar = ...,
k: _CoefLike_co | _SeriesLikeCoef_co = ...,
lbnd: None | _CoefLike_co = ...,
) -> _Self: ...

def deriv(self: _Self, /, m: SupportsIndex = ...) -> _Self: ...

def roots(self, /) -> _CoefArray1D: ...
def roots(self, /) -> _CoefSeries: ...

def linspace(
self, /,
n: SupportsIndex = ...,
domain: None | _AnySeries1D = ...,
) -> _Tuple2[_Array1D[np.float64 | np.complex128]]: ...
domain: None | _SeriesLikeCoef_co = ...,
) -> _Tuple2[_Series[np.float64 | np.complex128]]: ...

@overload
@classmethod
def fit(
cls: type[_Self], /,
x: _AnySeries1D,
y: _AnySeries1D,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D = ...,
rcond: _AnyRealScalar = ...,
x: _SeriesLikeCoef_co,
y: _SeriesLikeCoef_co,
deg: int | _SeriesLikeInt_co,
domain: None | _SeriesLikeCoef_co = ...,
rcond: _FloatLike_co = ...,
full: Literal[False] = ...,
w: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
w: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> _Self: ...
@overload
@classmethod
def fit(
cls: type[_Self], /,
x: _AnySeries1D,
y: _AnySeries1D,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D = ...,
rcond: _AnyRealScalar = ...,
x: _SeriesLikeCoef_co,
y: _SeriesLikeCoef_co,
deg: int | _SeriesLikeInt_co,
domain: None | _SeriesLikeCoef_co = ...,
rcond: _FloatLike_co = ...,
*,
full: Literal[True],
w: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
w: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> tuple[_Self, Sequence[np.inexact[Any] | np.int32]]: ...
@overload
@classmethod
def fit(
cls: type[_Self],
x: _AnySeries1D,
y: _AnySeries1D,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D,
rcond: _AnyRealScalar,
x: _SeriesLikeCoef_co,
y: _SeriesLikeCoef_co,
deg: int | _SeriesLikeInt_co,
domain: None | _SeriesLikeCoef_co,
rcond: _FloatLike_co,
full: Literal[True], /,
w: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
w: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> tuple[_Self, Sequence[np.inexact[Any] | np.int32]]: ...

@classmethod
def fromroots(
cls: type[_Self], /,
roots: _AnySeriesND,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
roots: _ArrayLikeCoef_co,
domain: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> _Self: ...

@classmethod
def identity(
cls: type[_Self], /,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
domain: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> _Self: ...

@classmethod
def basis(
cls: type[_Self], /,
deg: _AnyIntArg,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
deg: _AnyInt,
domain: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
symbol: str = ...,
) -> _Self: ...

@classmethod
def cast(
cls: type[_Self], /,
series: ABCPolyBase,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
domain: None | _SeriesLikeCoef_co = ...,
window: None | _SeriesLikeCoef_co = ...,
) -> _Self: ...

@classmethod
Expand Down
Loading
0