Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion Doc/c-api/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Module Objects
.. index:: single: ModuleType (in module types)

This instance of :c:type:`PyTypeObject` represents the Python module type. This
is exposed to Python programs as ``types.ModuleType``.
is exposed to Python programs as :py:class:`types.ModuleType`.


.. c:function:: int PyModule_Check(PyObject *p)
Expand Down Expand Up @@ -71,6 +71,9 @@ Module Objects
``PyObject_*`` functions rather than directly manipulate a module's
:attr:`~object.__dict__`.

The returned reference is borrowed from the module; it is valid until
the module is destroyed.


.. c:function:: PyObject* PyModule_GetNameObject(PyObject *module)

Expand All @@ -90,6 +93,10 @@ Module Objects
Similar to :c:func:`PyModule_GetNameObject` but return the name encoded to
``'utf-8'``.

The returned buffer is only valid until the module is renamed or destroyed.
Note that Python code may rename a module by setting its :py:attr:`~module.__name__`
attribute.

.. c:function:: void* PyModule_GetState(PyObject *module)

Return the "state" of the module, that is, a pointer to the block of memory
Expand Down Expand Up @@ -126,6 +133,9 @@ Module Objects
Similar to :c:func:`PyModule_GetFilenameObject` but return the filename
encoded to 'utf-8'.

The returned buffer is only valid until the module's :py:attr:`~module.__file__` attribute
is reassigned or the module is destroyed.

.. deprecated:: 3.2
:c:func:`PyModule_GetFilename` raises :exc:`UnicodeEncodeError` on
unencodable filenames, use :c:func:`PyModule_GetFilenameObject` instead.
Expand Down Expand Up @@ -528,6 +538,9 @@ objects dynamically. Note that both ``PyModule_FromDefAndSpec`` and
``PyModuleDef``, using either ``PyModule_Create`` or
``PyModule_FromDefAndSpec``.

The *functions* array must be statically allocated (or otherwise guaranteed
to outlive the module object).

.. versionadded:: 3.5

Support functions
Expand Down
Loading