DEP: deprecate undocumented, unused dtype type dicts #11382

mattip · 2018-06-19T22:03:20Z

Fixes #11341 by removing sctypeNA and typeNA, left over from long ago.
~~Will cause a merge conflict with PR #11340~~

Edit:: strike out merge conflict, that PR was merged already

eric-wieser · 2018-06-19T22:25:49Z

Think API: might be more appropriate - this isn't just a deprecation

mattip · 2018-06-19T22:31:00Z

It should get a release note

eric-wieser · 2018-06-21T06:50:32Z

This probably needs to hit the mailing list.

mattip · 2018-06-24T23:37:40Z

The only response on the mailing list was from @seberg asking if it should go through a deprecation cycle. How would we do that? If we want to deprecate accessing the dictionaries, we would have to somehow wrap the __getattr__ of ... ? They live in numpy.core.numerictypes, are exported to numpy.core in its __init__.py via __all__ += numeric.__all__. Or we could wrap the getitem in the dictionary itself to emit a warning on access.

eric-wieser · 2018-06-24T23:58:59Z

Python 3.7 adds module.__getattr__, so we do have a path to eventual deprecation.

The easy solution here seems to be just to deprecate item access.

mattip · 2018-06-25T01:02:58Z

I added deprecation warnings to the __getitem__ and get methods, which should cover 90% of the use cases, I guess we could do __missing__, pop, and a few others as well but it seems like overkill.

eric-wieser · 2018-06-25T02:37:32Z

numpy/core/numerictypes.py

+                      'of numpy', DeprecationWarning, stacklevel=2)
+        return dict.__getitem__(self, key)
+    def get(self, key, default=None):
+        # 2018-June-24, 1.16


Elsewhere we use 2018-06-24, which is ISO-8601

eric-wieser · 2018-06-25T02:38:19Z

numpy/core/tests/test_regression.py

-    def test_typeNA(self):
-        # Ticket #31
-        assert_equal(np.typeNA[np.int64], 'Int64')
-        assert_equal(np.typeNA[np.uint64], 'UInt64')


Better to mask the deprecations and keep the test here.

mattip · 2018-07-03T05:59:47Z

ping

eric-wieser · 2018-07-03T06:17:38Z

numpy/core/numerictypes.py

+class TypeNADict(dict):
+    def __getitem__(self, key):
+        # 2018-06-24, 1.16
+        warnings.warn('sctypeNA and typeNA will be removed in v1.17 '


Do we want to commit to this fast a deprecation cycle? If so, this needs a VisibleDeprecationWarning probably. Might be worth getting more feedback on that.

will add the visible warning and delay to 1.18

eric-wieser · 2018-07-03T06:17:42Z

numpy/core/tests/test_deprecations.py

@@ -504,3 +504,12 @@ class TestGeneratorSum(_DeprecationTestCase):
    # 2018-02-25, 1.15.0
    def test_generator_sum(self):
        self.assert_deprecated(np.sum, args=((i for i in range(5)),))
+
+class TestSctypeNA(_DeprecationTestCase):
+    # 2018-June-24, 1.16


nit: iso 8601 again

charris · 2018-07-03T23:55:48Z

A deprecation is the way to go. I think the NA stands for numarray and it is just possible that some folks, I'm thinking STScI, could possibly have missed some things when updating before we removed the numarray compatibility module.

mattip · 2018-07-04T00:01:07Z

@charris

A deprecation is the way to go

Without any DeprecationWarning, just remove it?

charris · 2018-07-04T00:37:16Z

A deprecation is a DeprecationWarning. Removal is removal :)

eric-wieser · 2018-07-05T06:37:12Z

@mattip: I don't think @charris was asking you to change from VisibleDeprecationWArning to DeprecationWarning there

charris · 2018-07-05T13:32:16Z

I'm good with either, I just wanted to add my vote for some sort of deprecation.

mattip · 2018-07-06T05:21:42Z

leave as VisualDeprecationWarning, rebased off master, and squashed

eric-wieser · 2018-07-06T06:33:51Z

doc/release/1.16.0-notes.rst

@@ -14,6 +14,12 @@ New functions
 Deprecations
 ============

+`typeNA` and `stypeNA` have been deprecated


typo: sctypeNA

eric-wieser · 2018-07-06T06:35:02Z

numpy/core/tests/test_deprecations.py

+        def show(_dict, key):
+            return _dict[key]
+        self.assert_deprecated(show, args=(np.core.sctypeNA, '?',))
+        self.assert_deprecated(show, args=(np.core.typeNA, '?',))


Not sure this is better than just self.assert_deprecated(lambda: np.sctypeNA['?'])

eric-wieser · 2018-07-06T06:38:39Z

numpy/core/tests/test_regression.py

@@ -47,8 +47,10 @@ def test_pickle_transposed(self):

    def test_typeNA(self):
        # Ticket #31


Change this to gh-515 while you're here, maybe

mattip · 2018-07-14T03:18:25Z

ping. This seems non-cotroversial.

rgommers · 2018-07-14T04:06:29Z

doc/release/1.16.0-notes.rst

+-------------------------------------------
+
+The type dictionaries `numpy.core.typeNA` and `numpy.core.sctypeNA` were buggy
+and not documented. They will be removed in the next release. Use 


2 releases, not the next release

the actual deprecation message is correct (1.18) so just needs correcting here

mattip · 2018-07-14T04:13:38Z

squashed to a single commit

rgommers · 2018-07-14T04:52:00Z

LGTM now and CI still happy (except Appveyor didn't start yet). Merged. Thanks @mattip

mattip added component: numpy.oldnumeric 07 - Deprecation labels Jun 19, 2018

mattip changed the title ~~DEP: remove undocumented, unused dtype type dicts~~ API: remove undocumented, unused dtype type dicts Jun 19, 2018

mattip force-pushed the remove-typeNA branch from edbd768 to 0e3b451 Compare June 19, 2018 22:58

eric-wieser added the 54 - Needs decision label Jun 21, 2018

mattip force-pushed the remove-typeNA branch from 0e3b451 to 238ad66 Compare June 25, 2018 00:58

mattip changed the title ~~API: remove undocumented, unused dtype type dicts~~ DEP: deprecate undocumented, unused dtype type dicts Jun 25, 2018

eric-wieser reviewed Jun 25, 2018

View reviewed changes

eric-wieser reviewed Jul 3, 2018

View reviewed changes

mattip force-pushed the remove-typeNA branch 2 times, most recently from 0a20709 to 5f766a1 Compare July 6, 2018 05:19

eric-wieser reviewed Jul 6, 2018

View reviewed changes

rgommers requested changes Jul 14, 2018

View reviewed changes

DEP: deprecate undocumented, unused dtype type dicts

7c3f590

mattip force-pushed the remove-typeNA branch from 61abb7a to 7c3f590 Compare July 14, 2018 04:12

rgommers approved these changes Jul 14, 2018

View reviewed changes

rgommers merged commit c8b246c into numpy:master Jul 14, 2018

rgommers added this to the 1.16.0 release milestone Jul 14, 2018

mattip deleted the remove-typeNA branch July 14, 2018 13:07

This was referenced Sep 30, 2020

ENH: Replace the module-level __getattr__ with explicit type annotations #17367 #17406

Merged

Big list of functions in the top-level namespace missing types #16546

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEP: deprecate undocumented, unused dtype type dicts #11382

DEP: deprecate undocumented, unused dtype type dicts #11382

mattip commented Jun 19, 2018 •

edited

eric-wieser commented Jun 19, 2018

mattip commented Jun 19, 2018

eric-wieser commented Jun 21, 2018

mattip commented Jun 24, 2018

eric-wieser commented Jun 24, 2018

mattip commented Jun 25, 2018

eric-wieser Jun 25, 2018

mattip Jun 25, 2018

eric-wieser Jun 25, 2018

mattip Jun 25, 2018

mattip commented Jul 3, 2018

eric-wieser Jul 3, 2018

mattip Jul 3, 2018

eric-wieser Jul 3, 2018

mattip Jul 3, 2018

charris commented Jul 3, 2018

mattip commented Jul 4, 2018

charris commented Jul 4, 2018

eric-wieser commented Jul 5, 2018

charris commented Jul 5, 2018

mattip commented Jul 6, 2018

eric-wieser Jul 6, 2018 •

edited

mattip Jul 6, 2018

eric-wieser Jul 6, 2018

mattip Jul 6, 2018

eric-wieser Jul 6, 2018

mattip Jul 6, 2018

mattip commented Jul 14, 2018

rgommers Jul 14, 2018

rgommers Jul 14, 2018

mattip Jul 14, 2018

mattip commented Jul 14, 2018

rgommers commented Jul 14, 2018

		@@ -47,8 +47,10 @@ def test_pickle_transposed(self):

		def test_typeNA(self):
		# Ticket #31

DEP: deprecate undocumented, unused dtype type dicts #11382

DEP: deprecate undocumented, unused dtype type dicts #11382

Conversation

mattip commented Jun 19, 2018 • edited

eric-wieser commented Jun 19, 2018

mattip commented Jun 19, 2018

eric-wieser commented Jun 21, 2018

mattip commented Jun 24, 2018

eric-wieser commented Jun 24, 2018

mattip commented Jun 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattip commented Jul 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charris commented Jul 3, 2018

mattip commented Jul 4, 2018

charris commented Jul 4, 2018

eric-wieser commented Jul 5, 2018

charris commented Jul 5, 2018

mattip commented Jul 6, 2018

eric-wieser Jul 6, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattip commented Jul 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattip commented Jul 14, 2018

rgommers commented Jul 14, 2018

mattip commented Jun 19, 2018 •

edited

eric-wieser Jul 6, 2018 •

edited