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: type-tests and related fixes for the numpy.polynomial classes
  • Loading branch information
@jorenham
jorenham committed Jul 22, 2024
commit 5d41e112205e2939a431e20a992fdb682a9b19f7
94 changes: 40 additions & 54 deletions numpy/polynomial/_polybase.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import abc
import sys
from collections.abc import Iterator, Mapping, Sequence
from typing import (
Expand All @@ -15,18 +16,24 @@ from typing import (

import numpy as np
import numpy.typing as npt
from numpy._typing import _ArrayLikeInt_co

from ._polytypes import (
_AnyInt,
_AnyComplexSeries1D,
_AnyIntArg,
_AnyComplexScalar,
_AnyComplexSeriesND,
_AnyIntSeries1D,
_AnyObjectSeries1D,
_AnyObjectSeriesND,
_AnyRealScalar,
_AnyRealSeries1D,
_AnyScalar,
_AnySeries1D,
_AnySeriesND,
_Array1D,
_Array2,
_CoefArray1D,
_ComplexArrayND,
_SupportsLenAndGetItem,
_Tuple2,
)
Expand All @@ -43,12 +50,11 @@ __all__ = ["ABCPolyBase"]

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

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

class ABCPolyBase(Generic[_NameCo]):
class ABCPolyBase(Generic[_NameCo], metaclass=abc.ABCMeta):
__hash__: ClassVar[None] # type: ignore[assignment]
__array_ufunc__: ClassVar[None]

Expand All @@ -67,8 +73,7 @@ class ABCPolyBase(Generic[_NameCo]):
def symbol(self, /) -> LiteralString: ...

def __init__(
self,
/,
self, /,
coef: _AnySeries1D,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
Expand Down Expand Up @@ -132,35 +137,35 @@ class ABCPolyBase(Generic[_NameCo]):
def has_samecoef(self, /, other: ABCPolyBase) -> bool: ...
def has_samedomain(self, /, other: ABCPolyBase) -> bool: ...
def has_samewindow(self, /, other: ABCPolyBase) -> bool: ...
def has_sametype(self: _Self, /, other: object) -> TypeGuard[_Self]: ...
@overload
def has_sametype(self: _Self, /, other: ABCPolyBase) -> TypeGuard[_Self]: ...
@overload
def has_sametype(self, /, other: object) -> Literal[False]: ...

def copy(self: _Self, /) -> _Self: ...
def degree(self, /) -> int: ...
def cutdeg(self: _Self, /) -> _Self: ...
def trim(self: _Self, /, tol: float = ...) -> _Self: ...
def truncate(self: _Self, /, size: _AnyInt) -> _Self: ...
def trim(self: _Self, /, tol: _AnyRealScalar = ...) -> _Self: ...
def truncate(self: _Self, /, size: _AnyIntArg) -> _Self: ...

@overload
def convert(
self,
domain: None | _AnySeries1D,
kind: type[_Self],
/,
kind: type[_Self], /,
window: None | _AnySeries1D = ...,
) -> _Self: ...
@overload
def convert(
self,
/,
self, /,
domain: None | _AnySeries1D = ...,
*,
kind: type[_Self],
window: None | _AnySeries1D = ...,
) -> _Self: ...
@overload
def convert(
self: _Self,
/,
self: _Self, /,
domain: None | _AnySeries1D = ...,
kind: type[_Self] = ...,
window: None | _AnySeries1D = ...,
Expand All @@ -169,8 +174,7 @@ class ABCPolyBase(Generic[_NameCo]):
def mapparms(self, /) -> _Tuple2[Any]: ...

def integ(
self: _Self,
/,
self: _Self, /,
m: SupportsIndex = ...,
k: _AnyComplexScalar | _SupportsLenAndGetItem[_AnyComplexScalar] = ...,
lbnd: None | _AnyComplexScalar = ...,
Expand All @@ -180,37 +184,21 @@ class ABCPolyBase(Generic[_NameCo]):

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

@overload
def linspace(
self,
/,
n: _Size,
domain: None | _AnySeries1D = ...,
) -> tuple[
np.ndarray[tuple[_Size], np.dtype[np.float64]],
np.ndarray[tuple[_Size], np.dtype[np.float64 | np.complex128]],
]: ...
@overload
def linspace(
self,
/,
n: _Hundred = ...,
self, /,
n: SupportsIndex = ...,
domain: None | _AnySeries1D = ...,
) -> tuple[
np.ndarray[tuple[_Hundred], np.dtype[np.float64]],
np.ndarray[tuple[_Hundred], np.dtype[np.float64 | np.complex128]],
]: ...
) -> _Tuple2[_Array1D[np.float64 | np.complex128]]: ...

@overload
@classmethod
def fit(
cls: type[_Self],
/,
cls: type[_Self], /,
x: _AnySeries1D,
y: _AnySeries1D,
deg: _ArrayLikeInt_co,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D = ...,
rcond: float = ...,
rcond: _AnyRealScalar = ...,
full: Literal[False] = ...,
w: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
Expand All @@ -222,9 +210,9 @@ class ABCPolyBase(Generic[_NameCo]):
cls: type[_Self], /,
x: _AnySeries1D,
y: _AnySeries1D,
deg: _ArrayLikeInt_co,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D = ...,
rcond: float = ...,
rcond: _AnyRealScalar = ...,
*,
full: Literal[True],
w: None | _AnySeries1D = ...,
Expand All @@ -237,46 +225,44 @@ class ABCPolyBase(Generic[_NameCo]):
cls: type[_Self],
x: _AnySeries1D,
y: _AnySeries1D,
deg: _ArrayLikeInt_co,
deg: int | _AnyIntSeries1D,
domain: None | _AnySeries1D,
rcond: float,
full: Literal[True],
/,
rcond: _AnyRealScalar,
full: Literal[True], /,
w: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
symbol: str = ...,
) -> tuple[_Self, Sequence[np.inexact[Any] | np.int32]]: ...

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

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

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

@classmethod
def cast(
cls: type[_Self],
/,
cls: type[_Self], /,
series: ABCPolyBase,
domain: None | _AnySeries1D = ...,
window: None | _AnySeries1D = ...,
Expand Down
Loading
0