module documentation

Module defining global singleton classes.

This module raises a RuntimeError if an attempt to reload it is made. In that way the identities of the classes defined here are fixed and will remain so even if numpy itself is reloaded. In particular, a function like the following will still work correctly after numpy is reloaded:

def foo(arg=np._NoValue):
    if arg is np._NoValue:
        ...

That was not the case when the singleton classes were defined in the numpy __init__.py file. See gh-7844 for a discussion of the reload problem that motivated this module.

Exception ModuleDeprecationWarning Module deprecation warning.
Exception VisibleDeprecationWarning Visible deprecation warning.
Constant __ALL__ Undocumented
Class _CopyMode An enumeration for the copy modes supported by numpy.copy() and numpy.array(). The following three modes are supported,
Class _NoValueType Special keyword value.
Variable _is_loaded Undocumented
Variable _NoValue Undocumented

Undocumented

Value
['ModuleDeprecationWarning',
 'VisibleDeprecationWarning',
 '_NoValue',
 '_CopyMode']
_is_loaded: bool = (source)

Undocumented

_NoValue = (source)

Undocumented