gh-136823: Update documentation on excluded headers in Python.h #136824
+10
−6
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
bedevere-app
bot
added
awaiting review
docs
|
Hi @AA-Turner, could you please take a look at this PR? |
ilovelinux
reviewed
Jul 19, 2025
Doc/extending/extending.rst
Outdated
| ``PY``, except those defined in standard header files. | ||
|
|
||
| Note that :file:`Python.h` excludes ``<stdio.h>``, ``<string.h>``, ``<errno.h>``, and ``<stdlib.h>`` as they are not used by | ||
| Python anymore. For backward compatibility of existing third party C extensions, they will |
There was a problem hiding this comment.
Should we write down since which version they are no longer used, as we did for <ctype.h> and <unistd.h>?
There was a problem hiding this comment.
Seems like the right thing to do, but I couldn't find since which version they are no longer used. @vstinner, you seem to have added that comment to the code 4 years ago. Do you happen to know since which version?
AA-Turner
added
sprint
needs backport to 3.13
skirpichev
reviewed
Jul 19, 2025
Doc/extending/extending.rst
Outdated
Comment on lines
80
to
83
| Note that :file:`Python.h` excludes ``<stdio.h>``, ``<string.h>``, ``<errno.h>``, and ``<stdlib.h>`` as they are not used by | ||
| Python anymore. For backward compatibility of existing third party C extensions, they will | ||
| be included if Py_LIMITED_API is not defined and for limited C API version 3.10 and older. | ||
| The ``<ctype.h>`` and ``<unistd.h>`` headers are also not included for limited C API version 3.13 and newer. |
There was a problem hiding this comment.
Suggested change
| Note that :file:`Python.h` excludes ``<stdio.h>``, ``<string.h>``, ``<errno.h>``, and ``<stdlib.h>`` as they are not used by | |
| Python anymore. For backward compatibility of existing third party C extensions, they will | |
| be included if Py_LIMITED_API is not defined and for limited C API version 3.10 and older. | |
| The ``<ctype.h>`` and ``<unistd.h>`` headers are also not included for limited C API version 3.13 and newer. | |
| For backward compatibility of existing third party C extensions, :file:`Python.h` | |
| includes ``<stdio.h>``, ``<string.h>``, ``<errno.h>``, and ``<stdlib.h>`` iff | |
| :c:macro:`Py_LIMITED_API` is not defined or for limited C API version 3.10 and older. | |
| The ``<ctype.h>`` and ``<unistd.h>`` headers are also not included for limited C API version 3.13 and newer. |
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 part of the documentation from https://docs.python.org/3/extending/extending.html#a-simple-example is currently outdated:
This PR aligns the documentation with the code and the comments provided by the original author that implemented the changes.
📚 Documentation preview 📚: https://cpython-previews--136824.org.readthedocs.build/