Add a page on changing the C API (PEP-652) #682
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This repeats points currently said in `Include/README.rst`. I intend to replace most of that README with a link to this document. The main change from that document are: - The three "rings" are not defined by where things are declared. It would be good to have them in the right place, but it's not yet the case, and for technical reasons we might never reach the ideal. (In `Include/README.rst` it makes more sense to make the locations more prominent.) - The order is switched. For changing the Limited API you generally need to read (and follow guidelines in) the preceding sections as well. I added points from PEP 652 (Maintaining the Stable ABI).
|
The page, rendered on RTD: https://cpython-devguide--682.org.readthedocs.build/c-api/ @erlend-aasland, you wrote Note that I also want to improve |
encukou
added a commit
to encukou/cpython
that referenced
this pull request
Apr 29, 2021
c-api.rst
Outdated
|
|
||
| - Please start a public discussion before expanding the Limited API | ||
|
|
||
| - The limited API and its intended use must follow standard C, not just |
There was a problem hiding this comment.
Suggested change
| - The limited API and its intended use must follow standard C, not just | |
| - The Limited API and its intended use must follow standard C, not just |
(Nit: I find the "its intended use" part a tiny bit weird. Can it be reformulated?)
There was a problem hiding this comment.
Also, the "follow standard C" part is covered in line 130.
| 1. The internal, private API, available with ``Py_BUILD_CORE`` defined. | ||
| Ideally declared in ``Include/internal/``. Any API named with a leading | ||
| underscore is also considered private. | ||
| 2. The public C API, available when ``Python.h`` is included normally. |
There was a problem hiding this comment.
Maybe drop "normally"?
There was a problem hiding this comment.
By normally I mean without defining macros to select the other variants. I'll expand that in the section below.
|
Thanks for the comments! |
|
Thanks! |
|
https://devguide.python.org/c-api/ is great, thanks @encukou! Next step: document C API removal ;-) |
AA-Turner
pushed a commit
to AA-Turner/devguide
that referenced
this pull request
Jun 17, 2022
This repeats points currently said in `Include/README.rst`. I intend to replace most of that README with a link to this document. The main change from that document are: - The three "rings" are not defined by where things are declared. It would be good to have them in the right place, but it's not yet the case, and for technical reasons we might never reach the ideal. (In `Include/README.rst` it makes more sense to make the locations more prominent.) - The order is switched. For changing the Limited API you generally need to read (and follow guidelines in) the preceding sections as well. On top of that, I addes points from PEP 652 (Maintaining the Stable ABI). Co-Authored-By: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This repeats points currently said in
Include/README.rst.I intend to replace most of that README with a link to this document.
The main change from that document are:
It would be good to have them in the right place, but it's
not yet the case, and for technical reasons we might never reach
the ideal. (In
Include/README.rstit makes more sense to makethe locations more prominent.)
need to read (and follow guidelines in) the preceding sections
as well.
I added points from PEP-652 (Maintaining the Stable ABI).