Skip to content
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.

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

gh-102468: Document PyCFunction_New* and PyCMethod_New #112557

Merged
merged 23 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from 19 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
29 changes: 29 additions & 0 deletions Doc/c-api/structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,35 @@ definition with the same method name.
slot. This is helpful because calls to PyCFunctions are optimized more
than wrapper object calls.

.. c:function:: PyObject * PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)

Turn *ml* into a Python :term:`callable` object. The caller must ensure that
*ml* outlives the :term:`callable`. Typically, *ml* is defined as a static
variable.
aisk marked this conversation as resolved.
Show resolved Hide resolved

The *self* parameter will be passed as the *self* argument to the C function
in ``ml->ml_meth`` when invoked. *self* can be ``NULL``.

The :term:`callable` object's ``__module__`` attribute can be set from the
given *module* argument. *module* should be a Python string, which will be
used as name of the module the function is defined in. If unavailable, it
can be set to :const:`None` or ``NULL``.
aisk marked this conversation as resolved.
Show resolved Hide resolved

The *cls* parameter will be passed as the *defining_class* argument to the C
function. Must be set if :c:macro:`METH_METHOD` is set on ``ml->ml_flags``.
aisk marked this conversation as resolved.
Show resolved Hide resolved

.. seealso: :attr:`function.__module__`
encukou marked this conversation as resolved.
Show resolved Hide resolved


.. c:function:: PyObject * PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)

Equivalent to ``PyCMethod_New(ml, self, module, NULL)``.


.. c:function:: PyObject * PyCFunction_New(PyMethodDef *ml, PyObject *self)

Equivalent to ``PyCMethod_New(ml, self, NULL, NULL)``.


Accessing attributes of extension types
---------------------------------------
Expand Down
15 changes: 15 additions & 0 deletions Doc/data/refcounts.dat
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,21 @@ PyContextVar_Reset:int:::
PyContextVar_Reset:PyObject*:var:0:
PyContextVar_Reset:PyObject*:token:-1:

PyCFunction_New:PyObject*::+1:
PyCFunction_New:PyMethodDef*:ml::
PyCFunction_New:PyObject*:self:+1:

PyCFunction_NewEx:PyObject*::+1:
PyCFunction_NewEx:PyMethodDef*:ml::
PyCFunction_NewEx:PyObject*:self:+1:
PyCFunction_NewEx:PyObject*:module:+1:

PyCMethod_New:PyObject*::+1:
PyCMethod_New:PyMethodDef*:ml::
PyCMethod_New:PyObject*:self:+1:
PyCMethod_New:PyObject*:module:+1:
PyCMethod_New:PyObject*:cls:+1:

PyDate_Check:int:::
PyDate_Check:PyObject*:ob:0:

Expand Down
Loading