feat: numpy scalars #5726
Merged
feat: numpy scalars #5726
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
force-pushed
the
henryiii/feat/numpyscalars
branch
from
6870f27 to
9e3752f
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR implements support for NumPy scalars by introducing the py::numpy_scalar type and a corresponding py::make_scalar() helper, along with tests and documentation updates.
- Introduces new type casters and helper functions (py::make_scalar, numpy_scalar) in the core API.
- Adds C++ and Python tests to verify proper conversion and behavior of NumPy scalars.
- Updates documentation to detail usage and limitations of the new NumPy scalar support.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_numpy_scalars.py | Adds tests for NumPy scalar type conversions using the new py::numpy_scalar API |
| tests/test_numpy_scalars.cpp | Registers and tests scalar operations using lambdas with py::numpy_scalar and py::make_scalar |
| tests/CMakeLists.txt | Adds the new test executable to the test target list |
| include/pybind11/numpy.h | Adds forward declarations, type caster, numpy_scalar struct, and helper functions |
| docs/advanced/pycpp/numpy.rst | Updates documentation with a new section on scalar types and their usage in pybind11 |
Co-authored-by: Steve R. Sun <[email protected]> Signed-off-by: Henry Schreiner <[email protected]>
Co-authored-by: Copilot <[email protected]>
henryiii
force-pushed
the
henryiii/feat/numpyscalars
branch
from
fdf2def to
8379d25
Compare
|
If you'd like to, go ahead. I won't be able to work on it for a few hours. I'll make sure you have access to my fork so you can push directly if you need to. Edit: I guess you actually have access to any PR branch, but just in case. |
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
Reworked (close #3544) by @sun1638650145. Which is a reworked (close #2060) from @aldanor. Adds wrappers for the scalar values part of the NumPy API. This is a bit more minimal than those, following the current coding style more closely (quite a bit of the diff is just moving stuff around so it's defined before it's used with the new usage), and it supports 32-bit systems (Windows and wasm32).
This PR includes a minor consistency fix:
The string returned by
npy_format_descriptor_name<bool>was changed from"bool"to"numpy.bool"to match the naming convention used for other scalar types (e.g.,"numpy.int64","numpy.float32"). This ensures consistent formatting for documentation and diagnostics.Suggested changelog entry:
py::numpy_scalar<>/py::make_scalar()for NumPy types.📚 Documentation preview 📚: https://pybind11--5726.org.readthedocs.build/