DEP: Deprecate ma.round_ and add warning test #28899

dineshcsdev · 2025-05-04T17:06:06Z

Deprecate ma.round_ and add warning test

mattip

You can run locally to fix the failing tests.

mattip · 2025-05-04T17:22:05Z

numpy/tests/test_round_warning.py

+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        ma.round_([1.234, 2.345])
+        assert any("deprecated" in str(warning.message) for warning in w), "No deprecation warning!"


Rather than adding here, add to numpy/_core/tests/test_deprecations.py

There may also be less boilierplate via i.e, with pytest.deprecated_call(match='deprecated'):

This should be deleted

…sing pytest.deprecated_call

dineshcsdev · 2025-05-05T09:06:08Z

I’ve removed the separate test_round_warning.py file and moved the test into numpy/core/tests/test_deprecations.py as suggested.
The test now uses pytest.deprecated_call(match="deprecated") to reduce boilerplate.

ngoldbaum · 2025-05-05T15:10:34Z

Please try to build numpy and run the tests locally before pushing to run CI. Using spin helps with this.

This also needs a release note.

dineshcsdev · 2025-05-05T15:28:14Z

Thanks for the feedback! 🙌
I’ll work on building NumPy locally and run the tests using spin before pushing again.
Also, I’ll add the missing release note in the correct format as per the NumPy release note guidelines.

Will update the PR shortly.

mattip

Please run the tests locally before pushing a git change.

mattip · 2025-05-06T09:09:36Z

doc/release/upcoming_changes/28899-deprecation.ma.rst

+Deprecate `ma.round_` function
+------------------------------


RST needs two quotes.

Suggested change

Deprecate `ma.round_` function

------------------------------

Deprecate ``ma.round_``

-----------------------

mattip · 2025-05-06T09:10:50Z

numpy/tests/test_round_warning.py

+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        ma.round_([1.234, 2.345])
+        assert any("deprecated" in str(warning.message) for warning in w), "No deprecation warning!"


This should be deleted

mattip · 2025-05-06T09:12:49Z

numpy/_core/tests/test_deprecations.py

@@ -7,6 +7,9 @@
 import pytest
 import tempfile
 import re
+import numpy.ma as ma
+
+


Linting complains about too many blank lines here

The extra line is causing linting failures. Please fix.

mattip · 2025-05-06T09:17:09Z

numpy/ma/core.py

@@ -8176,8 +8176,13 @@ def round_(a, decimals=0, out=None):
        return out


-round = round_


On line 8123 above you need to change the function name from round_ to round

You also need to examine and change the documentation to use round instead of round_. See the Examples section starting on line 8146.

dineshcsdev · 2025-05-06T14:59:55Z

I've addressed all the feedback:

Fixed the RST format in the release note with proper double backticks
Fixed the function implementation in core.py to properly deprecate round_ and redirect to round
Fixed the spacing issue in test_deprecations.py
Built and tested locally with spin

Thank you for your guidance!

jorenham

It would help to also announce the deprecation in the typing stubs:

numpy/numpy/ma/core.pyi

Lines 1294 to 1295 in de784cd

    
           def round_(a, decimals=..., out=...): ... 
        
           round = round_

You can use the @deprecated decorator from typing_extensions for this (docs).
Be careful to only deprecate round_, and not also round

dineshcsdev · 2025-05-07T11:58:42Z

@jorenham your issue changed to another pr due to some technical issue I'm sorry about that you can view here Dinesh-0813:fix-deprecate-ma-round #28917 sorry for the trouble

mattip

You should check the reasons CI is failing, and fix them. I pointed out a few, there may be more.

mattip · 2025-05-09T06:27:52Z

numpy/_core/tests/test_deprecations.py

@@ -7,6 +7,9 @@
 import pytest
 import tempfile
 import re
+import numpy.ma as ma
+
+


The extra line is causing linting failures. Please fix.

mattip · 2025-05-09T06:29:30Z

numpy/ma/core.py

@@ -8176,8 +8176,13 @@ def round_(a, decimals=0, out=None):
        return out


-round = round_


You also need to examine and change the documentation to use round instead of round_. See the Examples section starting on line 8146.

dineshcsdev · 2025-05-09T07:45:37Z

This PR renames the internal function round_ to round in numpy.ma.core, aligning it with NumPy's naming conventions and improving clarity. Associated docstrings and usages have been updated accordingly.

mattip · 2025-05-09T08:25:50Z

Tests are still failing. Also please add the necessary changes to typing.

Deprecate ma.round_ and add warning test

8373561

jorenham added 07 - Deprecation component: numpy.ma masked arrays labels May 4, 2025

jorenham changed the title ~~Deprecate ma.round_ and add warning test~~ DEP: Deprecate ma.round_ and add warning test May 4, 2025

mattip reviewed May 4, 2025

View reviewed changes

Moved ma.round_ deprecation test to core/tests/test_deprecations.py u…

dd86b4a

…sing pytest.deprecated_call

ngoldbaum added the 56 - Needs Release Note. Needs an entry in doc/release/upcoming_changes label May 5, 2025

Add release note and address review feedback

384443a

mattip reviewed May 6, 2025

View reviewed changes

Add release note and address review feedback

33846bf

dineshcsdev requested review from mattip and tylerjereddy May 7, 2025 06:51

dineshcsdev mentioned this pull request May 7, 2025

DEP: np.round_ has been removed, but ma.round_ still remains #28830

Open

jorenham reviewed May 7, 2025

View reviewed changes

Deprecate ma.round_ in typing stub

5c1b465

jorenham mentioned this pull request May 7, 2025

TYP: deprecate ma.round_ #28917

Open

mattip reviewed May 9, 2025

View reviewed changes

Fix linting issue and update docstring to use ma.round

20a0b21

melissawm added this to NumPy first-time contributor PRs May 22, 2025

melissawm moved this to Pending authors' response in NumPy first-time contributor PRs May 22, 2025

		Deprecate `ma.round_` function
		------------------------------

		@@ -8176,8 +8176,13 @@ def round_(a, decimals=0, out=None):
		return out


		round = round_

Uh oh!

DEP: Deprecate ma.round_ and add warning test #28899

Are you sure you want to change the base?

DEP: Deprecate ma.round_ and add warning test #28899

Uh oh!

Conversation

dineshcsdev commented May 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dineshcsdev commented May 5, 2025

Uh oh!

ngoldbaum commented May 5, 2025

Uh oh!

dineshcsdev commented May 5, 2025

Uh oh!

mattip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dineshcsdev commented May 6, 2025

Uh oh!

jorenham left a comment

Choose a reason for hiding this comment

Uh oh!

dineshcsdev commented May 7, 2025

Uh oh!

mattip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dineshcsdev commented May 9, 2025

Uh oh!

mattip commented May 9, 2025

Uh oh!

Uh oh!

dineshcsdev commented May 4, 2025 •

edited

Loading