Objects for Type Hinting — Python documentation
Objects for Type Hinting
Various built-in types for type hinting are provided. Currently, two types exist – GenericAlias and Union. Only GenericAlias is exposed to C.
- PyObject *Py_GenericAlias(PyObject *origin, PyObject *args)
Create a GenericAlias object. Equivalent to calling the Python class types.GenericAlias. The origin and args arguments set the
GenericAlias‘s__origin__and__args__attributes respectively. origin should be a PyTypeObject*, and args can be a PyTupleObject* or anyPyObject*. If args passed is not a tuple, a 1-tuple is automatically constructed and__args__is set to(args,). Minimal checking is done for the arguments, so the function will succeed even if origin is not a type. TheGenericAlias‘s__parameters__attribute is constructed lazily from__args__. On failure, an exception is raised andNULLis returned.Here’s an example of how to make an extension type generic:
... static PyMethodDef my_obj_methods[] = { // Other methods. ... {"__class_getitem__", (PyCFunction)Py_GenericAlias, METH_O|METH_CLASS, "See PEP 585"} ... }See also
The data model method
__class_getitem__().New in version 3.9.
- PyTypeObject Py_GenericAliasType
The C type of the object returned by Py_GenericAlias(). Equivalent to types.GenericAlias in Python.
New in version 3.9.