diff options
author | Georg Brandl <georg@python.org> | 2009-01-04 23:20:14 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2009-01-04 23:20:14 (GMT) |
commit | e69cdf924df375844840c023f59dd9b5ac1b09b5 (patch) | |
tree | 9aa933a94405050b9ecce2964daf151057a6dc62 /Doc/c-api/allocation.rst | |
parent | 42db3efd368d154f428ce834ebc99fc8535931d7 (diff) | |
download | cpython-e69cdf924df375844840c023f59dd9b5ac1b09b5.zip cpython-e69cdf924df375844840c023f59dd9b5ac1b09b5.tar.gz cpython-e69cdf924df375844840c023f59dd9b5ac1b09b5.tar.bz2 |
#4614: document PyModule_Create and PyModuleDef struct.
Diffstat (limited to 'Doc/c-api/allocation.rst')
-rw-r--r-- | Doc/c-api/allocation.rst | 39 |
1 files changed, 7 insertions, 32 deletions
diff --git a/Doc/c-api/allocation.rst b/Doc/c-api/allocation.rst index cb78e79..60d7b44 100644 --- a/Doc/c-api/allocation.rst +++ b/Doc/c-api/allocation.rst @@ -54,40 +54,15 @@ Allocating Objects on the Heap accessed after this call as the memory is no longer a valid Python object. -.. cfunction:: PyObject* Py_InitModule(char *name, PyMethodDef *methods) - - Create a new module object based on a name and table of functions, returning - the new module object; the *methods* argument can be *NULL* if no methods are - to be defined for the module. - - -.. cfunction:: PyObject* Py_InitModule3(char *name, PyMethodDef *methods, char *doc) - - Create a new module object based on a name and table of functions, returning - the new module object. The *methods* argument can be *NULL* if no methods - are to be defined for the module. If *doc* is non-*NULL*, it will be used to - define the docstring for the module. - - -.. cfunction:: PyObject* Py_InitModule4(char *name, PyMethodDef *methods, char *doc, PyObject *self, int apiver) - - Create a new module object based on a name and table of functions, returning - the new module object. The *methods* argument can be *NULL* if no methods - are to be defined for the module. If *doc* is non-*NULL*, it will be used to - define the docstring for the module. If *self* is non-*NULL*, it will passed - to the functions of the module as their (otherwise *NULL*) first parameter. - (This was added as an experimental feature, and there are no known uses in - the current version of Python.) For *apiver*, the only value which should be - passed is defined by the constant :const:`PYTHON_API_VERSION`. - - .. note:: - - Most uses of this function should probably be using the :cfunc:`Py_InitModule3` - instead; only use this if you are sure you need it. - - .. cvar:: PyObject _Py_NoneStruct Object which is visible in Python as ``None``. This should only be accessed using the :cmacro:`Py_None` macro, which evaluates to a pointer to this object. + + +.. seealso:: + + :cfunc:`PyModule_Create` + To allocate and create extension modules. + |