Skip to content

Commit

Permalink
MAINT: Make __class_getitem__ available to all python version and p…
Browse files Browse the repository at this point in the history 
…erform basic validation of its input arguments

It will still raise on python 3.8, but now with a more explicit exception message
  • Loading branch information
Bas van Beek committed Sep 16, 2021
1 parent 0baeeb1 commit 3fc9eb5
Show file tree
Hide file tree
Showing 7 changed files with 190 additions and 99 deletions.
136 changes: 66 additions & 70 deletions numpy/core/_add_newdocs.py
View file
Expand Up @@ -9,7 +9,6 @@
"""

import sys
from numpy.core.function_base import add_newdoc
from numpy.core.overrides import array_function_like_doc

Expand Down Expand Up @@ -2799,38 +2798,37 @@
"""))


if sys.version_info > (3, 9):
add_newdoc('numpy.core.multiarray', 'ndarray', ('__class_getitem__',
"""a.__class_getitem__(item, /)
add_newdoc('numpy.core.multiarray', 'ndarray', ('__class_getitem__',
"""a.__class_getitem__(item, /)
Return a parametrized wrapper around the `~numpy.ndarray` type.
Return a parametrized wrapper around the `~numpy.ndarray` type.
.. versionadded:: 1.22
.. versionadded:: 1.22
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.ndarray` type.
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.ndarray` type.
Examples
--------
>>> from typing import Any
>>> import numpy as np
Examples
--------
>>> from typing import Any
>>> import numpy as np
>>> np.ndarray[Any, np.dtype]
numpy.ndarray[typing.Any, numpy.dtype]
>>> np.ndarray[Any, np.dtype[Any]]
numpy.ndarray[typing.Any, numpy.dtype[Any]]
Note
----
This method is only available for python 3.9 and later.
Note
----
This method is only available for python 3.9 and later.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
numpy.typing.NDArray : An ndarray alias :term:`generic <generic type>`
w.r.t. its `dtype.type <numpy.dtype.type>`.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
numpy.typing.NDArray : An ndarray alias :term:`generic <generic type>`
w.r.t. its `dtype.type <numpy.dtype.type>`.
"""))
"""))


add_newdoc('numpy.core.multiarray', 'ndarray', ('__deepcopy__',
Expand Down Expand Up @@ -6079,36 +6077,35 @@
"""))

if sys.version_info >= (3, 9):
add_newdoc('numpy.core.multiarray', 'dtype', ('__class_getitem__',
"""
__class_getitem__(item, /)
add_newdoc('numpy.core.multiarray', 'dtype', ('__class_getitem__',
"""
__class_getitem__(item, /)
Return a parametrized wrapper around the `~numpy.dtype` type.
Return a parametrized wrapper around the `~numpy.dtype` type.
.. versionadded:: 1.22
.. versionadded:: 1.22
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.dtype` type.
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.dtype` type.
Examples
--------
>>> import numpy as np
Examples
--------
>>> import numpy as np
>>> np.dtype[np.int64]
numpy.dtype[numpy.int64]
>>> np.dtype[np.int64]
numpy.dtype[numpy.int64]
Note
----
This method is only available for python 3.9 and later.
Note
----
This method is only available for python 3.9 and later.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
"""))
"""))

##############################################################################
#
Expand Down Expand Up @@ -6530,37 +6527,36 @@ def refer_to_array_attribute(attr, method=True):
add_newdoc('numpy.core.numerictypes', 'generic',
refer_to_array_attribute('view'))

if sys.version_info >= (3, 9):
add_newdoc('numpy.core.numerictypes', 'number', ('__class_getitem__',
"""
__class_getitem__(item, /)
add_newdoc('numpy.core.numerictypes', 'number', ('__class_getitem__',
"""
__class_getitem__(item, /)
Return a parametrized wrapper around the `~numpy.number` type.
Return a parametrized wrapper around the `~numpy.number` type.
.. versionadded:: 1.22
.. versionadded:: 1.22
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.number` type.
Returns
-------
alias : types.GenericAlias
A parametrized `~numpy.number` type.
Examples
--------
>>> from typing import Any
>>> import numpy as np
Examples
--------
>>> from typing import Any
>>> import numpy as np
>>> np.signedinteger[Any]
numpy.signedinteger[typing.Any]
>>> np.signedinteger[Any]
numpy.signedinteger[typing.Any]
Note
----
This method is only available for python 3.9 and later.
Note
----
This method is only available for python 3.9 and later.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
See Also
--------
:pep:`585` : Type hinting generics in standard collections.
"""))
"""))

##############################################################################
#
Expand Down
27 changes: 23 additions & 4 deletions numpy/core/src/multiarray/descriptor.c
View file
Expand Up @@ -3101,6 +3101,28 @@ arraydescr_newbyteorder(PyArray_Descr *self, PyObject *args)
return (PyObject *)PyArray_DescrNewByteorder(self, endian);
}

static PyObject *
arraydescr_class_getitem(PyObject *cls, PyObject *args)
{
Py_ssize_t args_len;
PyObject *generic_alias;

#ifdef Py_GENERICALIASOBJECT_H
args_len = PyTuple_Check(args) ? PyTuple_Size(args) : 1;
if (args_len != 1) {
return PyErr_Format(PyExc_TypeError,
"Too %s arguments for %s",
args_len > 1 ? "many" : "few",
((PyTypeObject *)cls)->tp_name);
}
generic_alias = Py_GenericAlias(cls, args);
#else
return PyErr_SetString(PyExc_TypeError,
"Type subscription requires python >= 3.9");
#endif
return generic_alias;
}

static PyMethodDef arraydescr_methods[] = {
/* for pickling */
{"__reduce__",
Expand All @@ -3112,13 +3134,10 @@ static PyMethodDef arraydescr_methods[] = {
{"newbyteorder",
(PyCFunction)arraydescr_newbyteorder,
METH_VARARGS, NULL},

/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)Py_GenericAlias,
(PyCFunction)arraydescr_class_getitem,
METH_CLASS | METH_O, NULL},
#endif
{NULL, NULL, 0, NULL} /* sentinel */
};

Expand Down
26 changes: 23 additions & 3 deletions numpy/core/src/multiarray/methods.c
View file
Expand Up @@ -2699,6 +2699,28 @@ array_complex(PyArrayObject *self, PyObject *NPY_UNUSED(args))
return c;
}

static PyObject *
array_class_getitem(PyObject *cls, PyObject *args)
{
Py_ssize_t args_len;
PyObject *generic_alias;

#ifdef Py_GENERICALIASOBJECT_H
args_len = PyTuple_Check(args) ? PyTuple_Size(args) : 1;
if (args_len != 2) {
return PyErr_Format(PyExc_TypeError,
"Too %s arguments for %s",
args_len > 2 ? "many" : "few",
((PyTypeObject *)cls)->tp_name);
}
generic_alias = Py_GenericAlias(cls, args);
#else
return PyErr_SetString(PyExc_TypeError,
"Type subscription requires python >= 3.9");
#endif
return generic_alias;
}

NPY_NO_EXPORT PyMethodDef array_methods[] = {

/* for subtypes */
Expand Down Expand Up @@ -2757,11 +2779,9 @@ NPY_NO_EXPORT PyMethodDef array_methods[] = {
METH_VARARGS, NULL},

/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)Py_GenericAlias,
(PyCFunction)array_class_getitem,
METH_CLASS | METH_O, NULL},
#endif

/* Original and Extended methods added 2005 */
{"all",
Expand Down
46 changes: 32 additions & 14 deletions numpy/core/src/multiarray/scalartypes.c.src
View file
Expand Up @@ -1805,20 +1805,46 @@ gentype_setflags(PyObject *NPY_UNUSED(self), PyObject *NPY_UNUSED(args),
Py_RETURN_NONE;
}

static PyObject *
numbertype_class_getitem_abc(PyObject *cls, PyObject *args)
{
Py_ssize_t args_len;
PyObject *generic_alias;

#ifdef Py_GENERICALIASOBJECT_H
args_len = PyTuple_Check(args) ? PyTuple_Size(args) : 1;
if (args_len != 1) {
return PyErr_Format(PyExc_TypeError,
"Too %s arguments for %s",
args_len > 1 ? "many" : "few",
((PyTypeObject *)cls)->tp_name);
}
generic_alias = Py_GenericAlias(cls, args);
#else
return PyErr_SetString(PyExc_TypeError,
"Type subscription requires python >= 3.9");
#endif
return generic_alias;
}

/*
* Use for concrete np.number subclasses, making them act as if they
* were subtyped from e.g. np.signedinteger[object], thus lacking any
* free subscription parameters. Requires python >= 3.9.
*/
#ifdef Py_GENERICALIASOBJECT_H
static PyObject *
numbertype_class_getitem(PyObject *cls, PyObject *args)
{
return PyErr_Format(PyExc_TypeError,
"There are no type variables left in %s",
((PyTypeObject *)cls)->tp_name);
}
#ifdef Py_GENERICALIASOBJECT_H
PyErr_Format(PyExc_TypeError,
"There are no type variables left in %s",
((PyTypeObject *)cls)->tp_name);
#else
PyErr_SetString(PyExc_TypeError,
"Type subscription requires python >= 3.9");
#endif
return NULL;
}

/*
* casting complex numbers (that don't inherit from Python complex)
Expand Down Expand Up @@ -2205,11 +2231,9 @@ static PyGetSetDef inttype_getsets[] = {

static PyMethodDef numbertype_methods[] = {
/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)Py_GenericAlias,
(PyCFunction)numbertype_class_getitem_abc,
METH_CLASS | METH_O, NULL},
#endif
{NULL, NULL, 0, NULL} /* sentinel */
};

Expand All @@ -2221,11 +2245,9 @@ static PyMethodDef @name@type_methods[] = {
(PyCFunction)@name@_complex,
METH_VARARGS | METH_KEYWORDS, NULL},
/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)numbertype_class_getitem,
METH_CLASS | METH_O, NULL},
#endif
{NULL, NULL, 0, NULL}
};
/**end repeat**/
Expand Down Expand Up @@ -2264,11 +2286,9 @@ static PyMethodDef @name@type_methods[] = {
(PyCFunction)@name@_is_integer,
METH_NOARGS, NULL},
/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)numbertype_class_getitem,
METH_CLASS | METH_O, NULL},
#endif
{NULL, NULL, 0, NULL}
};
/**end repeat**/
Expand All @@ -2279,11 +2299,9 @@ static PyMethodDef @name@type_methods[] = {
*/
static PyMethodDef @name@type_methods[] = {
/* for typing; requires python >= 3.9 */
#ifdef Py_GENERICALIASOBJECT_H
{"__class_getitem__",
(PyCFunction)numbertype_class_getitem,
METH_CLASS | METH_O, NULL},
#endif
{NULL, NULL, 0, NULL}
};
/**end repeat**/
Expand Down

0 comments on commit 3fc9eb5

Please sign in to comment.