Skip to content

DEP: Finalize MachAr and machar deprecations #22638

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
charris merged 1 commit into from
Nov 22, 2022
+12 −32
Merged

DEP: Finalize MachAr and machar deprecations #22638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions doc/release/upcoming_changes/22638.deprecation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* ``np.core.MachAr`` is deprecated. It is private API. In names
defined in ``np.core`` should generally be considered private.
1 change: 1 addition & 0 deletions doc/release/upcoming_changes/22638.expired.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* ``np.core.machar`` and ``np.finfo.machar`` have been removed.
9 changes: 4 additions & 5 deletions numpy/core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@
from . import function_base
from .function_base import *
from . import _machar
from ._machar import *
from . import getlimits
from .getlimits import *
from . import shape_base
Expand Down Expand Up @@ -153,13 +152,13 @@ def _DType_reduce(DType):


def __getattr__(name):
# Deprecated 2021-10-20, NumPy 1.22
if name == "machar":
# Deprecated 2022-11-22, NumPy 1.25.
if name == "MachAr":
warnings.warn(
"The `np.core.machar` module is deprecated (NumPy 1.22)",
"The `np.core.MachAr` is considered private API (NumPy 1.24)",
DeprecationWarning, stacklevel=2,
)
return _machar
return _machar.MachAr
raise AttributeError(f"Module {__name__!r} has no attribute {name!r}")


Expand Down
1 change: 0 additions & 1 deletion numpy/core/_machar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
# Need to speed this up...especially for longfloat

# Deprecated 2021-10-20, NumPy 1.22
@set_module('numpy')
class MachAr:
"""
Diagnosing machine parameters.
Expand Down
23 changes: 3 additions & 20 deletions numpy/core/getlimits.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,9 @@ def _get_machar(ftype):

def _discovered_machar(ftype):
""" Create MachAr instance with found information on float types

TODO: MachAr should be retired completely ideally. We currently only
ever use it system with broken longdouble (valgrind, WSL).
"""
params = _MACHAR_PARAMS[ftype]
return MachAr(lambda v: array([v], ftype),
Expand Down Expand Up @@ -387,11 +390,6 @@ class finfo:
iexp : int
The number of bits in the exponent portion of the floating point
representation.
machar : MachAr
The object which calculated these parameters and holds more
detailed information.

.. deprecated:: 1.22
machep : int
The exponent that yields `eps`.
max : floating point number of the appropriate type
Expand Down Expand Up @@ -432,7 +430,6 @@ class finfo:

See Also
--------
MachAr : The implementation of the tests that produce this information.
iinfo : The equivalent for integer data types.
spacing : The distance between a value and the nearest adjacent number
nextafter : The next floating point value after x1 towards x2
Expand Down Expand Up @@ -595,20 +592,6 @@ def tiny(self):
"""
return self.smallest_normal

@property
def machar(self):
"""The object which calculated these parameters and holds more
detailed information.

.. deprecated:: 1.22
"""
# Deprecated 2021-10-27, NumPy 1.22
warnings.warn(
"`finfo.machar` is deprecated (NumPy 1.22)",
DeprecationWarning, stacklevel=2,
)
return self._machar


@set_module('numpy')
class iinfo:
Expand Down
8 changes: 2 additions & 6 deletions numpy/core/tests/test_deprecations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,15 +1024,11 @@ def test_not_deprecated(self, func):


class TestMachAr(_DeprecationTestCase):
# Deprecated 2021-10-19, NumPy 1.22
# Deprecated 2022-11-22, NumPy 1.25
warning_cls = DeprecationWarning

def test_deprecated_module(self):
self.assert_deprecated(lambda: getattr(np.core, "machar"))

def test_deprecated_attr(self):
finfo = np.finfo(float)
self.assert_deprecated(lambda: getattr(finfo, "machar"))
self.assert_deprecated(lambda: getattr(np.core, "MachAr"))


class TestQuantileInterpolationDeprecation(_DeprecationTestCase):
Expand Down