Skip to content

bpo-42048: Document AC's defining_class converter #23978

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

Merged
vstinner merged 9 commits into from
Jan 20, 2021
Merged

bpo-42048: Document AC's defining_class converter #23978

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c508365
bpo-42048: Document AC's defining_class converter
Dec 28, 2020
dedc115
Fix inline literals
Dec 28, 2020
38df615
Use PEP marker
Jan 20, 2021
acf0f7e
Address review
Jan 20, 2021
08a7132
Close the braces
Jan 20, 2021
580d004
Address review: Move note about _PyType_GetModuleByDef being slow
Jan 20, 2021
19b306f
Fix .rst bug
Jan 20, 2021
97ec8e8
Fix typo: follwing => following
Jan 20, 2021
50a9143
Fix .rst bug: default role used
Jan 20, 2021
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
Prev Previous commit
Next Next commit
Fix inline literals
  • Loading branch information
Erlend E. Aasland committed Dec 28, 2020
commit dedc1150ddce380e9daa266c7e24597c1df4f1d8
16 changes: 8 additions & 8 deletions Doc/howto/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1211,7 +1211,7 @@ Using a "defining class" converter

Argument Clinic facilitates gaining access to the defining class of a method.
This is useful for heap type methods that need to fetch module level state.
Example from `Modules/zlibmodule.c`::
Example from ``Modules/zlibmodule.c``::

/*[clinic input]
zlib.Compress.compress
Expand All @@ -1229,15 +1229,15 @@ Example from `Modules/zlibmodule.c`::


Each method may only have one argument using this converter, and it must appear
after `self`, or, if `self` is not used, as the first argument. The argument
will be of type `PyTypeObject *`.
after ``self``, or, if ``self`` is not used, as the first argument. The argument
will be of type ``PyTypeObject *``.

When used, Argument Clinic will select `METH_FASTCALL | METH_KEYWORDS |
METH_METHOD` as the calling convention. The argument will not appear in
`__text_signature__`.
When used, Argument Clinic will select ``METH_FASTCALL | METH_KEYWORDS |
METH_METHOD`` as the calling convention. The argument will not appear in
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
``__text_signature__``.

The `defining_class` converter is not compatible with `__init__` and `__new__`
methods, which cannot use the `METH_METHOD` convention.
The ``defining_class`` converter is not compatible with ``__init__`` and ``__new__``
methods, which cannot use the ``METH_METHOD`` convention.
Comment thread
erlend-aasland marked this conversation as resolved.

See also PEP 573.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

Expand Down