Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Closing #18668: Properly document setting m_size in PyModuleDef

This commit is contained in:
Eli Bendersky 2013-08-07 05:54:28 -07:00
parent 236a547b3e 0d2d2b8393
commit 7533137f4e
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/c-api/module.rst
View File

@ -189,16 +189,22 @@ These functions are usually used in the module initialization function.
.. c:member:: Py_ssize_t m_size .. c:member:: Py_ssize_t m_size
If the module object needs additional memory, this should be set to the Some modules allow re-initialization (calling their ``PyInit_*`` function
number of bytes to allocate; a pointer to the block of memory can be more than once). These modules should keep their state in a per-module
retrieved with :c:func:`PyModule_GetState`. If no memory is needed, set memory area that can be retrieved with :c:func:`PyModule_GetState`.
this to ``-1``.
This memory should be used, rather than static globals, to hold per-module This memory should be used, rather than static globals, to hold per-module
state, since it is then safe for use in multiple sub-interpreters. It is state, since it is then safe for use in multiple sub-interpreters. It is
freed when the module object is deallocated, after the :c:member:`m_free` freed when the module object is deallocated, after the :c:member:`m_free`
function has been called, if present. function has been called, if present.
Setting ``m_size`` to a positive value specifies the size of the additional
memory required by the module. Setting it to ``-1`` means that the module can
not be re-initialized because it has global state. Setting it to ``0`` is
forbidden.
See :PEP:`3121` for more details.
.. c:member:: PyMethodDef* m_methods .. c:member:: PyMethodDef* m_methods
A pointer to a table of module-level functions, described by A pointer to a table of module-level functions, described by