diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2016-08-19 08:51:39 (GMT) |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2016-08-19 08:51:39 (GMT) |
commit | c01e766b54700ed4140c0d414a1e6c957b461519 (patch) | |
tree | 4e1343c1b970bd26886d877fa5c426b9601e2bf0 | |
parent | db5380517f2e035e3a259d14799e668cd3fd31fd (diff) | |
download | cpython-c01e766b54700ed4140c0d414a1e6c957b461519.zip cpython-c01e766b54700ed4140c0d414a1e6c957b461519.tar.gz cpython-c01e766b54700ed4140c0d414a1e6c957b461519.tar.bz2 |
Issue #12946: Document that PyModule_GetDict can fail in some cases
-rw-r--r-- | Doc/c-api/module.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst index 34f8443..e810c69 100644 --- a/Doc/c-api/module.rst +++ b/Doc/c-api/module.rst @@ -59,10 +59,13 @@ Module Objects .. index:: single: __dict__ (module attribute) Return the dictionary object that implements *module*'s namespace; this object - is the same as the :attr:`~object.__dict__` attribute of the module object. This - function never fails. It is recommended extensions use other - :c:func:`PyModule_\*` and :c:func:`PyObject_\*` functions rather than directly - manipulate a module's :attr:`~object.__dict__`. + is the same as the :attr:`~object.__dict__` attribute of the module object. + If *module* is not a module object (or a subtype of a module object), + :exc:`SystemError` is raised and *NULL* is returned. + + It is recommended extensions use other :c:func:`PyModule_\*` and + :c:func:`PyObject_\*` functions rather than directly manipulate a module's + :attr:`~object.__dict__`. .. c:function:: PyObject* PyModule_GetNameObject(PyObject *module) |