Skip to content

Commit d7a27e5

Browse files
authored
gh-107298: Document PyMODINIT_FUNC macro (#109236)
Document PyMODINIT_FUNC macro. Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are not documented. These macros should only be used to define the Python C API. They should not be used outside Python code base.
1 parent 1f885df commit d7a27e5

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed

Doc/c-api/intro.rst

+24
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,30 @@ defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`).
105105
Others of a more general utility are defined here. This is not necessarily a
106106
complete listing.
107107

108+
.. c:macro:: PyMODINIT_FUNC
109+
110+
Declare an extension module ``PyInit`` initialization function. The function
111+
return type is :c:expr:`PyObject*`. The macro declares any special linkage
112+
declarations required by the platform, and for C++ declares the function as
113+
``extern "C"``.
114+
115+
The initialization function must be named :samp:`PyInit_{name}`, where
116+
*name* is the name of the module, and should be the only non-\ ``static``
117+
item defined in the module file. Example::
118+
119+
static struct PyModuleDef spam_module = {
120+
PyModuleDef_HEAD_INIT,
121+
.m_name = "spam",
122+
...
123+
};
124+
125+
PyMODINIT_FUNC
126+
PyInit_spam(void)
127+
{
128+
return PyModule_Create(&spam_module);
129+
}
130+
131+
108132
.. c:macro:: Py_ABS(x)
109133
110134
Return the absolute value of ``x``.

Doc/using/configure.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,8 @@ Example on Linux x86-64::
855855
At the beginning of the files, C extensions are built as built-in modules.
856856
Extensions defined after the ``*shared*`` marker are built as dynamic libraries.
857857

858-
The :c:macro:`PyAPI_FUNC()`, :c:macro:`PyAPI_DATA()` and
859-
:c:macro:`PyMODINIT_FUNC` macros of :file:`Include/pyport.h` are defined
858+
The :c:macro:`!PyAPI_FUNC()`, :c:macro:`!PyAPI_DATA()` and
859+
:c:macro:`PyMODINIT_FUNC` macros of :file:`Include/exports.h` are defined
860860
differently depending if the ``Py_BUILD_CORE_MODULE`` macro is defined:
861861

862862
* Use ``Py_EXPORTED_SYMBOL`` if the ``Py_BUILD_CORE_MODULE`` is defined

Doc/whatsnew/2.3.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1889,7 +1889,7 @@ Changes to Python's build process and to the C API include:
18891889
* The :c:macro:`!DL_EXPORT` and :c:macro:`!DL_IMPORT` macros are now deprecated.
18901890
Initialization functions for Python extension modules should now be declared
18911891
using the new macro :c:macro:`PyMODINIT_FUNC`, while the Python core will
1892-
generally use the :c:macro:`PyAPI_FUNC` and :c:macro:`PyAPI_DATA` macros.
1892+
generally use the :c:macro:`!PyAPI_FUNC` and :c:macro:`!PyAPI_DATA` macros.
18931893

18941894
* The interpreter can be compiled without any docstrings for the built-in
18951895
functions and modules by supplying :option:`!--without-doc-strings` to the

0 commit comments

Comments
 (0)