Skip to content

gh-107298: Document PyAPI_DATA() macro #109129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

gh-107298: Document PyAPI_DATA() macro #109129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,28 @@ defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`).
Others of a more general utility are defined here. This is not necessarily a
complete listing.

.. c:macro:: PyAPI_DATA(type)

Declare a variable of type *type* which should be exported by Python. The
macro should only be used in Python C API. Example::

PyAPI_DATA(const unsigned long) Py_Version;

.. c:macro:: PyAPI_FUNC(type)

Declare a function with a return type *type* which should be exported by
Python. The macro should only be used in Python C API. Example::

PyAPI_FUNC(PyObject *) PyLong_FromLong(long);

.. c:macro:: PyMODINIT_FUNC

Declare an extension module ``PyInit`` initialization function. The return
type is :c:expr:`PyObject*`. The macro should only be used in Python C API.
Comment on lines +111 to +125
Copy link
Member

@hugovk hugovk Sep 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Little suggestion adding 3 x "the":

Suggested change
macro should only be used in Python C API. Example::
PyAPI_DATA(const unsigned long) Py_Version;
.. c:macro:: PyAPI_FUNC(type)
Declare a function with a return type *type* which should be exported by
Python. The macro should only be used in Python C API. Example::
PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
.. c:macro:: PyMODINIT_FUNC
Declare an extension module ``PyInit`` initialization function. The return
type is :c:expr:`PyObject*`. The macro should only be used in Python C API.
macro should only be used in the Python C API. Example::
PyAPI_DATA(const unsigned long) Py_Version;
.. c:macro:: PyAPI_FUNC(type)
Declare a function with a return type *type* which should be exported by
Python. The macro should only be used in the Python C API. Example::
PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
.. c:macro:: PyMODINIT_FUNC
Declare an extension module ``PyInit`` initialization function. The return
type is :c:expr:`PyObject*`. The macro should only be used in the Python C API.

Example with the ``_ssl`` module::

PyMODINIT_FUNC PyInit__ssl(void)

.. c:macro:: Py_ABS(x)

Return the absolute value of ``x``.
Expand Down