Introduce py::native_enum_kind (mandatory argument without a default). - #30118
Merged
rwgk merged 9 commits intoApr 19, 2024
Merged
rwgk merged 9 commits into
rwgk merged 9 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
🐍 3 • Clang dev • C++11 • x64
```
-- The CXX compiler identification is Clang 19.0.0
```
```
/__w/pybind11k/pybind11k/include/pybind11/detail/function_record_pyobject.h:38:26: error: cast from 'PyObject *(*)(PyObject *, PyObject *, PyObject *)' (aka '_object *(*)(_object *, _object *, _object *)') to 'PyCFunction' (aka '_object *(*)(_object *, _object *)') converts to incompatible function type [-Werror,-Wcast-function-type-mismatch]
38 | = {{"__reduce_ex__", (PyCFunction) reduce_ex_impl, METH_VARARGS | METH_KEYWORDS, nullptr},
```
metzen
reviewed
Apr 19, 2024
Comment thread
include/pybind11/detail/native_enum_data.h
Outdated
| return "`native_enum` was not added to any module." | ||
| " Use e.g. `m += native_enum<...>(\"" | ||
| + enum_name_encoded + "\")` to fix."; | ||
| + enum_name_encoded + "\", py::native_enum_kind::IntEnum)` to fix."; |
Copy link
Copy Markdown
There was a problem hiding this comment.
This might give an impression that the IntEnum kind is preferred, which isn't really true, right? Should this just use a placeholder ellipsis , or full suggestion of both versions? (e.g., "Use m += native_enum<...>("Name", Enum) or m += native_enum<...>("Name", IntEnum) to fix)
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment.
Changed (f3b8a03) to .... — I wasn't sure about this myself before. Considering that the += part is the critical part of the error message, I believe using ... is best (will distract people the least from the critical part).
Sorry, something went wrong.
metzen
approved these changes
Apr 19, 2024
rwgk
added a commit
to google/clif
that referenced
this pull request
Aug 27, 2024
This update needs corresponding small changes in third_party/clif/pybind11/enums.py third_party/clif/testing/python/t3_test.py TGP-tested via temporary cl/626240839: http://tap/OCL:626240839:BASE:626375750:1713541129757:e746a257 Note: Currently codesearch finds matches for `pybind11 native_enum` only in third_party/pybind11 and third_party/clif/pybind11. This CL fixes 15 PyCLIF-pybind11 TGP failures: b/287289622#comment73 #MIGRATION_3P_PYBIND11__DEFAULT - 9f5899480ce875ad99daad0874110aba2658ee7b Introduce `py::native_enum_kind` (mandatory argument with... by Ralf W. Grosse-Kunstleve <rwgk@google.com> PiperOrigin-RevId: 626432303
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewer2 participants
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
The core change here is to introduce
and to change the native_enum constructor to require passing one of those two values, e.g.:
py::native_enum<smallenum>("smallenum", py::native_enum_kind::IntEnum)This completely replaces the automatic mechanism for the determination of use_int_enum (a member of pybind11::detail::native_enum_data).
All other changes are of the boilerplate kind (updating one error message and the native_enum unit tests).
The rationale for this change is:
For manually written code: Simply put it in the hands of the author what native enum type is used. This also makes the bindings more self-documenting.
For automatically generated code (PyCLIF): Leave the choice of native enum type up to the code generator (PyCLIF-C-API has the corresponding logic already).
Google-internal global test ID: OCL:626240839:BASE:626375750:1713541129757:e746a257
For completeness: This is what happens if a user chooses IntEnum for a C++ enum with a char underlying type:
( cd /usr/local/google/home/rwgk/forked/pybind11/tests && PYTHONPATH=/usr/local/google/home/rwgk/forked/build_gcc/lib /usr/bin/python3 -m pytest test_native_enum.py ) Traceback (most recent call last): File "/usr/lib/python3.11/enum.py", line 714, in __call__ return cls._create_( ^^^^^^^^^^^^^ File "/usr/lib/python3.11/enum.py", line 891, in _create_ return metacls.__new__(metacls, class_name, bases, classdict, boundary=boundary) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/lib/python3.11/enum.py", line 566, in __new__ raise exc File "/usr/lib/python3.11/enum.py", line 259, in __set_name__ enum_member = enum_class._new_member_(enum_class, *args) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ValueError: invalid literal for int() with base 10: 'h' The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/usr/local/google/home/rwgk/forked/pybind11/tests/conftest.py", line 20, in <module> import pybind11_tests ImportError: initialization failed ImportError while loading conftest '/usr/local/google/home/rwgk/forked/pybind11/tests/conftest.py'. conftest.py:20: in <module> import pybind11_tests E ImportError: initialization failed ERROR: completed_process.returncode=4Note regarding commit history: this PR was originally based on #30117.
Suggested changelog entry: