docs: Add a note about calling Python C APIs on py::native_enum
#5640
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
henryiii
approved these changes
May 7, 2025
Skylion007
approved these changes
May 7, 2025
rwgk
reviewed
May 7, 2025
|
|
||
| The enum types created by ``py::native_enum`` are native Python types, while | ||
| the enum types created by the older ``py::enum_`` are C++ pybind11 types. | ||
| Developers **SHOULD NOT** call ``PyType_*`` Python C APIs on the enum types |
There was a problem hiding this comment.
First impression: I'm very confused.
Could you please explain more? E.g. provide an example of what exactly one might want to do with PyType_*?
There was a problem hiding this comment.
I added a comment here: https://github.com/metaopt/optree/pull/214/files#r2078078711
Merged
12 tasks
rwgk
requested changes
May 7, 2025
|
I added a comment in metaopt/optree#214 (comment). The problem is that I used the |
|
It was eye-opening to see how difficult it is to decide "can I include pybind11/native_enum.h"? I added a reminder to fix that to #5589 |
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.
Description
Add a note about calling Python C APIs on
py::native_enumin the documentation.Developers should never call
PyType_*Python C APIs on the enum types created bypy:native_enum, which can cause unexpected issues.See also:
pybind11::native_enumto create enum classPyTreeKindmetaopt/optree#214Suggested changelog entry:
Add a note about calling Python C APIs on `py::native_enum` in the documentation.