Recent Releases of pybind11
pybind11 - Version 3.0.1
Bug fixes:
- Fixed compilation error in
type_caster_enum_typewhen casting pointer-to-enum types. Added pointer overload to handle dereferencing before enum conversion. #5776 - Implement binary version of
make_index_sequenceto reduce template depth requirements for functions with many parameters. #5751 - Subinterpreter-specific exception handling code was removed to resolve segfaults. #5795
- Fixed issue that caused
PYBIND11_MODULEcode to run again if the module was re-imported after being deleted fromsys.modules. #5782 - Prevent concurrent creation of sub-interpreters as a workaround for stdlib concurrency issues in Python 3.12. #5779
- Fixed potential crash when using
cpp_functionobjects with sub-interpreters. #5771 - Fixed non-entrant check in
implicitly_convertible(). #5777 - Support C++20 on platforms that have older c++ runtimes. #5761
- Fix compilation with clang on msys2. #5757
- Avoid
nullptrdereference warning with GCC 13.3.0 and python 3.11.13. #5756 - Fix potential warning about number of threads being too large. #5807
- Fix gcc 11.4+ warning about serial compilation using CMake. #5791
Documentation:
- Improve
buffer_infotype checking in numpy docs. #5805 - Replace
robotpy-buildwithsemiwrapin the binding tool list. #5804 - Show nogil in most examples. #5770
- Fix
py::trampoline_self_life_supportvisibility in docs. #5766
Tests:
- Avoid a spurious warning about
DOWNLOAD_CATCHbeing manually specified. #5803 - Fix an IsolatedConfig test. #5768
CI:
- Add CI testing for Android. #5714
Internal:
- Rename internal variables to avoid the word
slots(reads better). #5793
- C++
Published by henryiii 9 months ago
pybind11 - Version 3.0.0 (final)
Pybind11 3.0 includes an ABI bump, the first required bump in many years on Unix (Windows has had required bumps more often). This release contains the smart-holder branch, multi-phase init and subinterpreter support, py::native_enum, an interface to warnings, typing improvements, and more. CMake now defaults to FindPython mode. Please check our upgrade guide for more info on upgrading!
Support for Python 3.14, 3.14t, GraalPy, and PyPy 3.11 has been added, while legacy support for Python 3.7, PyPy 3.8/3.9, and CMake <3.15 has been removed. Most deprecated features have been kept for this release, but anything producing a warning in 3.0 may be removed in a future 3.x version. We also now have a deprecation page.
New Features:
The
smart_holderbranch has been merged, enablingpy::class_<T, py::smart_holder>, which handles two-way conversion withstd::unique_ptr<T>andstd::shared_ptr<T>(simultaneously), disowning a Python object being passed tostd::unique_ptr<T>, trampoline objects, andstd::enable_shared_from_this. #5542- Added support for
std::shared_ptr<const T>inpy::init()when usingpy::smart_holder, complementing existing support forstd::unique_ptr<const T>. #5731 - Support const-only smart pointers. #5718
- Eliminate cross-DSO RTTI reliance from
trampoline_self_life_supportfunctionality,smart_holderdeleter detection, and othersmart_holderbookkeeping. Resolves platform-specific issues on macOS related to cross-DSOdynamic_castandtypeidmismatches. #5728 (replaces #5700)
- Added support for
Changed
PYBIND11_MODULEmacro implementation to perform multi-phase module initialization (PEP 489) behind the scenes. #5574 and avoid destruction #5688Support for sub-interpreters (both isolated (with separate GILs) and legacy (with a global GIL). Add the
py::multiple_interpreters::per_interpreter_gil()tag (or,py::multiple_interpreters::shared_gil()for legacy interpreter support) toPYBIND11_MODULEcalls (as the third parameter) to indicate that a module supports running with sub-interpreters. #5564- Rename macro
PYBIND11_SUBINTERPRETER_SUPPORT->PYBIND11_HAS_SUBINTERPRETER_SUPPORTto meet naming convention. #5682 - Allow subinterpreter support to be disabled if defined to 0. This is mostly an emergency workaround, and is not exposed in CMake. #5708 and #5710
- Modify internals pointer-to-pointer implementation to not use
thread_local(better iOS support). #5709 - Support implementations without subinterpreter support. #5732
- Rename macro
Changed
PYBIND11_EMBEDDED_MODULEmacro implementation to perform multi-phase module initialization (PEP 489) behind the scenes and to supportpy::mod_gil_not_used(),py::multiple_interpreters::per_interpreter_gil()andpy::multiple_interpreters::shared_gil(). #5665 and consolidate code #5670Added API in
pybind11/subinterpreter.hfor embedding sub-intepreters (requires Python 3.12+). #5666py::native_enumwas added, for conversions between Python's native (stdlib) enum types and C++ enums. #5555Support
py::numpy_scalar<>/py::make_scalar()for NumPy types. #5726A
py::release_gil_before_calling_cpp_dtoroption (forpy::class_) was added to resolve the long-standing issue #1446. #5522Add
dtype::normalized_numanddtype::num_of. #5429Add support for
array_t<handle>andarray_t<object>. #5427Added
py::warningsnamespace withpy::warnings::warnandpy::warnings::new_warning_typethat provides the interface for Python warnings. #5291stl.hlist|set|map_casterwere made more user friendly: it is no longer necessary to explicitly convert Python iterables totuple(),set(), ormap()in many common situations. #4686The
array_casterin pybind11/stl.h was enhanced to support value types that are not default-constructible. #5305pybind11/conduit/pybind11_platform_abi_id.hwas factored out, to maximize reusability ofPYBIND11_PLATFORM_ABI_ID(for other Python/C++ binding systems). Separately, a note was added to explain that the conduit feature only covers from-Python-to-C++ conversions. #5375 | #5740Added support for finding pybind11 using pkgconf distributed on pypi. #5552
Support
--extension-suffixon the pybind11 command. #5360Add semi-public API:
pybind11::detail::is_holder_constructedand update example forpybind11::custom_type_setupin documentation. #5669Added
py::scoped_critical_sectionto support free-threaded mode. #5684 | #5706
New Features / fixes (typing):
Added option for different arg/return type hints to
type_caster. Updatedstl/filesystemto use correct arg/return type hints. Updatedpybind11::typingto use correct arg/return type hints for nested types. #5450Updated type hint for
py::capsuletotype.CapsuleType. #5567Adds support for
typing.SupportsIntandtyping.SupportsFloat. UpdateFinalto be narrower type hint. Makestd::functionmatchCallabletype. Fixio_namebug inattr_with_type_hint. #5540Rework of arg/return type hints to support
.noconvert(). #5486Add
attr_with_typefor declaring attribute types andFinal,ClassVartype annotations. #5460Allow annotate methods with
py::pos_onlywhen only have theselfargument. Make arguments for auto-generated dunder methods positional-only. #5403Added
py::Argsandpy::KWArgsto enable custom type hinting of*argsand**kwargs(see PEP 484). #5357Switched to
numpy.typing.NDArrayandnumpy.typing.ArrayLike. #5212Use
numpy.object_instead ofobject. #5571Fix module type hint. #5469
Fix Buffer type hint. #5662
Added support for
collections.abcin type hints and convertible checks of STL casters andpy::buffer. #5566Fix
typingandcollections.abctype hint ambiguity. #5663Add
typing_extensionsalternatives for all types that need them. #5693
Removals:
Remove support for pybind11 v2 internals versions (4, 5, 6). (The internals version number has been bumped for pybind11 v3.) #5512 | #5530
Remove
make_simple_namespace(added in 2.8.0, deprecated in 2.8.1). #5597Legacy-mode option
PYBIND11_NUMPY_1_ONLYhas been removed. #5595Add a deprecation warning to
.get_type(deprecated in pybind11 2.6 in 2020). #5596
Bug fixes:
Set
__file__on submodules. #5584. Except on embedded modules. #5650pybind11-bound functions are now pickleable. #5580
Fix bug in
attr_with_type_hintto allow objects to be inattr_with_type_hint. #5576A
-Wmaybe-uninitializedwarning suppression was added inpybind11/eigen/matrix.h. #5516PYBIND11_WARNING_POPwas incorrectly defined asPYBIND11_PRAGMA(clang diagnostic push). #5448PYBIND11_PLATFORM_ABI_ID(which is used in composingPYBIND11_INTERNALS_ID) was modernized to reflect actual ABI compatibility more accurately. #4953 | #5439Fix buffer protocol implementation. #5407
Fix iterator increment operator does not skip first item. #5400
When getting or deleting an element in a container bound by
bind_map, print the key inKeyErrorif it does not exist. #5397pybind11::builtin_exceptionis now explicitly exported when linked to libc++. #5390Allow subclasses of
py::argsandpy::kwargs. #5381Disable false-positive GCC 12 Bound Check warning. #5355
Update the dict when restoring pickles, instead of assigning a replacement dict. #5658
Properly define
_DEBUGmacro to1instead of defining it without value. #5639Fix a missing time cast causing a compile error for newer ICC. #5621
Change the behavior of the default constructor of
py::sliceto be equivalent to::in Python. #5620
Bug fixes and features (CMake):
Enable FindPython mode by default, with a
COMPATmode that sets some of the old variables to ease transition. #5553Add an author warning that auto-calculated
PYTHON_MODULE_EXTENSIONmay not respectSETUPTOOLS_EXT_SUFFIXduring cross-compilation. #5495Don't strip with
CMAKE_BUILD_TYPENone. #5392Fix an issue with
NO_EXTRASaddingpybind11::windows_extrasanyway. #5378Fix issue with NEW/OLD message showing up. #5656
Use CMake's warnings as errors if available (CMake 3.24+). #5612
Add support for running pybind11's tests via presets in CMake 3.25+. #5655 and support
--fresh. #5668Experimental CMake support for Android. #5733
Presets now generate
compile_commands.json. #5685
Bug fixes (free-threading):
Fix data race in free threaded CPython when accessing a shared static variable. #5494
A free-threading data race in
all_type_info()was fixed. #5419Added exception translator specific mutex used with
try_translate_exceptionsin the free-threaded build for internal locking. #5362
Internals:
Consolidated all
PYBIND11_HAS_...feature macros intopybind11/detail/common.hto streamline backward compatibility checks and simplify internal refactoring. This change ensures consistent macro availability regardless of header inclusion order. #5647pybind11/gil_simple.hwas factored out frompybind11/gil.h, so that it can easily be reused. #5614Use CPython macros to construct
PYBIND11_VERSION_HEX. #5683
Documentation:
Improved
reference_internalpolicy documentation. #5528A new "Double locking, deadlocking, GIL" document was added. #5394
Add documenting for free-threading and subinterpreters. #5659
Tests:
Download the final Catch2 2.x release if Catch download is requested. #5568
Explicitly used
signed charfor two numpy dtype tests. As seen when compiling usingclangon Linux with the-funsigned-charflag. #5545CI testing now includes
-Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-declsin some jobs. #5523Add nightly wheels to scientific-python's nightly wheelhouse. #5675
Expect free-threaded warning when loading a non-free-threaded module. #5680
Run pytest under Python devmode. #5715
New and removed platforms:
Support Python 3.14 (beta 1+). #5646
Added support for GraalPy Python implementation (https://github.com/oracle/graalpython). #5380
Support and test iOS in CI. #5705
Support for PyPy 3.8 and 3.9 was dropped. #5578
Support for Python 3.7 was removed. (Official end-of-life: 2023-06-27). #5191
Support for CMake older than 3.15 removed. CMake 3.15-4.0 supported. #5304 and fix regression #5691.
Use scikit-build-core for the build backend for the PyPI
pybind11. The CMake generation has been moved to the sdist->wheel step.PYBIND11_GLOBAL_SDISThas been removed. #5598 and updated docs/ci. #5676clang 20 tested and used for clang-tidy. #5692
Drop testing on MSVC 2019 (as it is being removed from GitHub). #5712
Support Windows C++20 and Linux C++23 in tests. #5707
Full Changelog: https://github.com/pybind/pybind11/compare/v3.0.0rc4...v3.0.0
- C++
Published by rwgk 11 months ago
pybind11 - Version 3.0.0 RC 4
What's Changed
- feat: numpy scalars by @henryiii in https://github.com/pybind/pybind11/pull/5726
- fix: TSan warning in sub-interpreter test by @b-pass in https://github.com/pybind/pybind11/pull/5729
- fix: add support for
shared_ptr<const T>inpy::init()withsmart_holderby @rwgk in https://github.com/pybind/pybind11/pull/5731 - fix: add support for const-only smart pointers by @Rosdf in https://github.com/pybind/pybind11/pull/5718
- fix: android CMake support by @henryiii in https://github.com/pybind/pybind11/pull/5733
- fix: eliminate cross-DSO RTTI reliance in
smart_holderfunctionality (for platforms like macOS). by @rwgk in https://github.com/pybind/pybind11/pull/5728 - fix: handle implementations without subinterpreter support by @msimacek in https://github.com/pybind/pybind11/pull/5732
- ci: avoid 3.13.4 on Windows by @henryiii in https://github.com/pybind/pybind11/pull/5725
- ci: check latest on 3.13 by @henryiii in https://github.com/pybind/pybind11/pull/5734
- ci: cibw update to 3.0.0rc2 by @henryiii in https://github.com/pybind/pybind11/pull/5717
- docs: Add documentation entry for warnings by @jiwaszki in https://github.com/pybind/pybind11/pull/5356
- tests: better test for const only smart ptr by @Rosdf in https://github.com/pybind/pybind11/pull/5727
- tests: run pytest under Python devmode by @XuehaiPan in https://github.com/pybind/pybind11/pull/5715
- chore(deps): bump pypa/cibuildwheel from 3.0.0rc2 to 3.0 in the actions group by @dependabot in https://github.com/pybind/pybind11/pull/5721
- chore(deps): bump requests from 2.32.3 to 2.32.4 in /docs by @dependabot in https://github.com/pybind/pybind11/pull/5720
- chore(deps): bump urllib3 from 2.2.2 to 2.5.0 in /docs by @dependabot in https://github.com/pybind/pybind11/pull/5735
- chore: prepare for 3.0.0rc4 by @henryiii in https://github.com/pybind/pybind11/pull/5736
[!IMPORTANT]
This RC has an ABI bump. This is expected to be the last bump (and last RC) unless something comes up.
New Contributors
- @Rosdf made their first contribution in https://github.com/pybind/pybind11/pull/5718
Full Changelog: https://github.com/pybind/pybind11/compare/v3.0.0rc3...v3.0.0rc4
- C++
Published by henryiii 12 months ago
pybind11 - Version 3.0.0 RC 3
This is another release candidate. See the changelog in the docs for the combined changelog; this is just the changes since RC 2:
- fix(types): type hints from future python versions by @InvincibleRMC in https://github.com/pybind/pybind11/pull/5693
- fix: allow subinterpreters to be manually disabled by @henryiii in https://github.com/pybind/pybind11/pull/5708
- fix: follow rest of pybind11 closer with
PYBIND11_HAS_SUBINTERPRETER_SUPPORTby @henryiii in https://github.com/pybind/pybind11/pull/5710 - fix: modify the internals pointer-to-pointer implementation to not use
thread_localby @b-pass in https://github.com/pybind/pybind11/pull/5709 - fix: expose required symbol using clang by @petersteneteg in https://github.com/pybind/pybind11/pull/5700
- fix: handle null
py::handleand add tests forpy::scoped_critical_sectionby @XuehaiPan in https://github.com/pybind/pybind11/pull/5706 - ci: avoid brownout (and removal) of windows-2019 by @henryiii in https://github.com/pybind/pybind11/pull/5712
- ci: ios by @henryiii in https://github.com/pybind/pybind11/pull/5705
- ci: reduced runs on draft PRs by @henryiii in https://github.com/pybind/pybind11/pull/5707
- docs: prepare for RC 3 by @henryiii in https://github.com/pybind/pybind11/pull/5713
[!WARNING] Note our iOS support requires a cibuildwheel 3.0 beta currently, the cibuildwheel v3.0.0rc1 does not work.
[!IMPORTANT]
This RC has an ABI bump. We might need one more ABI bump before 3.0 final to improve the protection of our internals.
New Contributors
- @petersteneteg made their first contribution in https://github.com/pybind/pybind11/pull/5700
Full Changelog: https://github.com/pybind/pybind11/compare/v3.0.0rc2...v3.0.0rc3
- C++
Published by henryiii 12 months ago
pybind11 - Version 3.0.0 RC 2
This is another release candidate. See the changelog in the docs for the combined changelog; this is just the changes since RC 1:
- feat: scopedcriticalsection by @henryiii in https://github.com/pybind/pybind11/pull/5684
- fix(cmake): regression in include guard by @henryiii in https://github.com/pybind/pybind11/pull/5691
- fix: don't destruct module objects in atexit by @b-pass in https://github.com/pybind/pybind11/pull/5688
- fix: prepare for 3.14 beta 2 by @henryiii in https://github.com/pybind/pybind11/pull/5697
- chore(cmake): add compile commands to preset by @henryiii in https://github.com/pybind/pybind11/pull/5685
- chore: bump maximum clang tested to 20 by @henryiii in https://github.com/pybind/pybind11/pull/5692
- chore: rename macro
PYBIND11_SUBINTERPRETER_SUPPORT->PYBIND11_HAS_SUBINTERPRETER_SUPPORTto meet naming convention by @XuehaiPan in https://github.com/pybind/pybind11/pull/5682 - chore: use CPython macros to construct
PYBIND11_VERSION_HEXby @XuehaiPan in https://github.com/pybind/pybind11/pull/5683 - docs: more warnings about locking and the GIL by @henryiii in https://github.com/pybind/pybind11/pull/5689
- docs: update contributing/release guide a little by @henryiii in https://github.com/pybind/pybind11/pull/5681
- tests: always disable on the nogil build by @henryiii in https://github.com/pybind/pybind11/pull/5701
- tests: expect free-threaded import warnings by @henryiii in https://github.com/pybind/pybind11/pull/5680
- tests: skip some flaky gil tests on nogil by @henryiii in https://github.com/pybind/pybind11/pull/5699
Full Changelog: https://github.com/pybind/pybind11/compare/v3.0.0rc1...v3.0.0rc2
- C++
Published by henryiii about 1 year ago
pybind11 - Version 3.0.0 RC 1
What's Changed
Since this is a large release, we are providing a release candidate to give projects time to test! We also now provide SPEC 4 nightly wheels. We are hoping to split up std.h; that work is approved to be added during the RC phase if it's ready in time. We expect the RC phase to last around a week.
Pybind11 3.0 includes an ABI bump, the first required bump in many years on Unix (Windows has had required bumps more often). This release contains the smart-holder branch, multi-phase init and subinterpreter support, py::native_enum, an interface to warnings, typing improvements, and more. CMake now defaults to FindPython mode. Please check our upgrade guide for more info on upgrading!
Support for Python 3.14, 3.14t, GraalPy, and PyPy 3.11 has been added, while legacy support for Python 3.7, PyPy 3.8/3.9, and CMake <3.15 has been removed. Most deprecated features have been kept for this release, but anything producing a warning in 3.0 may be removed in a future 3.x version. We also now have a deprecation page.
New Features:
- The
smart_holderbranch has been merged, enablingpy::class_<T, py::smart_holder>, which handles two-way conversion withstd::unique_ptr<T>andstd::shared_ptr<T>(simultaneously), disowning a Python object being passed tostd::unique_ptr<T>, trampoline objects, andstd::enable_shared_from_this. #5542 - Changed
PYBIND11_MODULEmacro implementation to perform multi-phase module initialization (PEP 489) behind the scenes. #5574 - Support for sub-interpreters (both isolated (with separate GILs) and legacy (with a global GIL). Add the
py::multiple_interpreters::per_interpreter_gil()tag (or,py::multiple_interpreters::shared_gil()for legacy interpreter support) toPYBIND11_MODULEcalls (as the third parameter) to indicate that a module supports running with sub-interpreters. #5564 - Changed
PYBIND11_EMBEDDED_MODULEmacro implementation to perform multi-phase module initialization (PEP 489) behind the scenes and to supportpy::mod_gil_not_used(),py::multiple_interpreters::per_interpreter_gil()andpy::multiple_interpreters::shared_gil(). #5665 and consolidate code #5670 - Added API in
pybind11/subinterpreter.hfor embedding sub-intepreters (requires Python 3.12+). #5666 py::native_enumwas added, for conversions between Python's native (stdlib) enum types and C++ enums. #5555- A
py::release_gil_before_calling_cpp_dtoroption (forpy::class_) was added to resolve the long-standing issue #1446. #5522 - Add
dtype::normalized_numanddtype::num_of. #5429 - Add support for
array_t<handle>andarray_t<object>. #5427 - Added
py::warningsnamespace withpy::warnings::warnandpy::warnings::new_warning_typethat provides the interface for Python warnings. #5291 stl.hlist|set|map_casterwere made more user friendly: it is no longer necessary to explicitly convert Python iterables totuple(),set(), ormap()in many common situations. #4686- The
array_casterin pybind11/stl.h was enhanced to support value types that are not default-constructible. #5305 pybind11/conduit/pybind11_platform_abi_id.hwas factored out, to maximize reusability ofPYBIND11_PLATFORM_ABI_ID(for other Python/C++ binding systems). #5375- Added support for finding pybind11 using pkgconf distributed on pypi. #5552
- Support
--extension-suffixon the pybind11 command. #5360 - Add semi-public API:
pybind11::detail::is_holder_constructedand update example forpybind11::custom_type_setupin documentation. #5669
New Features / fixes (typing):
- Added option for different arg/return type hints to
type_caster. Updatedstl/filesystemto use correct arg/return type hints. Updatedpybind11::typingto use correct arg/return type hints for nested types. #5450 - Updated type hint for
py::capsuletotype.CapsuleType. #5567 - Adds support for
typing.SupportsIntandtyping.SupportsFloat. UpdateFinalto be narrower type hint. Makestd::functionmatchCallabletype. Fixio_namebug inattr_with_type_hint. #5540 - Rework of arg/return type hints to support
.noconvert(). #5486 - Add
attr_with_typefor declaring attribute types andFinal,ClassVartype annotations. #5460 - Allow annotate methods with
py::pos_onlywhen only have theselfargument. Make arguments for auto-generated dunder methods positional-only. #5403 - Added
py::Argsandpy::KWArgsto enable custom type hinting of*argsand**kwargs(see PEP 484). #5357 - Switched to
numpy.typing.NDArrayandnumpy.typing.ArrayLike. #5212 - Use
numpy.object_instead ofobject. #5571 - Fix module type hint. #5469
- Fix Buffer type hint. #5662
- Added support for
collections.abcin type hints and convertible checks of STL casters andpy::buffer. #5566 - Fix
typingandcollections.abctype hint ambiguity. #5663
Removals:
- Remove support for pybind11 v2 internals versions (4, 5, 6). (The internals version number has been bumped for pybind11 v3.) #5512 | #5530
- Remove
make_simple_namespace(added in 2.8.0, deprecated in 2.8.1). #5597 - Legacy-mode option
PYBIND11_NUMPY_1_ONLYhas been removed. #5595 - Add a deprecation warning to
.get_type(deprecated in pybind11 2.6 in 2020). #5596
Bug fixes:
- Set
__file__on submodules. #5584. Except on embedded modules. #5650 - pybind11-bound functions are now pickleable. #5580
- Fix bug in
attr_with_type_hintto allow objects to be inattr_with_type_hint. #5576 - A
-Wmaybe-uninitializedwarning suppression was added inpybind11/eigen/matrix.h. #5516 PYBIND11_WARNING_POPwas incorrectly defined asPYBIND11_PRAGMA(clang diagnostic push). #5448PYBIND11_PLATFORM_ABI_ID(which is used in composingPYBIND11_INTERNALS_ID) was modernized to reflect actual ABI compatibility more accurately. #4953 | #5439- Fix buffer protocol implementation. #5407
- Fix iterator increment operator does not skip first item. #5400
- When getting or deleting an element in a container bound by
bind_map, print the key inKeyErrorif it does not exist. #5397 pybind11::builtin_exceptionis now explicitly exported when linked to libc++. #5390- Allow subclasses of
py::argsandpy::kwargs. #5381 - Disable false-positive GCC 12 Bound Check warning. #5355
- fix: using
__cpp_nontype_template_argsinstead of__cpp_nontype_template_parameter_class. #5330 - Properly translate C++ exception to Python exception when creating Python buffer from wrapped object. #5324
- Update the dict when restoring pickles, instead of assigning a replacement dict. #5658
- Properly define
_DEBUGmacro to1instead of defining it without value. #5639 - Fix a missing time cast causing a compile error for newer ICC. #5621
- Change the behavior of the default constructor of
py::sliceto be equivalent to::in Python. #5620
Bug fixes (CMake):
- Enable FindPython mode by default, with a
COMPATmode that sets some of the old variables to ease transition. #5553 - Add an author warning that auto-calculated
PYTHON_MODULE_EXTENSIONmay not respectSETUPTOOLS_EXT_SUFFIXduring cross-compilation. #5495 - Don't strip with
CMAKE_BUILD_TYPENone. #5392 - Fix an issue with
NO_EXTRASaddingpybind11::windows_extrasanyway. #5378 - Fix issue with NEW/OLD message showing up. #5656
- Use CMake's warnings as errors if available (CMake 3.24+). #5612
- Add support for running pybind11's tests via presets in CMake 3.25+. #5655 and support
--fresh. #5668 - Restructure venv support to support
--fresh, make in build folder. #5668
Bug fixes (free-threading):
- Fix data race in free threaded CPython when accessing a shared static variable. #5494
- A free-threading data race in
all_type_info()was fixed. #5419 - Added exception translator specific mutex used with
try_translate_exceptionsin the free-threaded build for internal locking. #5362
Internals:
- Consolidated all
PYBIND11_HAS_...feature macros intopybind11/detail/common.hto streamline backward compatibility checks and simplify internal refactoring. This change ensures consistent macro availability regardless of header inclusion order. #5647 pybind11/gil_simple.hwas factored out frompybind11/gil.h, so that it can easily be reused. #5614
Documentation:
- Improved
reference_internalpolicy documentation. #5528 - A new "Double locking, deadlocking, GIL" document was added. #5394
- Adds an answer (FAQ) for "What is a highly conclusive and simple way to find memory leaks?". #5340
- Add documenting for free-threading and subinterpreters. #5659
Tests:
- Download the final Catch2 2.x release if Catch download is requested. #5568
- Explicitly used
signed charfor two numpy dtype tests. As seen when compiling usingclangon Linux with the-funsigned-charflag. #5545 - Test PyPy3.11 in CI. #5534
- CI testing now includes
-Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-declsin some jobs. #5523 - Add nightly wheels to scientific-python's nightly wheelhouse. #5675
New and removed platforms:
- Support Python 3.14 (beta 1). #5646
- Added support for GraalPy Python implementation (https://github.com/oracle/graalpython). #5380
- Support for PyPy 3.11 added. #5508
- Support for PyPy 3.8 and 3.9 was dropped. #5578
- Support for Python 3.7 was removed. (Official end-of-life: 2023-06-27). #5191
- Support for CMake older than 3.15 removed. CMake 3.15-4.0 supported. #5304
- Use scikit-build-core for the build backend for the PyPI
pybind11. The CMake generation has been moved to the sdist->wheel step.PYBIND11_GLOBAL_SDISThas been removed. #5598 and updated docs/ci. #5676
New Contributors
- @varunagrawal made their first contribution in https://github.com/pybind/pybind11/pull/5207
- @wenqing made their first contribution in https://github.com/pybind/pybind11/pull/5208
- @rgommers made their first contribution in https://github.com/pybind/pybind11/pull/5250
- @teo-tsirpanis made their first contribution in https://github.com/pybind/pybind11/pull/5263
- @fred-sch made their first contribution in https://github.com/pybind/pybind11/pull/5284
- @pwdcd made their first contribution in https://github.com/pybind/pybind11/pull/5308
- @MarkusBauer made their first contribution in https://github.com/pybind/pybind11/pull/4874
- @ObeliskGate made their first contribution in https://github.com/pybind/pybind11/pull/5314
- @DWesl made their first contribution in https://github.com/pybind/pybind11/pull/5326
- @vnlitvinov made their first contribution in https://github.com/pybind/pybind11/pull/5324
- @BobbyRBruce made their first contribution in https://github.com/pybind/pybind11/pull/5355
- @vfdev-5 made their first contribution in https://github.com/pybind/pybind11/pull/5362
- @Hintay made their first contribution in https://github.com/pybind/pybind11/pull/5378
- @gentlegiantJGC made their first contribution in https://github.com/pybind/pybind11/pull/5381
- @sarlinpe made their first contribution in https://github.com/pybind/pybind11/pull/5397
- @francesco-ballarin made their first contribution in https://github.com/pybind/pybind11/pull/5396
- @J-M0 made their first contribution in https://github.com/pybind/pybind11/pull/5448
- @timohl made their first contribution in https://github.com/pybind/pybind11/pull/5450
- @jspricke made their first contribution in https://github.com/pybind/pybind11/pull/5392
- @nikulpatel3141 made their first contribution in https://github.com/pybind/pybind11/pull/5360
- @mattip made their first contribution in https://github.com/pybind/pybind11/pull/5508
- @daizhirui made their first contribution in https://github.com/pybind/pybind11/pull/5516
- @pganssle-google made their first contribution in https://github.com/pybind/pybind11/pull/5545
- @b-pass made their first contribution in https://github.com/pybind/pybind11/pull/5574
- @dyollb made their first contribution in https://github.com/pybind/pybind11/pull/5617
- @nsoblath made their first contribution in https://github.com/pybind/pybind11/pull/5624
Full Changelog: https://github.com/pybind/pybind11/compare/v2.13.6...v3.0.0rc1
- C++
Published by henryiii about 1 year ago
pybind11 - Version 2.13.6
New Features:
- A new
self._pybind11_conduit_v1_()method is automatically added to allpy::class_-wrapped types, to enable type-safe interoperability between different independent Python/C++ bindings systems, including pybind11 versions with differentPYBIND11_INTERNALS_VERSION's. Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. #5296
Bug fixes:
- Using
__cpp_nontype_template_argsinstead of__cpp_nontype_template_parameter_class. #5330 - Properly translate C++ exception to Python exception when creating Python buffer from wrapped object. #5324
Documentation:
- Adds an answer (FAQ) for "What is a highly conclusive and simple way to find memory leaks?". #5340
- C++
Published by henryiii over 1 year ago
pybind11 - Version 2.11.2
New Features:
- A new
self._pybind11_conduit_v1_()method is automatically added to allpy::class_-wrapped types, to enable type-safe interoperability between different independent Python/C++ bindings systems, including pybind11 versions with differentPYBIND11_INTERNALS_VERSION's. Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. #5296
- C++
Published by rwgk over 1 year ago
pybind11 - Version 2.12.1
New Features:
- A new
self._pybind11_conduit_v1_()method is automatically added to allpy::class_-wrapped types, to enable type-safe interoperability between different independent Python/C++ bindings systems, including pybind11 versions with differentPYBIND11_INTERNALS_VERSION's. Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. #5296
- C++
Published by rwgk over 1 year ago
pybind11 - Version 2.13.5
Bug fixes:
- Fix includes when using Windows long paths (
\\?\prefix). #5321 - Support
-Wpedanticin C++20 mode. #5322 - Fix and test
<ranges>support forpy::tupleandpy::list. #5314
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.13.4
Bug fixes:
- Fix paths with spaces, including on Windows. (Replaces regression from #5302) #4874
Documentation:
- Remove repetitive words. #5308
Full Changelog: https://github.com/pybind/pybind11/compare/v2.13.3...v2.13.4
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.13.3
Bug fixes:
- Quote paths from pybind11-config #5302
- Fix typo in Emscripten support when in config mode (CMake) #5301
Full Changelog: https://github.com/pybind/pybind11/compare/v2.13.2...v2.13.3
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.13.2
New Features:
- A
pybind11::detail::type_caster_std_function_specializationsfeature was added, to support specializations forstd::function's with return types that require custom to-Python conversion behavior (to primary use case is to catch and convert exceptions). #4597
Changes:
- Use
PyMutexinstead ofstd::mutexfor internal locking in the free-threaded build. #5219 - Add a special type annotation for C++ empty tuple. #5214
- When compiling for WebAssembly, add the required exception flags (CMake 3.13+). #5298
Bug fixes:
- Make
gil_safe_call_once_and_storethread-safe in free-threaded CPython. #5246 - A missing
#include <algorithm>in pybind11/typing.h was added to fix build errors (in case user code does not already depend on that include). #5208 - Fix regression introduced in #5201 for GCC<10.3 in C++20 mode. #5205
- Remove extra = when assigning flto value in the case for Clang in CMake. #5207
Tests:
- Adding WASM testing to our CI (Pyodide / Emscripten via scikit-build-core). #4745
- clang-tidy (in GitHub Actions) was updated from clang 15 to clang 18. #5272
Full Changelog: https://github.com/pybind/pybind11/compare/v2.13.1...v2.13.2
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.13.1
New Features:
- Add support for
Typing.Callable[..., T]. #5202
Bug fixes:
- Avoid aligned allocation in free-threaded build in order to support macOS versions before 10.14. #5200
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.13.0
New Features:
- Support free-threaded CPython (3.13t). Add
py::mod_gil_not_used()tag to indicate if a module supports running with the GIL disabled. #5148 - Support for Python 3.6 was removed. (Official end-of-life: 2021-12-23). #5177
py::listgained a.clear()method. #5153- Support for
Union,Optional,type[T],typing.TypeGuard,typing.TypeIs,typing.Never,typing.NoReturnandtyping.Literalwas added topybind11/typing.h. #5166 #5165 #5194 #5193 #5192 - In CMake, if
PYBIND11_USE_CROSSCOMPILINGis enabled, thenCMAKE_CROSSCOMPILINGwill be respected and will keep pybind11 from accessing the interpreter during configuration. Several CMake variables will be required in this case, but can be deduced from the environment variableSETUPTOOLS_EXT_SUFFIX. The default (currentlyOFF) may be changed in the future. #5083
Bug fixes:
- A refcount bug (leading to heap-use-after-free) involving trampoline functions with
PyObject *return type was fixed. #5156 - Return
py::ssize_tfrom.ref_count()instead ofint. #5139 - A subtle bug involving C++ types with unusual
operator&overrides was fixed. #5189 - Support Python 3.13 with minor fix, add to CI. #5127
- Fix mistake affecting old cmake and old boost. #5149
Documentation:
- Build docs updated to feature scikit-build-core and meson-python, and updated setuptools instructions. #5168
Tests:
- Avoid immortal objects in tests. #5150
CI:
- Compile against Python 3.13t in CI.
- Use
macos-13(Intel) for CI jobs for now (will drop Python 3.7 soon). #5109 - Releases now have artifact attestations, visible at https://github.com/pybind/pybind11/attestations. #5196
Other:
- Some cleanup in preparation for 3.13 support. #5137
- Avoid a warning by ensuring an iterator end check is included in release mode. #5129
- Bump max cmake to 3.29. #5075
- Update docs and noxfile. #5071
- C++
Published by henryiii almost 2 years ago
pybind11 - Version 2.12.0
New Features:
pybind11now supports compiling for NumPy 2. Most code shouldn't change (seeupgrade-guide-2.12for details). However, if you experience issues you can definePYBIND11_NUMPY_1_ONLYto disable the new support for now, but this will be removed in the future. #5050pybind11/gil_safe_call_once.hwas added (it needs to be included explicitly). The primary use case is GIL-safe initialization of C++staticvariables. #4877- Support move-only iterators in
py::make_iterator,py::make_key_iterator,py::make_value_iterator. #4834 - Two simple
py::set_error()functions were added and the documentation was updated accordingly. In particular,py::exception<>::operator()was deprecated (use one of the new functions instead). The documentation forpy::exception<>was further updated to not suggest code that may result in undefined behavior. #4772
Bug fixes:
- Removes potential for Undefined Behavior during process teardown. #4897
- Improve compatibility with the nvcc compiler (especially CUDA 12.1/12.2). #4893
pybind11/numpy.hnow imports NumPy'smultiarrayand_internalsubmodules with paths depending on the installed version of NumPy (for compatibility with NumPy 2). #4857- Builtins collections names in docstrings are now consistently rendered in lowercase (list, set, dict, tuple), in accordance with PEP 585. #4833
- Added
py::typing::Iterator<T>,py::typing::Iterable<T>. #4832 - Render
py::functionasCallablein docstring. #4829 - Also bump
PYBIND11_INTERNALS_VERSIONfor MSVC, which unlocks two new features without creating additional incompatibilities. #4819 - Guard against crashes/corruptions caused by modules built with different MSVC versions. #4779
- A long-standing bug in the handling of Python multiple inheritance was fixed. See PR #4762 for the rather complex details. #4762
- Fix
bind_mapwithusingdeclarations. #4952 - Qualify
py::detail::concatusage to avoid ADL selecting one from somewhere else, such as modernjson's concat. #4955 - Use new PyCode API on Python 3.12+. #4916
- Minor cleanup from warnings reported by Clazy. #4988
- Remove typing and duplicate
class_forKeysView/ValuesView/ItemsView. #4985 - Use
PyObject_VisitManagedDict()andPyObject_ClearManagedDict()on Python 3.13 and newer. #4973 - Update
make_static_property_type()to make it compatible with Python 3.13. #4971
- Render typed iterators for
make_iterator,make_key_iterator,make_value_iterator. #4876 - Add several missing type name specializations. #5073
- Change docstring render for
py::buffer,py::sequenceandpy::handle(toBuffer,Sequence,Any). #4831 - Fixed
base_enum.__str__docstring. #4827 - Enforce single line docstring signatures. #4735
- Special 'typed' wrappers now available in
typing.hto annotate tuple, dict, list, set, and function. #4259 - Create
handle_type_namespecialization to type-hint variable length tuples. #5051
- Setting
PYBIND11_FINDPYTHONto OFF will force the old FindPythonLibs mechanism to be used. #5042 - Skip empty
PYBIND11_PYTHON_EXECUTABLE_LASTfor the first cmake run. #4856 - Fix FindPython mode exports & avoid
pkg_resourcesifimportlib.metadataavailable. #4941 Python_ADDITIONAL_VERSIONS(classic search) now includes 3.12. #4909pybind11.pcis now relocatable by default as long as install destinations are not absolute paths. #4830- Correctly detect CMake FindPython removal when used as a subdirectory. #4806
- Don't require the libs component on CMake 3.18+ when using
PYBIND11_FINDPYTHON(fixes manylinux builds). #4805 pybind11_stripis no longer automatically applied whenCMAKE_BUILD_TYPEis unset. #4780- Support
DEBUG_POSFIXcorrectly for debug builds. #4761 - Hardcode lto/thin lto for Emscripten cross-compiles. #4642
- Upgrade maximum supported CMake version to 3.27 to fix CMP0148 warnings. #4786
Documentation:
- Small fix to grammar in
functions.rst. #4791 - Remove upper bound in example pyproject.toml for setuptools. #4774
CI:
- CI: Update NVHPC to 23.5 and Ubuntu 20.04. #4764
- Test on PyPy 3.10. #4714
Other:
- Use Ruff formatter instead of Black. #4912
- An
assert()was added to help Coverty avoid generating a false positive. #4817
- C++
Published by henryiii about 2 years ago
pybind11 - Version 2.11.1
Changes:
PYBIND11_NO_ASSERT_GIL_HELD_INCREF_DECREFis now provided as an option for disabling the default-onPyGILState_Check()'s inpybind11::handle'sinc_ref()&dec_ref(). #4753PYBIND11_ASSERT_GIL_HELD_INCREF_DECREFwas disabled for PyPy in general (not just PyPy Windows). #4751
NOTE: There was a version number mishap in the first attempt making this release. It was fixed within minutes with #4756 and the stable branch was re-tagged. The upload to PyPI only succeeded for the corrected release.
- C++
Published by rwgk almost 3 years ago
pybind11 - Version 2.11.0
New features:
- The newly added
pybind11::detail::is_move_constructibletrait can be specialized for cases in whichstd::is_move_constructibledoes not work as needed. This is very similar to the long-establishedpybind11::detail::is_copy_constructible. #4631 - Introduce
recursive_container_traits. #4623 -
pybind11/type_caster_pyobject_ptr.hwas added to support automatic wrapping of APIs that make use ofPyObject *. This header needs to included explicitly (i.e. it is not included implicitly withpybind/pybind11.h). #4601 -
format_descriptor<>&npy_format_descriptor<>PyObject *specializations were added. The latter enablespy::array_t<PyObject *>to/from-python conversions. #4674 -
buffer_infogained anitem_type_is_equivalent_to<T>()member function. #4674 - The
capsuleAPI gained a user-friendly constructor (py::capsule(ptr, "name", dtor)). #4720
Changes:
-
PyGILState_Check()'s inpybind11::handle'sinc_ref()&dec_ref()are now enabled by default again. #4246 -
py::initialize_interpreter()usingPyConfig_InitPythonConfig()instead ofPyConfig_InitIsolatedConfig(), to obtain completesys.path. #4473 - Cast errors now always include Python type information, even if
PYBIND11_DETAILED_ERROR_MESSAGESis not defined. This increases binary sizes slightly (~1.5%) but the error messages are much more informative. #4463 - The docstring generation for the
std::array-list caster was fixed. Previously, signatures included the size of the list in a non-standard, non-spec compliant way. The new format conforms to PEP 593. Tooling for processing the docstrings may need to be updated accordingly. #4679 - Setter return values (which are inaccessible for all practical purposes) are no longer converted to Python (only to be discarded). #4621
- Allow lambda specified to function definition to be
noexcept(true)in C++17. #4593 - Get rid of recursive template instantiations for concatenating type signatures on C++17 and higher. #4587
- Compatibility with Python 3.12 (beta). Note that the minimum pybind11 ABI version for Python 3.12 is version 5. (The default ABI version for Python versions up to and including 3.11 is still version 4.). #4570
- With
PYBIND11_INTERNALS_VERSION 5(default for Python 3.12+), MSVC builds usestd::hash<std::type_index>andstd::equal_to<std::type_index>instead of string-based type comparisons. This resolves issues when binding types defined in the unnamed namespace. #4319 - Python exception
__notes__(introduced with Python 3.11) are now added to theerror_already_set::what()output. #4678
Build system improvements:
- CMake 3.27 support was added, CMake 3.4 support was dropped. FindPython will be used if
FindPythonInterpis not present. #4719 - Update clang-tidy to 15 in CI. #4387
- Moved the linting framework over to Ruff. #4483
- Skip
ltochecks and target generation whenCMAKE_INTERPROCEDURAL_OPTIMIZATIONis defined. #4643 - No longer inject
-stdlib=libc++, not needed for modern Pythons (macOS 10.9+). #4639 - PyPy 3.10 support was added, PyPy 3.7 support was dropped. #4728
- Testing with Python 3.12 beta releases was added. #4713
- C++
Published by rwgk almost 3 years ago
pybind11 - Version 2.10.4
Changes:
python3 -m pybind11gained a--versionoption (prints the version and exits). #4526
Bug Fixes:
- Fix a warning when pydebug is enabled on Python 3.11. #4461
- Ensure
gil_scoped_releaseRAII is non-copyable. #4490 - Ensure the tests dir does not show up with new versions of setuptools. #4510
- Better stacklevel for a warning in setuptools helpers. #4516
- C++
Published by henryiii about 3 years ago
pybind11 - Version 2.10.3
Changes:
- Temporarily made our GIL status assertions (added in 2.10.2) disabled by default (re-enable manually by defining
PYBIND11_ASSERT_GIL_HELD_INCREF_DECREF, will be enabled in 2.11). #4432 - Improved error messages when
inc_ref/dec_refare called with an invalid GIL state. #4427 #4436
Bug Fixes:
- Some minor touchups found by static analyzers. #4440
- C++
Published by henryiii over 3 years ago
pybind11 - Version 2.10.2
Changes:
scoped_interpreterconstructor takingPyConfig. #4372pybind11/eigen/tensor.hadds converters to and fromEigen::TensorandEigen::TensorMap#4201PyGILState_Check()'s were integrated topybind11::handleinc_ref()&dec_ref(). The added GIL checks are guarded byPYBIND11_ASSERT_GIL_HELD_INCREF_DECREF, which is the default only ifNDEBUGis not defined. #4246- Add option for enable/disable enum members in docstring. #2768
- Fixed typing of
KeysView,ValuesViewandItemsViewinbind_map. #4353
Bug fixes:
- Bug fix affecting only Python 3.6 under very specific, uncommon conditions: move
PyEval_InitThreads()call to the correct location. #4350 - Fix segfault bug when passing foreign native functions to functional.h. #4254
Build system improvements:
- Support setting PYTHON_LIBRARIES manually for Windows ARM cross-compilation (classic mode). #4406
- Extend IPO/LTO detection for ICX (a.k.a IntelLLVM) compiler. #4402
- Allow calling
find_package(pybind11 CONFIG)multiple times from separate directories in the same CMake project and properly link Python (new mode). #4401 multiprocessing_set_spawnin pytest fixture for added safety. #4377- Fixed a bug in two pybind11/tools cmake scripts causing "Unknown arguments specified" errors. #4327
- C++
Published by henryiii over 3 years ago
pybind11 - Version 2.10.1
This is the first version to fully support embedding the newly released Python 3.11.
Changes:
- Allow
pybind11::capsuleconstructor to take null destructor pointers. #4221 embed.hwas changed so thatPYTHONPATHis used also with Python 3.11 (established behavior). #4119- A
PYBIND11_SIMPLE_GIL_MANAGEMENToption was added (cmake, C++ define), along with many additional tests intest_gil_scoped.py. The option may be useful to try when debugging GIL-related issues, to determine if the more complex default implementation is or is not to blame. See #4216 for background. WARNING: Please be careful to not create ODR violations when using the option: everything that is linked together with mutual symbol visibility needs to be rebuilt. #4216 PYBIND11_EXPORT_EXCEPTIONwas made non-empty only under macOS. This makes Linux builds safer, and enables the removal of warning suppression pragmas for Windows. #4298
Bug fixes:
- Fixed a bug where
UnicodeDecodeErrorwas not propagated from variouspy::strctors when decoding surrogate utf characters. #4294 - Revert perfect forwarding for
make_iterator. This broke at least one valid use case. May revisit later. #4234 - Fix support for safe casts to
void*(regression in 2.10.0). #4275 - Fix
char8_tsupport (regression in 2.9). #4278 - Unicode surrogate character in Python exception message leads to process termination in
error_already_set::what(). #4297 - Fix MSVC 2019 v.1924 & C++14 mode error for
overload_cast. #4188 - Make augmented assignment operators non-const for the object-api. Behavior was previously broken for augmented assignment operators. #4065
- Add proper error checking to C++ bindings for Python list append and insert. #4208
- Work-around for Nvidia's CUDA nvcc compiler in versions 11.4.0 - 11.8.0. #4220
- A workaround for PyPy was added in the
py::error_already_setimplementation, related to PR #1895 released with v2.10.0. #4079 - Fixed compiler errors when C++23
std::forward_likeis available. #4136 - Properly raise exceptions in contains methods (like when an object in unhashable). #4209
- Further improve another error in exception handling. #4232
get_local_internals()was made compatible withfinalize_interpreter(), fixing potential freezes during interpreter finalization. #4192
Performance and style:
- Reserve space in set and STL map casters if possible. This will prevent unnecessary rehashing / resizing by knowing the number of keys ahead of time for Python to C++ casting. This improvement will greatly speed up the casting of large unordered maps and sets. #4194
- GIL RAII scopes are non-copyable to avoid potential bugs. #4183
- Explicitly default all relevant ctors for pytypes in the
PYBIND11_OBJECTmacros and enforce the clang-tidy checksmodernize-use-equals-defaultin macros as well. #4017 - Optimize iterator advancement in C++ bindings. #4237
- Use the modern
PyObject_GenericGetDictandPyObject_GenericSetDictfor handling dynamic attribute dictionaries. #4106 - Document that users should use
PYBIND11_NAMESPACEinstead of usingpybind11when opening namespaces. Using namespace declarations and namespace qualification remain the same aspybind11. This is done to ensure consistent symbol visibility. #4098 - Mark
detail::forward_likeas constexpr. #4147 - Optimize unpackingcollector when processing `argv` arguments. #4219
- Optimize casting C++ object to
None. #4269
Build system improvements:
- CMake: revert overwrite behavior, now opt-in with
PYBIND11_PYTHONLIBS_OVERRWRITE OFF. #4195 - Include a pkg-config file when installing pybind11, such as in the Python package. #4077
- Avoid stripping debug symbols when
CMAKE_BUILD_TYPEis set toDEBUGinstead ofDebug. #4078 - Followup to #3948, fixing vcpkg again. #4123
- C++
Published by henryiii over 3 years ago
pybind11 - Version 2.10.0
Removed support for Python 2.7, Python 3.5, and MSVC 2015. Support for MSVC 2017 is limited due to availability of CI runners; we highly recommend MSVC 2019 or 2022 be used. Initial support added for Python 3.11.
New features:
py::anyset&py::frozensetwere added, with copying (cast) tostd::set(similar toset). #3901- Support bytearray casting to string. #3707
type_caster<std::monostate>was added.std::monostateis a tag type that allowsstd::variantto act as an optional, or allows default construction of astd::variantholding a non-default constructible type. #3818pybind11::capsule::set_nameadded to mutate the name of the capsule instance. #3866- NumPy: dtype constructor from type number added, accessors corresponding to Python API
dtype.num,dtype.byteorder,dtype.flagsanddtype.alignmentadded. #3868
Changes:
- Python 3.6 is now the minimum supported version. #3688 #3719
- The minimum version for MSVC is now 2017. #3722
- Fix issues with CPython 3.11 betas and add to supported test matrix. #3923
error_already_setis now safer and more performant, especially for exceptions with long tracebacks, by delaying computation. #1895- Improve exception handling in python
strbindings. #3826 - The bindings for capsules now have more consistent exception handling. #3825
PYBIND11_OBJECT_CVTandPYBIND11_OBJECT_CVT_DEFAULTmacro can now be used to define classes in namespaces other than pybind11. #3797- Error printing code now uses
PYBIND11_DETAILED_ERROR_MESSAGESinstead of requiringNDEBUG, allowing use with release builds if desired. #3913 - Implicit conversion of the literal
0topybind11::handleis now disabled. #4008
Bug fixes:
- Fix exception handling when
pybind11::weakref()fails. #3739 module_::def_submodulewas missing proper error handling. This is fixed now. #3973- The behavior or
error_already_setwas made safer and the highly opaque "Unknown internal error occurred" message was replaced with a more helpful message. #3982 error_already_set::what()now handles non-normalized exceptions correctly. #3971- Support older C++ compilers where filesystem is not yet part of the standard library and is instead included in
std::experimental::filesystem. #3840 - Fix
-Wfree-nonheap-objectwarnings produced by GCC by avoiding returning pointers to static objects withreturn_value_policy::take_ownership. #3946 - Fix cast from pytype rvalue to another pytype. #3949
- Ensure proper behavior when garbage collecting classes with dynamic attributes in Python >=3.9. #4051
- A couple long-standing
PYBIND11_NAMESPACE__attribute__((visibility("hidden")))inconsistencies are now fixed (affects only unusual environments). #4043 pybind11::detail::get_internals()is now resilient to in-flight Python exceptions. #3981- Arrays with a dimension of size 0 are now properly converted to dynamic Eigen matrices (more common in NumPy 1.23). #4038
- Avoid catching unrelated errors when importing NumPy. #3974
Performance and style:
- Added an accessor overload of
(object &&key)to reference steal the object when using python types as keys. This prevents unnecessary reference count overhead for attr, dictionary, tuple, and sequence look ups. Added additional regression tests. Fixed a performance bug the caused accessor assignments to potentially perform unnecessary copies. #3970 - Perfect forward all args of
make_iterator. #3980 - Avoid potential bug in pycapsule destructor by adding an
error_guardto one of the dtors. #3958 - Optimize dictionary access in
strip_paddingfor numpy. #3994 stl_bind.hbindings now take slice args as a const-ref. #3852- Made slice constructor more consistent, and improve performance of some casters by allowing reference stealing. #3845
- Change numpy dtype from_args method to use const ref. #3878
- Follow rule of three to ensure
PyErr_Restoreis called only once. #3872 - Added missing perfect forwarding for
make_iteratorfunctions. #3860 - Optimize c++ to python function casting by using the rvalue caster. #3966
- Optimize Eigen sparse matrix casting by removing unnecessary temporary. #4064
- Avoid potential implicit copy/assignment constructors causing double free in
strdup_gaurd. #3905 - Enable clang-tidy checks
misc-definitions-in-headers,modernize-loop-convert, andmodernize-use-nullptr. #3881 #3988
Build system improvements:
- CMake: Fix file extension on Windows with cp36 and cp37 using FindPython. #3919
- CMake: Support multiple Python targets (such as on vcpkg). #3948
- CMake: Fix issue with NVCC on Windows. #3947
- CMake: Drop the bitness check on cross compiles (like targeting WebAssembly via Emscripten). #3959
- Add MSVC builds in debug mode to CI. #3784
- MSVC 2022 C++20 coverage was added to GitHub Actions, including Eigen. #3732, #3741
Backend and tidying up:
- New theme for the documentation. #3109
- Remove idioms in code comments. Use more inclusive language. #3809
#include <iostream>was removed from thepybind11/stl.hheader. Your project may break if it has a transitive dependency on this include. The fix is to "Include What You Use". #3928- Avoid
setup.py <command>usage in internal tests. #3734
- C++
Published by henryiii almost 4 years ago
pybind11 - Version 2.9.2
Changes:
- Enum now has an
__index__method on Python <3.8 too. #3700 - Local internals are now cleared after finalizing the interpreter. #3744
Bug fixes:
- Better support for Python 3.11 alphas. #3694
-
PYBIND11_TYPE_CASTERnow uses fully qualified symbols, so it can be used outside ofpybind11::detail. #3758 - Some fixes for PyPy 3.9. #3768
- Fixed a potential memleak in PyPy in
get_type_override. #3774 - Fix usage of
VISIBILITY_INLINES_HIDDEN. #3721
Build system improvements:
- Uses
sysconfigmodule to determine installation locations on Python >= 3.10, instead ofdistutilswhich has been deprecated. #3764 - Support Catch 2.13.5+ (supporting GLIBC 2.34+). #3679
- Fix test failures with numpy 1.22 by ignoring whitespace when comparing
str()of dtypes. #3682
Backend and tidying up:
- clang-tidy: added
readability-qualified-auto,readability-braces-around-statements,cppcoreguidelines-prefer-member-initializer,clang-analyzer-optin.performance.Padding,cppcoreguidelines-pro-type-static-cast-downcast, andreadability-inconsistent-declaration-parameter-name. #3702, #3699, #3716, #3709 - clang-format was added to the pre-commit actions, and the entire code base automatically reformatted (after several iterations preparing for this leap). #3713
- C++
Published by henryiii about 4 years ago
pybind11 - Version 2.9.1
Changes:
- If possible, attach Python exception with
py::raise_fromtoTypeErrorwhen casting from C++ to Python. This will give additional info if Python exceptions occur in the caster. Adds a test case of trying to convert a set from C++ to Python when the hash function is not defined in Python. #3605 - Add a mapping of C++11 nested exceptions to their Python exception equivalent using
py::raise_from. This attaches the nested exceptions in Python using the__cause__field. #3608 - Propagate Python exception traceback using
raise_fromif a pybind11 function runs out of overloads. #3671 -
py::multiple_inheritanceis now only needed when C++ bases are hidden from pybind11. #3650 and #3659
Bug fixes:
- Remove a boolean cast in
numpy.hthat causes MSVC C4800 warnings when compiling against Python 3.10 or newer. #3669 - Render
py::bool_andpy::float_asboolandfloatrespectively. #3622
Build system improvements:
- Fix CMake extension suffix computation on Python 3.10+. #3663
- Allow
CMAKE_ARGSto override CMake args in pybind11's ownsetup.py. #3577 - Remove a few deprecated c-headers. #3610
- More uniform handling of test targets. #3590
- Add clang-tidy readability check to catch potentially swapped function args. #3611
- C++
Published by henryiii over 4 years ago
pybind11 - Version 2.9.0
This is the last version to support Python 2.7 and 3.5.
New Features:
- Allow
py::argsto be followed by other arguments; the remaining arguments are implicitly keyword-only, as if apy::kw_only{}annotation had been used. #3402
Changes:
- Make str/bytes/memoryview more interoperable with
std::string_view. #3521 - Replace
_withconst_namein internals, avoid definingpybind::_if_defined as macro (common gettext usage) #3423
Bug fixes:
- Fix a rare warning about extra copy in an Eigen constructor. #3486
- Fix caching of the C++ overrides. #3465
- Add missing
std::forwardcalls to somecpp_functionoverloads. #3443 - Support PyPy 7.3.7 and the PyPy3.8 beta. Test python-3.11 on PRs with the
python devlabel. #3419 - Replace usage of deprecated
Eigen::MappedSparseMatrixwithEigen::Map<Eigen::SparseMatrix<...>>for Eigen 3.3+. #3499 - Tweaks to support Microsoft Visual Studio 2022. #3497
Build system improvements:
- Nicer CMake printout and IDE organisation for pybind11's own tests. #3479
- CMake: report version type as part of the version string to avoid a spurious space in the package status message. #3472
- Flags starting with
-gin$CFLAGSand$CPPFLAGSare no longer overridden by.Pybind11Extension. #3436 - Ensure ThreadPool is closed in
setup_helpers. #3548 - Avoid LTS on
mips64andppc64le(reported broken). #3557
- C++
Published by henryiii over 4 years ago
pybind11 - Version 2.8.1
v2.8.1 (Oct 27, 2021)
Changes and additions:
- The simple namespace creation shortcut added in 2.8.0 was deprecated due to usage of CPython internal API, and will be removed soon. Use py::module_::import("types").attr("SimpleNamespace"). #3374
- Add C++ Exception type to throw and catch AttributeError. Useful for defining custom __setattr__ and __getattr__ methods. #3387
Fixes:
- Fixed the potential for dangling references when using properties with std::optional types. #3376
- Modernize usage of PyCodeObject on Python 3.9+ (moving toward support for Python 3.11a1) #3368
- A long-standing bug in eigen.h was fixed (originally PR #3343). The bug was unmasked by newly added static_assert's in the Eigen 3.4.0 release. #3352
- Support multiple raw inclusion of CMake helper files (Conan.io does this for multi-config generators). #3420
- Fix harmless warning on upcoming CMake 3.22. #3368
- Fix 2.8.0 regression with MSVC 2017 + C++17 mode + Python 3. #3407
- Fix 2.8.0 regression that caused undefined behavior (typically segfaults) in make_key_iterator/make_value_iterator if dereferencing the iterator returned a temporary value instead of a reference. #3348
- C++
Published by rwgk over 4 years ago
pybind11 - Version 2.8.0
New features:
- Added
py::raise_fromto enable chaining exceptions. #3215 - Allow exception translators to be optionally registered local to a module instead of applying globally across all pybind11 modules. Use
register_local_exception_translator(ExceptionTranslator&& translator)instead ofregister_exception_translator(ExceptionTranslator&& translator)to keep your exception remapping code local to the module. #2650 - Add
make_simple_namespacefunction for instantiating PythonSimpleNamespaceobjects. #2840 -
pybind11::scoped_interpreterandinitialize_interpreterhave new arguments to allowsys.argvinitialization. #2341 - Allow Python builtins to be used as callbacks in CPython. #1413
- Added
viewto view arrays with a different datatype. #987 - Implemented
reshapeon arrays. #984 - Enable defining custom
__new__methods on classes by fixing bug preventing overriding methods if they have non-pybind11 siblings. #3265 - Add
make_value_iterator(), and fixmake_key_iterator()to return references instead of copies. #3293 - Improve the classes generated by
bind_map: #3310- Change
.itemsfrom an iterator to a dictionary view. - Add
.keysand.values(both dictionary views). - Allow
__contains__to take any object.
- Change
-
pybind11::custom_type_setupwas added, for customizing thePyHeapTypeObjectcorresponding to a class, which may be useful for enabling garbage collection support, among other things. #3287
Changes:
- Set
__file__constant when runningeval_filein an embedded interpreter. #3233 - Python objects and (C++17)
std::optionalnow accepted inpy::sliceconstructor. #1101 - The pybind11 proxy types
str,bytes,bytearray,tuple,listnow consistently support passingssize_tvalues for sizes and indexes. Previously, onlysize_twas accepted in several interfaces. #3219 - Avoid evaluating
PYBIND11_TLS_REPLACE_VALUEarguments more than once. #3290
Fixes:
- Bug fix: enum value's
__int__returning non-int when underlying type is bool or of char type #1334 - Fixes bug in setting error state in Capsule's pointer methods. #3261
- A long-standing memory leak in
py::cpp_function::initializewas fixed. #3229 - Fixes thread safety for some
pybind11::type_casterwhich require lifetime extension, such as forstd::string_view. #3237 - Restore compatibility with gcc 4.8.4 as distributed by ubuntu-trusty, linuxmint-17. #3270
Build system improvements:
- Fix regression in CMake Python package config: improper use of absolute path. #3144
- Cached Python version information could become stale when CMake was re-run with a different Python version. The build system now detects this and updates this information. #3299
- Specified UTF8-encoding in setup.py calls of open(). #3137
- Fix a harmless warning from CMake 3.21 with the classic Python discovery. #3220
- Eigen repo and version can now be specified as cmake options. #3324
Backend and tidying up:
- Reduced thread-local storage required for keeping alive temporary data for type conversion to one key per ABI version, rather than one key per extension module. This makes the total thread-local storage required by pybind11 2 keys per ABI version. #3275
- Optimize NumPy array construction with additional moves. #3183
- Conversion to
std::stringandstd::string_viewnow avoids making an extra copy of the data on Python >= 3.3. #3257 - Remove const modifier from certain C++ methods on Python collections (
list,set,dict) such as (clear(),append(),insert(), etc...) and annotated them withpy-non-const. - Enable readability
clang-tidy-const-returnand remove useless consts. #3254 #3194 - The clang-tidy
google-explicit-constructoroption was enabled. #3250 - Mark a pytype move constructor as noexcept (perf). #3236
- Enable clang-tidy check to guard against inheritance slicing. #3210
- Legacy warning suppression pragma were removed from eigen.h. On Unix platforms, please use -isystem for Eigen include directories, to suppress compiler warnings originating from Eigen headers. Note that CMake does this by default. No adjustments are needed for Windows. #3198
- Format pybind11 with isort consistent ordering of imports #3195
- The warnings-suppression "pragma clamp" at the top/bottom of pybind11 was removed, clearing the path to refactoring and IWYU cleanup. #3186
- Enable most bugprone checks in clang-tidy and fix the found potential bugs and poor coding styles. #3166
- Add
clang-tidy-readabilityrules to make boolean casts explicit improving code readability. Also enabled other misc and readability clang-tidy checks. #3148 - Move object in
.pop()for list. #3116
- C++
Published by henryiii over 4 years ago
pybind11 - Version 2.7.1
Minor missing functionality added:
- Allow Python builtins to be used as callbacks in CPython. #1413
Bug fixes:
- Fix regression in CMake Python package config: improper use of absolute path. #3144
- Fix Mingw64 and add to the CI testing matrix. #3132
- Specified UTF8-encoding in setup.py calls of open(). #3137
- Add clang-tidy-readability rules to make boolean casts explicit improving code readability. Also enabled other misc and readability clang-tidy checks. #3148
- Move object in
.pop()for list. #3116
Backend and tidying up:
- C++
Published by henryiii almost 5 years ago
pybind11 - Version 2.7.0
New features:
- Enable
py::implicitly_convertible<py::none, ...>forpy::class_-wrapped types. #3059 - Allow function pointer extraction from overloaded functions. #2944
- NumPy: added
.char_()to type which gives the NumPy publiccharresult, which also distinguishes types by bit length (unlike.kind()). #2864 - Add
pybind11::bytearrayto manipulatebytearraysimilar tobytes. #2799 -
pybind11/stl/filesystem.hregisters a type caster that, on C++17/Python 3.6+, convertsstd::filesystem::pathtopathlib.Pathand anyos.PathLiketostd::filesystem::path. #2730 - A
PYBIND11_VERSION_HEXdefine was added, similar toPY_VERSION_HEX. #3120
Changes:
-
py::strchanged to exclusively holdPyUnicodeObject. Previouslypy::strcould also holdbytes, which is probably surprising, was never documented, and can mask bugs (e.g. accidental use ofpy::strinstead ofpy::bytes). #2409 - Add a safety guard to ensure that the Python GIL is held when C++ calls back into Python via
object_api<>::operator()(e.g.py::function__call__). (This feature is available for Python 3.6+ only.) #2919 - Catch a missing
selfargument in calls to__init__(). #2914 - Use
std::string_viewif available to avoid a copy when passing an object to astd::ostream. #3042 - An important warning about thread safety was added to the
iostream.hdocumentation; attempts to makepy::scoped_ostream_redirectthread safe have been removed, as it was only partially effective. #2995
Fixes:
- Performance: avoid unnecessary strlen calls. #3058
- Fix auto-generated documentation string when using
const Tinpyarray_t. #3020 - Unify error messages thrown by
simple_collector/unpacking_collector. #3013 -
pybind11::builtin_exceptionis now explicitly exported, which means the types included/defined in different modules are identical, and exceptions raised in different modules can be caught correctly. The documentation was updated to explain that custom exceptions that are used across module boundaries need to be explicitly exported as well. #2999 - Fixed exception when printing UTF-8 to a
scoped_ostream_redirect. #2982 - Pickle support enhancement:
setstateimplementation will attempt tosetattr__dict__only if the unpickleddictobject is not empty, to not force use ofpy::dynamic_attr()unnecessarily. #2972 - Allow negative timedelta values to roundtrip. #2870
- Fix unchecked errors could potentially swallow signals/other exceptions. #2863
- Add null pointer check with
std::localtime. #2846 - Fix the
weakrefconstructor frompy::objectto create a newweakrefon conversion. #2832 - Avoid relying on exceptions in C++17 when getting a
shared_ptrholder from ashared_from_thisclass. #2819 - Allow the codec's exception to be raised instead of
RuntimeErrorwhen casting frompy::strtostd::string. #2903
Build system improvements:
- In
setup_helpers.py, test for platforms that have some multiprocessing features but lack semaphores, whichParallelCompilerequires. #3043 - Fix
pybind11_INCLUDE_DIRin caseCMAKE_INSTALL_INCLUDEDIRis absolute. #3005 - Fix bug not respecting
WITH_SOABIorWITHOUT_SOABIto CMake. #2938 - Fix the default
Pybind11Extensioncompilation flags with a Mingw64 python. #2921 - Clang on Windows: do not pass
/MP(ignored flag). #2824 -
pybind11.setup_helpers.intree_extensionscan be used to generatePybind11Extensioninstances from cpp files placed in the Python package source tree. #2831
Backend and tidying up:
- Enable clang-tidy performance, readability, and modernization checks throughout the codebase to enforce best coding practices. #3046, #3049, #3051, #3052, #3080, and #3094
- Checks for common misspellings were added to the pre-commit hooks. #3076
- Changed
Werrorto stricterWerror-allfor Intel compiler and fixed minor issues. #2948 - Fixed compilation with GCC < 5 when the user defines
_GLIBCXX_USE_CXX11_ABI. #2956 - Added nox support for easier local testing and linting of contributions. #3101 and #3121
- Avoid RTD style issue with docutils 0.17+. #3119
- Support pipx run, such as
pipx run pybind11 --includefor a quick compile. #3117
- C++
Published by henryiii almost 5 years ago
pybind11 - Version 2.6.2
Minor missing functionality added:
- enum: add missing Enum.value property. #2739
- Allow thread termination to be avoided during shutdown for CPython 3.7+ via
.disarmforgil_scoped_acquire/gil_scoped_release. #2657
Fixed or improved behavior in a few special cases:
- Fix bug where the constructor of
objectsubclasses would not throw on being passed a Python object of the wrong type. #2701 - The
type_casterfor integers does not convert Python objects with__int__anymore withnoconvertor during the first round of trying overloads. #2698 - When casting to a C++ integer,
__index__is always called and not considered as conversion, consistent with Python 3.8+. #2801
Build improvements:
- Setup helpers:
extra_compile_argsandextra_link_argsautomatically set by Pybind11Extension are now prepended, which allows them to be overridden by user-setextra_compile_argsandextra_link_args. #2808 - Setup helpers: Don\'t trigger unused parameter warning. #2735
- CMake: Support running with
--warn-uninitializedactive. #2806 - CMake: Avoid error if included from two submodule directories. #2804
- CMake: Fix
STATIC/SHAREDbeing ignored in FindPython mode. #2796 - CMake: Respect the setting for
CMAKE_CXX_VISIBILITY_PRESETif defined. #2793 - CMake: Fix issue with FindPython2/FindPython3 not working with
pybind11::embed. #2662 - CMake: mixing local and installed pybind11\'s would prioritize the installed one over the local one (regression in 2.6.0). #2716
Bug fixes:
- Fixed segfault in multithreaded environments when using
scoped_ostream_redirect. #2675 - Leave docstring unset when all docstring-related options are disabled, rather than set an empty string. #2745
- The module key in builtins that pybind11 uses to store its internals changed from std::string to a python str type (more natural on Python 2, no change on Python 3). #2814
- Fixed assertion error related to unhandled (later overwritten) exception in CPython 3.8 and 3.9 debug builds. #2685
- Fix
py::gil_scoped_acquireassert with CPython 3.9 debug build. #2683 - Fix issue with a test failing on PyTest 6.2. #2741
Warning fixes:
- Fix warning modifying constructor parameter \'flag\' that shadows a field of \'set_flag\'
[-Wshadow-field-in-constructor-modified]. #2780 - Suppressed some deprecation warnings about old-style
__init__/__setstate__in the tests. #2759
Valgrind work:
- Fix invalid access when calling a pybind11
__init__on a non-pybind11 class instance. #2755 - Fixed various minor memory leaks in pybind11\'s test suite. #2758
- Resolved memory leak in cpp_function initialization when exceptions occurred. #2756
- Added a Valgrind build, checking for leaks and memory-related UB, to CI. #2746
Compiler support:
- Intel compiler was not activating C++14 support due to a broken define. #2679
- Support ICC and NVIDIA HPC SDK in C++17 mode. #2729
- Support Intel OneAPI compiler (ICC 20.2) and add to CI. #2573
- C++
Published by henryiii over 5 years ago
pybind11 - Version 2.6.1
py::exec,py::eval, andpy::eval_filenow add the builtins module as"__builtins__"to theirglobalsargument, better matchingexecandevalin pure Python. #2616setup_helperswill no longer set a minimum macOS version higher than the current version. #2622- Allow deleting static properties. #2629
- Seal a leak in
def_buffer, cleaning up thecaptureobject after theclass_object goes out of scope. #2634 pybind11_INCLUDE_DIRSwas incorrect, potentially causing a regression if it was expected to includePYTHON_INCLUDE_DIRS(please use targets instead). #2636- Added parameter names to the
py::enum_constructor and methods, avoidingarg0in the generated docstrings. #2637 - Added
needs_recompileoptional function to theParallelCompilerhelper, to allow a recompile to be skipped based on a user-defined function. #2643
- C++
Published by henryiii over 5 years ago
pybind11 - Version 2.6.0
New features:
- Keyword-only arguments supported in Python 2 or 3 with
py::kw_only(). #2100 - Positional-only arguments supported in Python 2 or 3 with
py::pos_only(). #2459 -
py::is_final()class modifier to block subclassing (CPython only). #2151 - Added
py::prepend(), allowing a function to be placed at the beginning of the overload chain. #1131 - Access to the type object now provided with
py::type::of<T>()andpy::type::of(h). #2364 - Perfect forwarding support for methods. #2048
- Added
py::error_already_set::discard_as_unraisable(). #2372 -
py::hashis now public. #2217 -
py::class_<union_type>is now supported. Note that writing to one data member of the union and reading another (type punning) is UB in C++. Thus pybind11-bound enums should never be used for such conversions. #2320. - Classes now check local scope when registering members, allowing a subclass to have a member with the same name as a parent (such as an enum). #2335
Code correctness features:
- Error now thrown when
__init__is forgotten on subclasses. #2152 - Throw error if conversion to a pybind11 type if the Python object isn't a valid instance of that type, such as
py::bytes(o)whenpy::object oisn't a bytes instance. #2349 - Throw if conversion to
strfails. #2477
API changes:
-
py::modulewas renamedpy::module_to avoid issues with C++20 when used unqualified, but an aliaspy::moduleis provided for backward compatibility. #2489 - Public constructors for
py::module_have been deprecated; please usepybind11::module_::create_extension_moduleif you were using the public constructor (fairly rare afterPYBIND11_MODULEwas introduced). #2552 -
PYBIND11_OVERLOAD*macros andget_overloadfunction replaced by correctly-namedPYBIND11_OVERRIDE*andget_override, fixing inconsistencies in the presence of a closing;in these macros.get_type_overloadis deprecated. #2325
Packaging / building improvements:
- The Python package was reworked to be more powerful and useful. #2433
-
build-setuptoolsis easier thanks to a newpybind11.setup_helpersmodule, which provides utilities to use setuptools with pybind11. It can be used via PEP 518,setup_requires, or by directly importing or copyingsetup_helpers.pyinto your project. - CMake configuration files are now included in the Python package. Use
pybind11.get_cmake_dir()orpython -m pybind11 --cmakedirto get the directory with the CMake configuration files, or include the site-packages location in yourCMAKE_MODULE_PATH. Or you can use the newpybind11[global]extra when you installpybind11, which installs the CMake files and headers into your base environment in the standard location. -
pybind11-configis another way to writepython -m pybind11if you have your PATH set up. - Added external typing support to the helper module, code from
import pybind11can now be type checked. #2588
-
- Minimum CMake required increased to 3.4. #2338 and #2370
- Full integration with CMake's C++ standard system and compile features replaces
PYBIND11_CPP_STANDARD. - Generated config file is now portable to different Python/compiler/CMake versions.
- Virtual environments prioritized if
PYTHON_EXECUTABLEis not set (venv,virtualenv, andconda) (similar to the new FindPython mode). - Other CMake features now natively supported, like
CMAKE_INTERPROCEDURAL_OPTIMIZATION,set(CMAKE_CXX_VISIBILITY_PRESET hidden). -
CUDAas a language is now supported. - Helper functions
pybind11_strip,pybind11_extension,pybind11_find_importadded, seecmake/index. - Optional
find-python-modeandnopython-modewith CMake. #2370
- Full integration with CMake's C++ standard system and compile features replaces
- Uninstall target added. #2265 and #2346
-
pybind11_add_module()now accepts an optionalOPT_SIZEflag that switches the binding target to size-based optimization if the global build type can not always be fixed toMinSizeRel(except in debug mode, where optimizations remain disabled).MinSizeRelor this flag reduces binary size quite substantially (~25% on some platforms). #2463
Smaller or developer focused features and fixes:
- Moved
mkdoc.pyto a new repo, pybind11-mkdoc. There are no longer submodules in the main repo. -
py::memoryviewsegfault fix and update, with newpy::memoryview::from_memoryin Python 3, and documentation. #2223 - Fix for
buffer_infoon Python 2. #2503 - If
__eq__defined but not__hash__,__hash__is now set toNone. #2291 -
py::ellipsisnow also works on Python 2. #2360 - Pointer to
std::tuple&std::pairsupported in cast. #2334 - Small fixes in NumPy support.
py::arraynow usespy::ssize_tas first argument type. #2293 - Added missing signature for
py::array. #2363 -
unchecked_mutable_referencehas access to operator()and[]when const. #2514 -
py::vectorizeis now supported on functions that return void. #1969 -
py::capsulesupportsget_pointerandset_pointer. #1131 - Fix crash when different instances share the same pointer of the same type. #2252
- Fix for
py::lennot clearing Python's error state when it fails and throws. #2575 - Bugfixes related to more extensive testing, new GitHub Actions CI. #2321
- Bug in timezone issue in Eastern hemisphere midnight fixed. #2438
-
std::chrono::time_pointnow works when the resolution is not the same as the system. #2481 - Bug fixed where
py::array_tcould accept arrays that did not match the requested ordering. #2484 - Avoid a segfault on some compilers when types are removed in Python. #2564
py::arg::none()is now also respected when passing keyword arguments. #2611- PyPy fixes, PyPy 7.3.x now supported, including PyPy3. (Known issue with PyPy2 and Windows #2596). #2146
- CPython 3.9.0 workaround for undefined behavior (macOS segfault). #2576
- CPython 3.9 warning fixes. #2253
- Improved C++20 support, now tested in CI. #2489 #2599
- Improved but still incomplete debug Python interpreter support. #2025
- NVCC (CUDA 11) now supported and tested in CI. #2461
- NVIDIA PGI compilers now supported and tested in CI. #2475
- At least Intel 18 now explicitly required when compiling with Intel. #2577
- Extensive style checking in CI, with pre-commit support. Code modernization, checked by clang-tidy.
- Expanded docs, including new main page, new installing section, and CMake helpers page, along with over a dozen new sections on existing pages.
- In GitHub, new docs for contributing and new issue templates.
- C++
Published by henryiii over 5 years ago
pybind11 - Version 2.6.0 RC 3
Next release candidate.
- Factory constructor scope fix
- Support for PyPy3 on Windows 32, added to CI
- Fixes for C++20, added to CI for Clang, GCC, and MSVC 2019
- Black formatting for all Python code
- Allow ABI string overrides from 2.4 (advanced)
- C++
Published by henryiii over 5 years ago
pybind11 - Version 2.6.0 RC 2
Next release candidate. Changes since RC 1:
Fixed:
- Python 3.9.0 bug workaround implemented
- Better support in CMake for packing and cross-compiling
- Fix for failing
py::lenleaving error state set - Intel 18+ explicitly required, an issue with Intel compilers fixed
- Custom ipo flags disabled with
RelWithDebInfo(useCMAKE_INTERPROCEDURAL_OPTIMIZATIONfor more control) - Possible duplicate linker flags fixed in
setup_helpers - Changes to
py::module_constructor are no longer provisional.
New features:
- Static typing support for
import pybind11
- C++
Published by henryiii over 5 years ago
pybind11 - Version 2.6.0 RC 1
This is the first release candidate for pybind11 2.6.0. Please see the new features in the changelog, such as revamped CMake and setuptools support, keyword and positional argument support, and a long list of features, fixes, and improvements. Full Python 3.9 support and enhanced C++20 support.
Known issues:
py::module_direct construction provisionally deprecated- Removing registered types can cause a segfault - old issue exposed by recent test additions; fix incoming
- On Python 3.9.0 and macOS, pybind11 may segfault when closing the interpreter after running the test suite
- C++
Published by henryiii over 5 years ago