Skip to content

🏷️ stub numpy.fft.helper (deprecated) #261

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
jorenham merged 2 commits into from
Mar 6, 2025
Merged

🏷️ stub numpy.fft.helper (deprecated) #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4da5adf
✨ slightly improved `numpy.fft.[i]fftshift` signatures
jorenham Mar 6, 2025
a139c0d
🏷️ stub `numpy.fft.helper` (deprecated)
jorenham Mar 6, 2025
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
36 changes: 25 additions & 11 deletions src/numpy-stubs/fft/_helper.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,47 @@
from typing import Any, Literal as L, overload
from typing import Any, Final, Literal as L, TypeAlias, overload
from typing_extensions import TypeVar

import numpy as np
from numpy._typing import ArrayLike, NDArray, _ArrayLike, _ArrayLikeComplex_co, _ArrayLikeFloat_co, _ShapeLike

__all__ = ["fftfreq", "fftshift", "ifftshift", "rfftfreq"]

_SCT = TypeVar("_SCT", bound=np.generic)
###

_ScalarT = TypeVar("_ScalarT", bound=np.generic)

_Device: TypeAlias = L["cpu"] | None
_IntLike: TypeAlias = int | np.integer

###

integer_types: Final[tuple[type[int], type[np.integer]]] = ...

###

#
@overload
def fftshift(x: _ArrayLike[_SCT], axes: _ShapeLike | None = ...) -> NDArray[_SCT]: ...
def fftshift(x: _ArrayLike[_ScalarT], axes: _ShapeLike | None = None) -> NDArray[_ScalarT]: ...
@overload
def fftshift(x: ArrayLike, axes: _ShapeLike | None = ...) -> NDArray[Any]: ...
def fftshift(x: _ArrayLikeFloat_co, axes: _ShapeLike | None = None) -> NDArray[np.floating]: ...
@overload
def fftshift(x: ArrayLike, axes: _ShapeLike | None = None) -> NDArray[Any]: ...

#
@overload
def ifftshift(x: _ArrayLike[_SCT], axes: _ShapeLike | None = ...) -> NDArray[_SCT]: ...
def ifftshift(x: _ArrayLike[_ScalarT], axes: _ShapeLike | None = None) -> NDArray[_ScalarT]: ...
@overload
def ifftshift(x: _ArrayLikeFloat_co, axes: _ShapeLike | None = None) -> NDArray[np.floating]: ...
@overload
def ifftshift(x: ArrayLike, axes: _ShapeLike | None = ...) -> NDArray[Any]: ...
def ifftshift(x: ArrayLike, axes: _ShapeLike | None = None) -> NDArray[Any]: ...

#
@overload
def fftfreq(n: int | np.integer, d: _ArrayLikeFloat_co = ..., device: L["cpu"] | None = ...) -> NDArray[np.floating]: ...
def fftfreq(n: _IntLike, d: _ArrayLikeFloat_co = 1.0, device: _Device = None) -> NDArray[np.floating]: ...
@overload
def fftfreq(n: int | np.integer, d: _ArrayLikeComplex_co = ..., device: L["cpu"] | None = ...) -> NDArray[np.inexact]: ...
def fftfreq(n: _IntLike, d: _ArrayLikeComplex_co = 1.0, device: _Device = None) -> NDArray[np.inexact]: ...

#
@overload
def rfftfreq(n: int | np.integer, d: _ArrayLikeFloat_co = ..., device: L["cpu"] | None = ...) -> NDArray[np.floating]: ...
def rfftfreq(n: _IntLike, d: _ArrayLikeFloat_co = 1.0, device: _Device = None) -> NDArray[np.floating]: ...
@overload
def rfftfreq(n: int | np.integer, d: _ArrayLikeComplex_co = ..., device: L["cpu"] | None = ...) -> NDArray[np.inexact]: ...
def rfftfreq(n: _IntLike, d: _ArrayLikeComplex_co = 1.0, device: _Device = None) -> NDArray[np.inexact]: ...
19 changes: 19 additions & 0 deletions src/numpy-stubs/fft/helper.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from typing import Any
from typing_extensions import deprecated

from numpy._typing import ArrayLike, NDArray, _ShapeLike

from ._helper import _Device, _IntLike, integer_types as integer_types

__all__ = ["fftfreq", "fftshift", "ifftshift", "rfftfreq"]

###

@deprecated("Please use `numpy.fft.fftshift` instead.")
def fftshift(x: ArrayLike, axes: _ShapeLike | None = None) -> NDArray[Any]: ...
@deprecated("Please use `numpy.fft.ifftshift` instead.")
def ifftshift(x: ArrayLike, axes: _ShapeLike | None = None) -> NDArray[Any]: ...
@deprecated("Please use `numpy.fft.fftfreq` instead.")
def fftfreq(n: _IntLike, d: ArrayLike = 1.0, device: _Device = None) -> NDArray[Any]: ...
@deprecated("Please use `numpy.fft.rfftfreq` instead.")
def rfftfreq(n: _IntLike, d: ArrayLike = 1.0, device: _Device = None) -> NDArray[Any]: ...
5 changes: 2 additions & 3 deletions test/static/accept/fft.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
from typing import Any
from typing_extensions import assert_type

import numpy as np
Expand All @@ -9,10 +8,10 @@ AR_c16: npt.NDArray[np.complex128]
AR_LIKE_f8: list[float]

assert_type(np.fft.fftshift(AR_f8), npt.NDArray[np.float64])
assert_type(np.fft.fftshift(AR_LIKE_f8, axes=0), npt.NDArray[Any])
assert_type(np.fft.fftshift(AR_LIKE_f8, axes=0), npt.NDArray[np.floating])

assert_type(np.fft.ifftshift(AR_f8), npt.NDArray[np.float64])
assert_type(np.fft.ifftshift(AR_LIKE_f8, axes=0), npt.NDArray[Any])
assert_type(np.fft.ifftshift(AR_LIKE_f8, axes=0), npt.NDArray[np.floating])

assert_type(np.fft.fftfreq(5, AR_f8), npt.NDArray[np.floating])
assert_type(np.fft.fftfreq(np.int64(), AR_c16), npt.NDArray[np.inexact])
Expand Down
8 changes: 4 additions & 4 deletions tool/.mypyignore-todo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ numpy(\..+)?\.floating.as_integer_ratio
numpy(\..+)?\.complexfloating.__hash__
numpy(\..+)?\.complexfloating.__complex__

numpy.compat
numpy.compat.py3k

numpy._pyinstaller.hook-numpy

numpy.ctypeslib._ctypeslib
numpy.fft.helper

numpy.compat
numpy.compat.py3k

numpy.distutils

Expand Down