.. _changelog: .. cpp:namespace:: nanobind Changelog ######### nanobind uses a `semantic versioning `__ policy for its API. It also has a separate ABI version that is *not* subject to semantic versioning. The ABI version is relevant whenever a type binding from one extension module should be visible in another nanobind-based extension module. In this case, both modules must use the same nanobind ABI version, or they will be isolated from each other. Releases that don't explicitly mention an ABI version below inherit that of the preceding release. Version 2.12.0 (Feb 25, 2025) ----------------------------- - Added :cpp:class:`nb::memoryview` that wraps the Python ``memoryview`` type. (PR `#1291 `__). - Made stub generation compatible with the Realtime Sanitizer (RTSan) from Clang 20. (PR `#1285 `__). - Fixed a use-after-free when calling functions after their module has been deleted. The internals state is now reference-counted with references held by modules, functions, and types. This also fixes memory leaks reported in issue `#957 `__. (PR `#1287 `__). - Fixed two regressions from v2.11.0 related to the implicit ``std::optional`` :cpp:func:`.none() ` annotation: an off-by-one error that applied the annotation to the wrong argument for methods, and a missing ``convert`` flag that silently disabled implicit type conversions. (issues `#1281 `__, `#1293 `__, commits `ed7ab31 `__, `1f96278 `__). - ABI version 19. Version 2.11.0 (Jan 29, 2026) ----------------------------- - This release improves binding performance using CPython's *adaptive specializing interpreter* (`PEP 659 `__). The speedups are automatic and require no changes to binding code: .. list-table:: :header-rows: 1 * - Operation - Speedup - Requirements * - Method calls - **1.22x** faster - Python 3.11+ * - Static attribute lookups - **1.63x** faster - Python 3.14+ This was achieved by making a number of nanobind-internal classes (``nb_func``, ``nb_method``, ``nb_meta``, etc.) immutable, which allows CPython to specialize generic ``LOAD_ATTR`` opcodes to faster type-specific versions (``LOAD_ATTR_METHOD`` for method calls, ``LOAD_ATTR_CLASS`` for static attribute lookups). (PR `#1257 `__). - Added the :cpp:class:`nb::never_destruct ` class binding annotation to inform nanobind that it should not bind the destructor. (PR `#1251 `__, commit `4ba51f `__). - Argument annotations for ``std::optional``-typed arguments now implicitly have the :cpp:func:`.none() ` annotation applied (i.e., no need to additionally specify ``nb::arg("..").none()``). (PR `#1262 `__, commit `425ca1 `__). - Removed a redundant hash table type, reducing the size of libnanobind by 2.5KiB. (commit `4d53cd `__). - Added Python 3.12-3.14 symbols to linker scripts. (commit `36d4a6 `__). - Fixed a bug where ``call_guard`` could cause an extra copy of the return value. (PR `#1249 `__). - Don't link ``nb_ft.cpp`` in non-free-threaded builds to avoid linker warnings about empty compilation units. (PR `#1271 `__). - ABI version 18. - **Eigen type caster improvements**: - Fixed conversion of size-zero vectors to ``Eigen::Map``/``Eigen::Ref`` on NumPy 2.4. (PR `#1268 `__). - Fixed move construction of dense Eigen arrays. (commit `cb90753 `__). - **Stub generation improvements**: - Fixed *O(n²)* string concatenation performance issue. (PR `#1275 `__). - Fixed enumerations with entries named ``name`` or ``value``. (issue `#1246 `__). - Stubgen now preserves module-level docstrings. (commit `88771b `__). - Extended the skip list by two additional enum attributes. (PR `#1255 `__). Version 2.10.2 (Dec 10, 2025) ----------------------------- - Fixes a regression that broke compilation on 32-bit architectures. (PR `#1239 `__). Version 2.10.1 (Dec 8, 2025) ---------------------------- - Nanobind now officially supports the **MinGW-w64** and **Intel ICX** compilers. (PR `#1188 `__). - Version 2.10 drops support for Python 3.8, which reached *End-Of-Life* in October 2025. (PR `#1236 `__). - The new :cpp:class:`nb::array_api ` framework tag can be used to create an nd-array wrapper object that supports both the Python buffer protocol and the DLPack methods ``__dlpack__`` and ``__dlpack_device__``. Furthermore, nanobind now supports importing/exporting tensors via the legacy (unversioned) DLPack interface, as well a new versioned interface. The latter provides a flag indicating whether an nd-array is read-only. (PR `#1175 `__). - Added ``bfloat`` to the nd-array import conversion code, fixing imports of bfloat16 tensors. (PR `#1228 `__). - nanobind now uses per-module precomputed constants, particularly strings, to avoid costs from creating these repeatedly. This improves the performance of nd-array and enumeration casts. (PR `#1184 `__). - Fixed a segfault in garbage collection traversal of Python subclasses of class bindings with :cpp:class:`nb::is_weak_referenceable `. (PR `#1206 `__). - Fixed a potential reference leak in the ``std::array`` type caster. (commit `bfacaf7 `__). - STL type casters now directly reject incorrectly sized inputs, which avoids performance pitfalls when passing large arrays. (commit `edf5753 `__, `dc35d69 `__). - Fixed ``__new__`` overloads with variadic positional arguments but no variadic keyword arguments, which incorrectly prevented nullary calls. (PR `#1172 `__). - Removed zero-length arrays to improve compiler compatibility. (PR `#1158 `__). - Fixed a data race related caused by writes to a bit-field in free-threaded extension builds (PR `#1191 `__) - ABI version 17. - **Stub generation improvements**: - Added a new ``--exclude-values`` flag that forces all values to be rendered as ``...`` in stub files. (PR `#1185 `__). - Added support for ``typing.ParamSpec`` in generated stubs. (PR `#1194 `__). - NumPy boolean arrays now use ``np.bool_`` dtype in generated stubs instead of deprecated alternatives. (commit `20fab93 `__). - Auto-generated enum APIs are now excluded from stub files. (PR `#1182 `__). - Pattern files now support ``__prefix__`` and ``__suffix__`` patterns within classes for further customization of class stubs. (PR `#1235 `__). - Various minor improvements to the stub generator. (PR `#1179 `__). - Fixed a regression in 2.10.0 (yanked release) related to handling of the ``NB_USE_SUBMODULE_DEPS`` flag that could cause CMake build system failures (commit `06aaa3 `__). - Minor/miscellaneous fixes: PRs `#1157 `__, `#1186 `__, `#1193 `__, `#1198 `__, `#1212 `__, `#1218 `__, `#1223 `__, `#1225 `__, commit `cf289b `__. Version 2.10.0 (Dec 8, 2025) ---------------------------- This release was yanked due to a regression. Version 2.9.2 (Sep 4, 2025) --------------------------- This is a patch release to fix an issue in the new recursive stub generation feature: - When creating stubs for a module, the generator must decide whether to store declarations locally (e.g., in ``foo.pyi``) or in a subdirectory (e.g., in ``foo/__init__.pyi``). The latter is necessary, e.g., when ``foo`` contains submodules. However, the implemented submodule test was far too conservative and interpreted any imported module (e.g. ``import os``) as a submodule. The patch release fixes this. (commit `a65e1b `__). Version 2.9.1 (Sep 4, 2025) --------------------------- This is a patch release to fix a regression in the CMake build system: - nanobind 2.9.0 internally adopted the CMake command ``cmake_path()`` to normalize paths. This was done for cosmetic reasons, since it improves the readability of generated commands. However, ``cmake_path()`` is only available on CMake 3.20+, while nanobind officially supports CMake 3.15+. Version 2.9.1 removes the full path normalization. (commit `f703fd `__). Version 2.9.0 (Sep 4, 2025) --------------------------- - Nanobind's CMake stub generation command :cmake:command:`nanobind_add_stub` can now automatically traverse submodule hierarchies and generate :ref:`many stub files at once `. (PR `#1148 `__). - Recursive stub generation now correctly organizes stub files hierarchically (e.g. ``my_ext.pyi`` versus ``my_ext/__init__.pyi``). (commits `ad9d3fe `__, `620c1c1 `__). - The stub generator now exposes NumPy array types as ``NDArray[np.float32]`` (or similar) instead of ``Annotated[ArrayLike, dict(...)]`` to simplify type-checking. (PR `#1149 `__, commit `37dd2c `__). - Nanobind (finally!) correctly implements in-place updates to dicts, lists, etc. Previously, a C++ operation like .. code-block:: cpp nb::dict my_dict = ...; my_dict["key"] += 1; performed an addition but failed to reassign the updated value to the original key. (PR `#1119 `__). - When cast operations like :cpp:func:`nb::cast() ` fail to convert a value, they previously raised a generic ``std::bad_cast`` exception that loses the context of why the cast failed. When a Python error status is available, they now preferentially raise :cpp:class:`nb::python_error `. This helps to track down issues with default argument conversion. (PR `#1137 `__). - Miscellaneous minor fixes and improvements. (PRs `#1092 `__, `#1107 `__, `#1120 `__, `#1124 `__. `#1128 `__, `#1135 `__, `#1138 `__, `#1142 `__, commits `d99b3f3 `__, `0147904 `__). - Minor documentation tweaks. (PRs `#1109 `__, `#1108 `__, `#1114 `__, `#1117 `__, `#1134 `__, `#1132 `__, `#1090 `__). Version 2.8.0 (July 16, 2025) ----------------------------- - Added :cpp:class:`nb::fallback ` wrapper type, which is a :cpp:class:`nb::handle ` that always requires implicit conversion during casting. This is convenient when adding catch-all overloads that must handle arbitrary Python objects, without interfering with implicit conversion of arguments in other overloads. - The ``nanobind::literals`` namespace now includes ``_s`` to create a Python string from source code literals. (PR `#1051 `__). - Added the convenience methods :cpp:func:`nb::dict::empty() `, :cpp:func:`nb::list::empty() `, :cpp:func:`nb::set::empty() `, and :cpp:func:`nb::tuple::empty() `. (PR `#1052 `__) - Added a :cpp:func:`nb::dict::get() ` function to perform dictionary lookups with a fallback value in case of failures. (commit `d38284 `__). - Nanobind now uses multi-phase (as opposed to single-phase) initialization API when registering modules. However, multi-interpreter extensions remain unsupported. (PR `#1059 `__). - Added :cpp:class:`nb::frozenset ` that wraps the Python ``frozenset`` type. (PR `#1068 `__) - Miscellaneous fixes and improvements (commits `d4b245 `__, `667451 `__, `62fc99 `__, `8497f7 `__). Version 2.7.0 (Apr 18, 2025) ---------------------------- - nanobind now provides a zero-copy type caster for ``Eigen::Map``. (PRs `#1003 `__, `#782 `__). - Made handling of return value policies in Eigen type casters more consistent with the rest of nanobind. (Issue `#971 `__, commit `5cdf59 `__). - The Eigen sparse matrix caster now correctly handles ``scipy.sparse`` objects with unsorted indices. (PR `#981 `__). - Nanobind's CMake stub generation command :cmake:command:`nanobind_add_stub` now detects when an extension uses sanitizers (TSAN, ASAN, UBSAN). It then injects the sanitizer library into the Python process ahead of time so that the extension can be loaded. Previously, stub generation failed in such cases. (PR `#1000 `__). - The entries of stub files are now sorted in their original definition order. Previously, they were alphabetically sorted, which caused issues with external tooling. (PR `#938 `__). - Fixed detection and handling of imports and types in external modules in stubgen that could lead to incorrect declarations in some cases. (PRs `#939 `__, `#940 `__). - The stub generator now detects method aliases and preserves this information instead of duplicating the definition. (PR `#735 `__). - Corrected a flaw in the recommended implementation of ``tp_traverse`` in garbage-collected bindings. (PRs `#1015 `__). - Added support for binding functions that accept a ``std::variant<...>`` that is not default-constructible (because its first alternative isn't). (PR `#987 `__). - Added support for casting const-qualified ``std::unique_ptr`` values. (PR `#988 `__). - ``nb::typed`` now supports construction from ``T``, making it more ergonomic to return values with type annotations. (PR `#1012 `__ - Miscellaneous fixes and improvements (PRs `#1014 `__, `#1005 `__, `#1004 `__, `#990 `__, `#997 `__, commits `f2b08c `__, `eef931 `__, `f1b2f5 `__, `dbd602 `__, `2c83fb `__, `87de84 `__). Version 2.6.1 (Mar 28, 2025) ---------------------------- - nanobind assigns an ABI tag to compiled extensions and uses it to isolate incompatible extensions from each other. This tag was unnecessarily fine-grained, often causing isolation where an actual ABI compatibility was not present. This release updates the tagging scheme to address this long-standing inconvenience. (PR `#778 `__). - Added specialized function dispatchers to accelerate calls to 0 and 1-argument functions. (PR `#944 `__). - Improved the efficiency of :cpp:func:`nb::getattr(obj, key, default) ` in cases where ``obj[key]`` does not exist. (commit `bb05f5 `__). - ABI version 16. - Miscellaneous fixes and improvements (PRs `#913 `__, `#914 `__, `#916 `__, `#931 `__, `#978 `__, commit `1595d2 `__). Version 2.6.0 (Mar 28, 2025) ---------------------------- - This release was yanked due to a regression. Version 2.5.0 (Feb 2, 2025) --------------------------- - Added :cpp:class:`nb::def_visitor\<..\> `, which can be used to define your own binding logic that operates on a :cpp:class:`nb::class_\<..\> ` when an instance of the visitor object is passed to :cpp:func:`class_::def()`. This generalizes the mechanism used by :cpp:class:`init`, :cpp:class:`new_`, etc, so that you can create binding abstractions that "feel like" the built-in ones. (PR `#884 `__) - Added some special forms for :cpp:class:`nb::typed\ ` (PR `#835 `__): - ``nb::typed`` or ``nb::typed`` produces a parameter or return value that will be described like ``T`` in function signatures but accepts any Python object at runtime. - ``nb::typed`` produces a Python callable signature ``Callable[[Args...], R]``; similarly, ``nb::typed`` (with a literal ellipsis) produces the Python ``Callable[..., R]``. - It is now possible to create Python subclasses of C++ classes that define their constructor bindings using :cpp:struct:`nb::new_() `. Previously, attempting to instantiate such a Python subclass would instead produce an instance of the base C++ type. Note that it is still not possible to override virtual methods in such a Python subclass, because the object returned by the :cpp:struct:`new_() ` constructor will generally not be an instance of the alias/trampoline type. (PR `#859 `__) - Fixed the :cpp:class:`nb::int_ ` constructor so that it casts to an integer when invoked with a floating point argument. - Multi-level inheritance (e.g., ``A → B → C``) previously did not work on Python 3.12+ when a base class (e.g., ``A``) provided a trampoline implementation. This is now fixed. (commit `92d9cb `__). - A new ``NB_SUPPRESS_WARNINGS`` parameter of :cmake:command:`nanobind_add_module` that marks the nanobind and Python include directories as `SYSTEM `__ include directories, which suppresses any potential warning messages originating there. This is mainly of relevance for projects that artificially raise the warning level using flags like ``-pedantic``, ``-Wcast-qual``, ``-Wsign-conversion``. (PR `#868 `__). - Fixed (benign) reference leaks that could occur when ``std::shared_ptr`` instances were still alive at interpreter shutdown time. (commit `fb8157 `__). - The floating-point type caster now only performs value-changing narrowing conversions during the implicit conversion phase. They can be entirely avoided by passing the :cpp:func:`.noconvert() ` argument annotation. (PR `#829 `__) - The ``std::complex`` type caster now only performs value-changing narrowing conversions during the implicit conversion phase. They can be entirely avoided by passing the :cpp:func:`.noconvert() ` argument annotation. Also, during the implicit conversion phase, if the Python object is not a complex number object but has a ``__complex__()`` method, it will be called. (PR `#854 `__) - Fixed an overly strict check that could cause a function taking an :cpp:class:`nb::ndarray\<...\> ` to refuse specific types of column-major input without implicit conversion. (PR `#847 `__, commit `b95eb7 `__). Fixes for free-threaded builds ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Fixed a race condition in free-threaded extensions that could occur when :cpp:func:`nb::make_iterator ` was concurrently used by multiple threads. (PR `#832 `__). - Fixed a race condition in free-threaded extensions that could occur when multiple threads access the Python object associated with the same C++ instance, which does not exist yet and therefore must be created. (issue `#867 `__, PR `#887 `__). - Removed double-checked locking patterns in accesses to internal data structures to ensure correct free-threaded behavior on architectures with weak memory ordering such as ARM (PR `#819 `__). Version 2.4.0 (Dec 6, 2024) --------------------------- - Added a function annotation :cpp:class:`nb::call_policy\() ` which supports custom function wrapping logic, calling ``Policy::precall()`` before the bound function and ``Policy::postcall()`` after. This is a low-level interface intended for advanced users. The precall and postcall hooks are able to observe the Python objects forming the function arguments and return value, and the precall hook can change the arguments. See the linked documentation for more details, important caveats, and an example policy. (PR `#767 `__) - :cpp:func:`nb::make_iterator ` now accepts its iterator arguments by value, rather than by forwarding reference, in order to eliminate the hazard of storing a dangling C++ iterator reference in the returned Python iterator object. (PR `#788 `__) - The ``std::variant`` type_caster now does two passes when converting from Python. The first pass is done without implicit conversions. This fixes an issue where ``std::variant`` might cast a Python object wrapping a ``T`` to a ``U`` if there is an implicit conversion available from ``T`` to ``U``. (issue `#769 `__) - Restored support for constructing types with an overloaded ``__new__`` that takes no arguments, which regressed with the constructor vector call acceleration that was added in nanobind 2.2.0. (issue `#786 `__) - Bindings for augmented assignment operators (as generated, for example, by ``.def(nb::self += nb::self)``) now return the same object in Python in the typical case where the C++ operator returns a reference to ``*this``. Previously, after ``a += b``, ``a`` would be replaced with a copy. (PR `#803 `__) - Added an overload to :cpp:func:`nb::isinstance ` which tests if a Python object is an instance of a Python class. This is in addition to the existing overload, which tests if a Python object is an instance of a bound C++ class. (PR `#805 `__). - Added support for overriding static properties, such as those defined using ``def_prop_ro_static``, in subclasses. Previously this would fail with an error. (PR `#806 `__). - Other minor fixes and improvements. (PRs `#771 `__, `#772 `__, `#748 `__, and `#753 `__) Version 2.3.0 ------------- There is no version 2.3.0 due to a deployment mishap. - Added casters for ``Eigen::Map>`` types from the `Eigen library `__. (PR `#782 `_). Version 2.2.0 (October 3, 2024) ------------------------------- - nanobind can now target `free-threaded Python `__, which replaces the `Global Interpreter Lock (GIL) `__ with a fine-grained locking scheme (see `PEP 703 `__) to better leverage multi-core parallelism. A :ref:`separate documentation page ` explains this in detail (PRs `#695 `__, `#720 `__) - nanobind has always used `PEP 590 vector calls `__ to efficiently dispatch calls to function and method bindings, but it lacked the ability to do so for constructors (e.g., ``MyType(arg1, arg2, ...)``). Version 2.2.0 adds this missing part, which accelerates object construction by up to a factor of 2×. The difference is especially pronounced when passing keyword arguments to constructors. Note that this improvement only applies to Python version 3.9 and newer (PR `#706 `__, commits `#e24d7f `__, `#0acecb `__, `#77f910 `__, `#2c96d5 `__). * A new :cpp:class:`nb::is_flag() ` annotation in :cpp:class:`nb::enum_\() ` produces enumeration bindings deriving from :py:class:`enum.Flag`, which enables bit-wise combination using compatible operators (``&``, ``|``, ``^``, and ``~``). Further combining the annotation with :cpp:class:`nb::is_arithmetic() ` creates enumerations deriving from :py:class:`enum.IntFlag`. (PRs `#599 `__, `#688 `__, `#688 `__, `#727 `__, `#732 `__) * A refactor of :cpp:class:`nb::ndarray\<...\> ` was an opportunity to realize three usability improvements: 1. The constructor used to return new nd-arrays from C++ now considers all template arguments: - **Memory order**: :cpp:class:`c_contig`, :cpp:class:`f_contig`. - **Shape**: :cpp:class:`nb::shape\<3, 4, 5\> `, etc. - **Device type**: :cpp:class:`nb::device::cpu `, :cpp:class:`nb::device::cuda `, etc. - **Framework**: :cpp:class:`nb::numpy `, :cpp:class:`nb::pytorch `, etc. - **Data type**: ``uint64_t``, ``std::complex``, etc. Previously, only the **framework** and **data type** annotations were taken into account when returning nd-arrays, while all of them were examined when *accepting* arrays during overload resolution. This inconsistency was a repeated source of confusion among users. To give an example, the following now works out of the box without the need to redundantly specify the shape and strides to the ``Array`` constructor below: .. code-block:: cpp using Array = nb::ndarray, nb::f_contig>; struct Matrix4f { float m[4][4]; Array data() { return Array(m); } }; nb::class_(m, "Matrix4f") .def("data", &Matrix4f::data, nb::rv_policy::reference_internal); 2. A new nd-array :cpp:func:`.cast() ` method forces the immediate creation of a Python object with the specified target framework and return value policy, while preserving the type signature in return values. This is useful to :ref:`return temporaries (e.g. stack-allocated memory) ` from functions. 3. Added a new and more general mechanism ``nanobind::detail::dtype_traits`` to declare custom ndarray data types like ``float16`` or ``bfloat16``. The old interface (``nanobind::ndarray_traits``) still exists but is deprecated and will be removed in the next major release. See the :ref:`documentation ` for details. There are two minor but potentially breaking changes: 1. The nd-array type caster now interprets the :cpp:enumerator:`nb::rv_policy::automatic_reference ` return value policy analogously to the :cpp:enumerator:`nb::rv_policy::automatic `, which means that it references a memory region when the user specifies an ``owner``, and it otherwise copies. This makes it safe to use the :cpp:func:`nb::cast() ` and :cpp:func:`nb::ndarray::cast() ` functions that use this policy as a default. 2. The :cpp:class:`nb::any_contig ` memory order annotation, which previously did nothing, now accepts C- or F-contiguous arrays and rejects non-contiguous ones. For further details on the nd-array changes, see PR `#721 `__, For further details on the nd-array changes, see PR `#742 `__, and commit `4647ef `__. - The NVIDIA CUDA compiler (``nvcc``) is now explicitly supported and included in nanobind's CI test suite (PR `#710 `__). * Added support for return value policy customization to the type casters of ``Eigen::Ref<...>`` and ``Eigen::Map<...>`` (commit `67316e `__). * Added the :cpp:class:`bytearray` wrapper type. (PR `#654 `__) * The :cpp:class:`nb::ellipsis ` type now renders as ``...`` when used in :cpp:class:`nb::typed\<...\> ` (PR `#705 `__). * The :cpp:class:`nb::sig("...") ` annotation now supports `inline type parameter lists `__ such as ``def first[T](l: Sequence[T]) -> T`` (PR `#704 `__). * Fixed implicit conversion of complex nd-arrays. (issue `#709 `__) * Casting via :cpp:func:`nb::cast ` can now specify an owner object for use with the :cpp:enumerator:`nb::rv_policy::reference_internal ` return value policy (PR `#667 `__). * The ``std::optional`` type caster is now implemented in such a way that it can also accommodate non-STL frameworks, such as Boost, Abseil, etc. (PR `#675 `__) * ABI version 15. * Minor fixes and improvements (PRs `#703 `__, `#724 `__, `#723 `__, `#722 `__, `#715 `__, `#696 `__, `#693 `__, commit `75d259 `__). Version 2.1.0 (Aug 11, 2024) ---------------------------- * Temporary workaround for a internal compiler error in version 17.10 of the MSVC compiler. This workaround will be removed once fixed versions are deployed on GitHub actions. (issue `#613 `__, commit `f2438b `__). * nanobind no longer prevents casting to a C++ container of pointers ``T*`` where ``T`` is a type with a user-defined type caster if the caster seems to operate by extracting a ``T*`` from the Python object rather than a ``T``. This change was prompted by discussion `#605 `__. * Switched nanobind wheel generation from `setuptools `__ to `scikit-build-core `__ (PR `#618 `__). * Improved handling of ``const``-ness in :cpp:class:`nb::ndarray ` (PR `#491 `__). * Keyword argument annotations are now properly supported with :cpp:struct:`nb::new_ `, passed in the same way they would be with :cpp:struct:`nb::init `. (issue `#668 `__) * Ability to use :cpp:func:`nb::cast ` to create object with the :cpp:enumerator:`nb::rv_policy::reference_internal ` return value policy (PR `#667 `__). * Enable ``char`` type caster to produce ``'\0'`` (PR `#661 `__). * Added ``.def_static()`` member to :cpp:class:`nb::enum_ `, which had been lost in a redesign of the enumeration implementation in nanobind version 2.0.0. (commit `38990e `__). * Fixes for two minor sources of memory leaks (PR `#595 `__, `#647 `__). * The nd-array wrapper :cpp:class:`nb::ndarray ` now properly handles CuPy arrays (`#594 `__). * Added :cpp:func:`nb::hash() `, a wrapper for the Python ``hash()`` function (commit `91fafa5 `__). * Various minor ``stubgen`` fixes (PRs `#667 `__, `#658 `__, `#632 `__, `#620 `__, `#592 `__). Version 2.0.0 (May 23, 2024) ---------------------------- The 2.0.0 release of nanobind is entirely dedicated to *types* [#f1]_! The project has always advertised seamless Python ↔ C++ interoperability, and this release tries to bring a similar level of interoperability to static type checkers like `MyPy `__, `PyRight `__, `PyType `__, and editors with interactive autocompletion like `Visual Studio Code `__, `PyCharm `__, and many other `LSP `__-compatible IDEs. This required work on three fronts: 1. **Stub generation**: the above tools all analyze Python code statically without running it. Because the import mechanism of compiled extensions depends the Python interpreter, these tools weren't able to inspect the contents of nanobind-based extensions. The usual solution involves writing `stubs `__ that expose the module contents to static analysis tools. However, writing stubs by hand is tedious and error-prone. This release adds tooling to automatically extract stubs from existing extensions. The process is fully integrated into the CMake-based build system and explained in a :ref:`new documentation section `. 2. **Better default annotations**: once stubs were available, this revealed the next problem: the default nanobind-provided function and class signatures were too rudimentary, and this led to a user poor experience. The release therefore improves many builtin type caster so that they produce more accurate type signatures. For example, the STL ``std::vector`` caster now renders as ``collections.abc.Sequence[T]`` in stubs when it is used as an *input*, and ``list[T]`` when it is used as part of a return value. The :cpp:func:`nb::make_*_iterator() ` family of functions return typed iterators, etc. 3. **Advanced customization**: a subset of the type signatures in larger binding projects will generally require further customization. The features listed below aim to enable precisely this: * In Python, many built-in types are *generic* and can be *parameterized* (e.g., ``list[int]``). The :cpp:class:`nb::typed\ ` wrapper enables such parameterization within C++ (for example, the ``int``-specialized list would be written as ``nb::typed``). :ref:`Read more `. * The opposite is also possible: passing :cpp:class:`nb::is_generic() ` to the class binding constructor .. code-block:: cpp nb::class_(m, "MyType", nb::is_generic()) produces a *generic* type that can be parameterized in Python (e.g. ``MyType[int]``). :ref:`Read more `. * The :cpp:class:`nb::sig ` annotation overrides the signature of a function or method, e.g.: .. code-block:: cpp m.def("f", &f, nb::sig("def f(x: Foo = Foo(0)) -> None"), "docstring"); Each binding of an overloaded function can be customized separately. This feature can be used to add decorators or control how default arguments are rendered. :ref:`Read more `. * The :cpp:class:`nb::sig ` annotation can also override *class signatures* in generated stubs. Stubs often take certain liberties in deviating somewhat from the precise type signature of the underlying implementation. For example, the following annotation adds an abstract base class advertising that the class implements a typed iterator. .. code-block:: cpp using IntVec = std::vector; nb::class_(m, "IntVec", nb::sig("class IntVec(collections.abc.Iterable[int])")); Nanobind can't subclass Python types, hence this declaration is technically untrue. On the flipside, such a declaration can assist static checkers and improve auto-completion in visual IDEs. This is fine since these tools only perform a static analysis and never import the actual extension. :ref:`Read more `. * The :cpp:struct:`nb::for_setter ` and :cpp:struct:`nb::for_getter ` annotations enable passing function binding annotations (e.g., signature overrides) specifically to the setter or the getter part of a property. * The :cpp:class:`nb::arg("name") ` argument annotation (and ``"name"_a`` shorthand) now have a :cpp:func:`.sig("signature") ` member to control how a default value is rendered in the stubs and docstrings. This provides more targeted control compared to overriding the entire function signature. * Finally, nanobind's stub generator supports :ref:`pattern files ` containing custom stub replacement rules. This catch-all solution addresses the needs of advanced binding projects, for which the above list of features may still not be sufficient. Most importantly, it was possible to support these improvements with minimal changes to the core parts of nanobind. These release breaks API and ABI compatibility, requiring a new major version according to `SemVer `__. The following changes are noteworthy: * The :cpp:class:`nb::enum_\() ` binding declaration is now a wrapper that creates either a :py:class:`enum.Enum` or :py:class:`enum.IntEnum`-derived type. Previously, nanobind relied on a custom enumeration base class that was a frequent source of friction for users. This change may break code that casts entries to integers, which now only works for arithmetic (:py:class:`enum.IntEnum`-derived) enumerations. Replace ``int(my_enum_entry)`` with ``my_enum_entry.value`` to work around the issue. * The :cpp:func:`nb::bind_vector\() ` and :cpp:func:`nb::bind_map\() ` interfaces were found to be severely flawed since element access (``__getitem__``) created views into the internal state of the STL type that were not stable across subsequent modifications. This could lead to unexpected changes to array elements and undefined behavior when the underlying storage was reallocated (i.e., use-after-free). nanobind 2.0.0 improves these types so that they are safe to use, but this means that element access must now copy by default, potentially making them less convenient. The documentation of :cpp:func:`nb::bind_vector\() ` discusses the issue at length and presents alternative solutions. * The functions :cpp:func:`nb::make_iterator() `, :cpp:func:`nb::make_value_iterator() ` and :cpp:func:`nb::make_key_iterator() ` suffer from the same issue as :cpp:func:`nb::bind_vector() ` explained above. nanobind 2.0.0 improves these operations so that they are safe to use, but this means that iterator access must now copy by default, potentially making them less convenient. The documentation of :cpp:func:`nb::make_iterator() ` discusses the issue and presents alternative solutions. * The ``nb::raw_doc`` annotation was found to be too inflexible and was removed in this version. * The ``nb::typed`` wrapper listed above actually already existed in previous nanobind versions but was awkward to use, as it required the user to provide a custom type formatter. This release makes the interface more convenient. * The ``nb::any`` placeholder to specify an unconstrained :cpp:class:`nb::ndarray ` axis was removed. This name was given to a new wrapper type :cpp:class:`nb::any` indicating ``typing.Any``-typed values. All use of ``nb::any`` in existing code must be replaced with ``-1`` (for example, ``nb::shape<3, nb::any, 4>`` → ``nb::shape<3, -1, 4>``). * :ref:`Keyword-only arguments ` are now supported, and can be indicated using the new :cpp:struct:`nb::kw_only() ` function annotation. (PR `#448 `__). * nanobind classes now permit overriding ``__new__``, in order to support C++ singletons, caches, and other types that expose factory functions rather than ordinary constructors. Read the section on :ref:`customizing Python object creation ` for more details. (PR `#473 `__). * When binding methods on a class ``T``, nanobind will now produce a Python function that expects a self argument of type ``T``. Previously, it would use the type of the member pointer to determine the Python function signature, which could be a base of ``T``, which would create problems if nanobind did not know about that base. (PR `#471 `__). * nanobind can now handle keyword arguments that are not interned, which avoids spurious ``TypeError`` exceptions in constructs like ``fn(**pickle.loads(...))``. The speed of normal function calls (which generally do have interned keyword arguments) should be unaffected. (PR `#469 `__). * The ``owner=nb::handle()`` default value of the :cpp:class:`nb::ndarray ` constructor was removed since it was bug-prone. You now have to specify the owner explicitly. The previous default (``nb::handle()``) continues to be a valid argument. * There have been some changes to the API for type casters in order to avoid undefined behavior in certain cases. (PR `#549 `__). * Type casters that implement custom cast operators must now define a member function template ``can_cast()``, which returns false if ``operator cast_t()`` would raise an exception and true otherwise. ``can_cast()`` will be called only after a successful call to ``from_python()``, and might not be called at all if the caller of ``operator cast_t()`` can cope with a raised exception. (Users of the ``NB_TYPE_CASTER()`` convenience macro need not worry about this; it produces cast operators that never raise exceptions, and therefore provides a ``can_cast()`` that always returns true.) * Many type casters for container types (``std::vector``, ``std::optional``, etc) implement their ``from_python()`` methods by delegating to another, "inner" type caster (``T`` in these examples) that is allocated on the stack inside ``from_python()``. Container casters implemented in this way should make two changes in order to take advantage of the new safety features: * Wrap your ``flags`` (received as an argument of the outer caster's ``from_python`` method) in ``flags_for_local_caster()`` before passing them to ``inner_caster.from_python()``. This allows nanobind to prevent some casts that would produce dangling pointers or references. * If ``inner_caster.from_python()`` succeeds, then also verify ``inner_caster.template can_cast()`` before you execute ``inner_caster.operator cast_t()``. A failure of ``can_cast()`` should be treated the same as a failure of ``from_python()``. This avoids the possibility of an exception being raised through the noexcept ``load_python()`` method, which would crash the interpreter. The previous ``cast_flags::none_disallowed`` flag has been removed; it existed to avoid one particular source of exceptions from a cast operator, but ``can_cast()`` now handles that problem more generally. * ABI version 14. .. rubric:: Footnote .. [#f1] The author of this library had somewhat of a revelation after switching to a `new editor `__ and experiencing the benefits of interactive Python code completion and type checking for the first time. This experience also showed how nanobind-based extension were previously a second-class citizen in this typed world, prompting the changes in this release. Version 1.9.2 (Feb 23, 2024) ---------------------------- * Nanobind instances can now be :ref:`made weak-referenceable ` by specifying the :cpp:class:`nb::is_weak_referenceable ` tag in the :cpp:class:`nb::class_\<..\> ` constructor. (PR `#335 `__, commits `fc7709 `__, `3562f6 `__). * Added a :cpp:class:`nb::bool_ ` wrapper type. (PR `#382 `__, commit `90dfba `__). * Ensure that the GIL is held when releasing :cpp:class:`nb::ndarray `. (issue `#377 `__, commit `a968e8 `__). * :cpp:func:`nb::try_cast() ` no longer crashes the interpreter when attempting to cast a Python ``None`` to a C++ type that was bound using :cpp:class:`nb::class_\<...\> `. Previously this would raise an exception from the cast operator, which would result in a call to ``std::terminate()`` because :cpp:func:`try_cast() ` is declared ``noexcept``. (PR `#386 `__). * Fixed memory corruption in a PyPy-specific code path in :cpp:func:`nb::module_::def_submodule() ` (commit `21eaff `__). * Don't implicitly convert complex to non-complex nd-arrays. (issue `#364 `__, commit `ea2569 `__). * Support for non-assignable types in the ``std::optional`` type caster (PR `#358 `__, commit `9c9b64 `__). * nanobind no longer assumes that docstrings provided to function binding (of type ``const char *``) have an infinite lifetime and it makes copy. (issue `#393 `__, commit `b3b6f4 `__). * Don't pass compiler flags if they may be unsupported by the used compiler. This gets NVCC to work out of the box (that said, this change does not elevate NVCC to being an *officially* supported compiler). (issue `#383 `__, commit `a307ea `__). * Added a CMake install target to the nanobind build system. (PR `#356 `__, commit `6bde65 `__, commit `978dbb `__, commit `f5d8de `__). * ABI version 13. * Minor fixes and improvements. Version 1.9.0-1.9.1 (Feb 18, 2024) ---------------------------------- Releases withdrawn because of a regression. The associated changes are listed above in the 1.9.2 release notes. Version 1.8.0 (Nov 2, 2023) --------------------------- * nanobind now considers two C++ ``std::type_info`` instances to be equal when their mangled names match. The previously used pointer comparison was fast but fragile and often caused multi-part extensions to not recognize each other's types. This version introduces a two-level caching scheme (search by pointer, then by name) to fix such problems once and for all, while avoiding the cost of constantly comparing very long mangled names. (commit `b515b1 `__). * Fixed casting of complex-valued constant :cpp:class:`nb::ndarray\ ` instances. (PR `#338 `__, commit `ba8c7f `__). * Added a type caster for ``std::nullopt_t`` (PR `#350 `__). * Added the missing C++ → Python portion of the type caster for ``Eigen::Ref<..>`` (PR `#334 `__). * Minor fixes and improvements. * ABI version 12. Version 1.7.0 (Oct 19, 2023) ---------------------------- New features ^^^^^^^^^^^^ * The nd-array class :cpp:class:`nb::ndarray\ ` now supports complex-valued ``T`` (e.g., ``std::complex``). For this, the header file ``nanobind/stl/complex.h`` must be included. (PR `#319 `__, commit `6cbd13 `__). * Added the function :cpp:func:`nb::del() `, which takes an arbitrary accessor object as input and tries to delete the associated entry. The C++ statement .. code-block:: cpp nb::del(o[key]); is equivalent to ``del o[key]`` in Python. (commit `4dd745 `__). * Exposed several convenience functions for raising exceptions as public API: :cpp:func:`nb::raise `, :cpp:func:`nb::raise_type_error `, and :cpp:func:`nb::raise_python_error `. (commit `0b7f3b `__). * Added :cpp:func:`nb::globals() `. (PR `#311 `__, commit `f0a9eb `__). * The ``char*`` type caster now accepts ``nullptr`` and converts it into a Python ``None`` object. (PR `#318 `__, commit `30a6ba `__). * Added the function :cpp:func:`nb::is_alive() `, which returns ``false`` when nanobind was destructed by Python (e.g., during interpreter shutdown) making further use of the API illegal. (commit `b431d0 `__). * Minor fixes and improvements. * ABI version 11. Bugfixes ^^^^^^^^ * The behavior of the :cpp:class:`nb::keep_alive\ ` function binding annotation was changed as follows: when the function call requires the implicit conversion of an argument, the lifetime constraint now applies to the newly produced argument instead of the original object. The change was rolled into a minor release since the former behavior is arguably undesirable and dangerous. (commit `9d4b2e `__). * STL type casters previously raised an exception when casting a Python container containing a ``None`` element into a C++ container that was not able to represent ``nullptr`` (e.g., ``std::vector`` instead of ``std::vector``). However, this exception was raised in a context where exceptions were not allowed, causing the process to be ``abort()``-ed, which is very bad. This issue is now fixed, and such conversions are refused. (PR `#318 `__, commits `d1ad3b `__ and `5f25ae `__). * The STL sequence casters (``std::vector``, etc.) now refuse to unpack ``str`` and ``bytes`` objects analogous to pybind11. (commit `7e4a88 `__). Version 1.6.2 (Oct 3, 2023) --------------------------- * Added a missing include file used by the new intrusive reference counting sample implementation from v1.6.0. (commit `31d115 `__). Version 1.6.1 (Oct 2, 2023) --------------------------- * Added missing namespace declaration to the :cpp:class:`ref` intrusive reference counting RAII helper class added in version 1.6.0. (commit `3ba352 `__). Version 1.6.0 (Oct 2, 2023) --------------------------- New features ^^^^^^^^^^^^ * Several :cpp:class:`nb::ndarray\<..\> ` improvements: 1. CPU loops involving nanobind nd-arrays weren't getting properly vectorized. This release of nanobind adds *views*, which provide an efficient abstraction that enables better code generation. See the documentation section on :ref:`array views ` for details. (commit `8f602e `__). 2. Added support for nonstandard arithmetic types (e.g., ``__int128`` or ``__fp16``) in nd-arrays. See the :ref:`documentation section ` for details. (commit `49eab2 `__). 3. Shape constraints like :cpp:class:`nb::shape\ ` are tedious to write. Now, there is a shorter form: :cpp:class:`nb::ndim\<3\> `. (commit `1350a5 `__). 4. Added an explicit constructor that can be used to add or remove nd-array constraints. (commit `a1ac207 `__). * Added the wrapper class :cpp:class:`nb::weakref `. (commit `78887f `__). * Added the methods :cpp:func:`nb::dict::contains() ` and :cpp:func:`nb::mapping::contains() ` to the Python type wrappers. (commit `64d87a `__). * Added :cpp:func:`nb::exec() ` and :cpp:func:`nb:eval() `. (PR `#299 `__). * Added a type caster for ``std::complex``. (PR `#292 `__, commit `dcbed4 `__). * Added an officially supported sample implementation of :ref:`intrusive reference counting ` via the :cpp:class:`intrusive_counter` :cpp:class:`intrusive_base`, and :cpp:class:`ref` classes. (commit `3fa1af `__). Bugfixes ^^^^^^^^ * Fixed a serious issue involving combinations of bound types (e.g., ``T``) and type casters (e.g., ``std::vector``), where nanobind was too aggressive in its use of *move semantics*. Calling a bound function from Python taking such a list (e.g., ``f([t1, t2, ..])``) would destruct ``t1, t2, ..`` if the type ``T`` exposed a move constructor, which is highly non-intuitive and no longer happens as of this fix. Further investigation also revealed inefficiencies in the previous implementation where moves were actually possible but not done (e.g., for functions taking an STL vector by value). Some binding projects may see speedups as a consequence of this change. (issue `#307 `__, commit `122015 `__). Version 1.5.2 (Aug 24, 2023) ---------------------------- * Fixed a severe issue with inheritance of the ``Py_TPFLAGS_HAVE_GC`` flag affecting classes that derive from other classes with a :cpp:class:`nb::dynamic_attr ` annotation. (issue `#279 `__, commit `dbedad `__). * Implicit conversion of nd-arrays to conform to contiguity constraints such as :cpp:class:`c_contig` and :cpp:class:`f_contig` previously failed in some cases that are now addressed. (issue `#278 `__ commit `ed929b `__). Version 1.5.1 (Aug 23, 2023) ---------------------------- * Fixed serious reference counting issue introduced in nanobind version 1.5.0, which affected the functions :cpp:func:`python_error::traceback()` and :cpp:func:`python_error::what()`, causing undefined behavior via use-after-free. Also addressed an unrelated minor UB sanitizer warning. (issue `#277 `__, commits `30d30c `__ and `c48b18 `__). * Extended the internal data structure tag so that it isolates different MSVC versions from each other (they are often not ABI compatible, see pybind11 issue `#4779 `__). This means that nanobind 1.5.1 effectively bumps the ABI version to "10.5" when compiling for MSVC, and the internals will be isolated from extensions built with nanobind v1.5.0 or older. (commit `c7f3cd `__). * Incorporated fixes so that nanobind works with PyPy 3.10. (commits `fb5508 `__ and `2ed10a `__). * Fixed type caster for ``std::vector``. (PR `#256 `__). * Fixed compilation in debug mode on MSVC. (PR `#253 `__). Version 1.5.0 (Aug 7, 2023) --------------------------- * Support for creating :ref:`chained exceptions ` via the :cpp:func:`nb::raise_from() ` and :cpp:func:`nb::chain_error() ` functions. (commits `041520 `__ and `beb699 `__). * Many improvements to the handling of return value policies in :cpp:class:`nb::ndarray\<..\> ` to avoid unnecessary copies. (commit `ffd22b `__, `a79575 `__, and `6f0c3f `__). * The :cpp:class:`nb::ndarray\<..\> ` class now has an additional convenience constructor that takes the shape and (optionally) strides using ``std::initializer_list``. (commit `de1117 `__). * Added a non-throwing function :cpp:func:`nb::try_cast() ` as an alternative to :cpp:func:`nb::cast() `. (commit `6ca852 `__). * The ``nb::list`` and ``nb::tuple`` default constructors now construct an empty list/tuple instead of an invalid null-initialized handle. (commit `506185 `__) * New low-level interface for wrapping existing C++ instances via :cpp:func:`nb::inst_take_ownership() ` :cpp:func:`nb::inst_reference() `. Also added convenience functions to replace the contents of an instance with that of another. :cpp:func:`nb::inst_replace_copy() ` along with :cpp:func:`nb::inst_replace_move() ` (commit `1c462d `__). * Added a low-level abstraction around :cpp:func:`nb::type_get_slot() ` around ``PyType_GetSlot``, but with more consistent behavior across Python versions. (commit `d555e9 `__). * The :cpp:func:`nb::list::append() ` method now performs perfect forwarding. (commit `2219d0 `__). * Inference of ``automatic*`` return value policy was entirely moved to the base C++ class type caster. (commit `1ff9df `__). * Switch to the new Python 3.12 error status API if available. (commit `36751c `__). * Various minor fixes and improvements. * ABI version 10. Version 1.4.0 (June 8, 2023) ---------------------------- * Improved the efficiency of the function dispatch loop. (PR `#227 `__). * Significant improvements to the Eigen type casters (generalized stride handling to avoid unnecessary copies, support for conversion via ``nb::cast()``, many refinements to the ``Eigen::Ref`` interface). (PR `#215 `__). * Added a ``NB_DOMAIN`` parameter to :cmake:command:`nanobind_add_module` which can isolate extensions from each other to avoid binding clashes. See the associated :ref:`FAQ entry ` for details. (commit `977119 `__). * Reduced the severity of nanobind encountering a duplicate type binding (commits `f3b0e6 `__, and `2c9124 `__). * Support for pickling/unpickling nanobind objects. (commit `59843e `__). * ABI version 9. Version 1.3.2 (June 2, 2023) ---------------------------- * Fixed compilation on 32 bit processors (only ``i686`` tested so far). (PR `#224 `__). * Fixed compilation on PyPy 3.8. (commit `cd8135 `__). * Reduced binary bloat of musllinux wheels. (commit `f52513 `__). Version 1.3.1 (May 31, 2023) ---------------------------- * CMake build system improvements for stable ABI wheel generation. (PR `#222 `__). Version 1.3.0 (May 31, 2023) ---------------------------- This is a big release. The sections below cover added features, efficiency improvements, and miscellaneous fixes and improvements. New features ^^^^^^^^^^^^ * nanobind now supports binding types that inherit from ``std::enable_shared_from_this``. See the :ref:`advanced section on object ownership ` for more details. (PR `#212 `__). * Added a type caster between Python ``datetime``/``timedelta`` objects and C++ ``std::chrono::duration``/``std::chrono::time_point``, ported from pybind11. (PR `#175 `__). * The :cpp:class:`nb::ndarray\<..\> ` class can now use the buffer protocol to receive and return arrays representing read-only memory. (PR `#217 `__). * Added :cpp:func:`nb::python_error::discard_as_unraisable() ` as a wrapper around ``PyErr_WriteUnraisable()``. (PR `#175 `__). Efficiency improvements: ^^^^^^^^^^^^^^^^^^^^^^^^ * Reduced the per-instance overhead of nanobind by 1 pointer and simplified the internal hash table types to crunch ``libnanobind``. (commit `de018d `__). * Supplemental type data specified via :cpp:class:`nb::supplement\() ` is now stored directly within the type object instead of being referenced through an indirection. (commit `d82ca9 `__). * Reduced the number of exception-related exports to further crunch ``libnanobind``. (commit `763962 `__). * Reduced the size of nanobind type objects by 5 pointers. (PR `#194 `__, `#195 `__, and commit `d82ca9 `__). * Internal nanobind types (``nb_type``, ``nb_static_property``, ``nb_ndarray``) are now constructed on demand. This reduces the size of the ``libnanobind`` component in static (``NB_STATIC``) builds when those features are not used. (commits `95e45a `__, `375083 `__, and `e033c8 `__). * Added a small function cache to improve code generation in limited API builds. (commit `f0f4aa `__). * Refined compiler and linker flags across platforms to ensure compact binaries especially in ``NB_STATIC`` builds. (commit `5ead9f `__) * nanobind enums now take advantage of :ref:`supplemental data ` to improve the speed of object and name lookups. Note that this prevents use of ``nb::supplement()`` with enums for other purposes. (PR `#195 `__). Miscellaneous fixes and improvements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Use the new `PEP-697 `__ interface to access data in type objects when compiling stable ABI3 wheels. This improves forward compatibility (the Python team may at some point significantly refactor the layout and internals of type objects). (PR `#211 `__): * Added introspection attributes ``__self__`` and ``__func__`` to nanobind bound methods, to make them more like regular Python bound methods. Fixed a bug where ``some_obj.method.__call__()`` would behave differently than ``some_obj.method()``. (PR `#216 `__). * Updated the implementation of :cpp:class:`nb::enum_ ` so it does not take advantage of any private nanobind type details. As a side effect, the construct ``nb::class_(..., nb::is_enum(...))`` is no longer permitted; use ``nb::enum_(...)`` instead. (PR `#195 `__). * Added the :cpp:class:`nb::type_slots_callback` class binding annotation, similar to :cpp:class:`nb::type_slots` but allowing more dynamic choices. (PR `#195 `__). * nanobind type objects now treat attributes specially whose names begin with ``@``. These attributes can be set once, but not rebound or deleted. This safeguard allows a borrowed reference to the attribute value to be safely stashed in the type supplement, allowing arbitrary Python data associated with the type to be accessed without a dictionary lookup while keeping this data visible to the garbage collector. (PR `#195 `__). * Fixed surprising behavior in enumeration comparisons and arithmetic (PR `#207 `__): * Enum equality comparisons (``==`` and ``!=``) now can only be true if both operands have the same enum type, or if one is an enum and the other is an ``int``. This resolves some confusing results and ensures that enumerators of different types have a distinct identity, which is important if they're being put into the same set or used as keys in the same dictionary. All of the following were previously true but will now evaluate as false: * ``FooEnum(1) == BarEnum(1)`` * ``FooEnum(1) == 1.2`` * ``FooEnum(1) == "1"`` * Enum ordering comparisons (``<``, ``<=``, ``>=``, ``>``) and arithmetic operations (when using the :cpp:struct:`is_arithmetic` annotation) now require that any non-enum operand be a Python number (an object that defines ``__int__``, ``__float__``, and/or ``__index__``) and will avoid truncating non-integer operands to integers. Note that unlike with equality comparisons, ordering and arithmetic operations *do* still permit two operands that are enums of different types. Some examples of changed behavior: * ``FooEnum(1) < 1.2`` is now true (used to be false) * ``FooEnum(2) * 1.5`` is now 3.0 (used to be 2) * ``FooEnum(3) - "2"`` now raises an exception (used to be 1) * Enum comparisons and arithmetic operations with unsupported types now return `NotImplemented` rather than raising an exception. This means equality comparisons such as ``some_enum == None`` will return unequal rather than failing; order comparisons such as ``some_enum < None`` will still fail, but now with a more informative error. * ABI version 8. Version 1.2.0 (April 24, 2023) ------------------------------ * Improvements to the internal C++ → Python instance map data structure to improve performance and address type confusion when returning previously registered instances. (commit `716354 `__, discussion `189 `__). * Added up-to-date nanobind benchmarks on Linux including comparisons to Cython. (commit `834cf3 `__ and `39e163 `__). * Removed the superfluous ``nb_enum`` metaclass. (commit `9c1985 `__). * Fixed a corner case that prevented ``nb::cast`` from working. (commit `9ae320 `__). Version 1.1.1 (April 6, 2023) ----------------------------- * Added documentation on packaging and distributing nanobind modules. (commit `0715b2 `__). * Made the conversion :cpp:func:`handle::operator bool() ` explicit. (PR `#173 `__). * Support :cpp:class:`nb::typed\<..\> ` in return values. (PR `#174 `__). * Tweaks to definitions in ``nb_types.h`` to improve compatibility with further C++ compilers (that said, there is no change about the official set of supported compilers). (commit `b8bd10 `__) Version 1.1.0 (April 5, 2023) ----------------------------- * Added :cpp:func:`size `, :cpp:func:`shape_ptr `, :cpp:func:`stride_ptr ` members to to the :cpp:class:`nb::ndarray\<..\> ` class. (PR `#161 `__). * Allow macros in :c:macro:`NB_MODULE(..) ` name parameter. (PR `#168 `__). * The :cpp:class:`nb::ndarray\<..\> ` interface is more tolerant when converting Python (PyTorch/NumPy/..) arrays with a size-0 dimension that have mismatched strides. (PR `#162 `__). * Removed the ```` label from docstrings of anonymous functions, which caused issues in MyPy. (PR `#172 `__). * Fixed an issue in the propagation of return value policies that broke user-provided/custom policies in properties (PR `#170 `__). * The Eigen interface now converts 1x1 matrices to 1x1 NumPy arrays instead of scalars. (commit `445781 `__). * The ``nanobind`` package now has a simple command line interface. (commit `d5ccc8 `__). Version 1.0.0 (March 28, 2023) ------------------------------ * Nanobind now has a logo. (commit `b65d31 `__). * Fixed a subtle issue involving function/method properties and the IPython command line interface. (PR `#151 `__). * Added a boolean type to the :cpp:class:`nb::ndarray\<..\> ` interface. (PR `#150 `__). * Minor fixes and improvements. Version 0.3.1 (March 8, 2023) ----------------------------- * Added a type caster for ``std::filesystem::path``. (PR `#138 `__ and commit `0b05cd `__). * Fixed technical issues involving implicit conversions (commits `022935 `__ and `5aefe3 `__) and construction of type hierarchies with custom garbage collection hooks (commit `022935 `__). * Re-enabled the 'chained fixups' linker optimization for recent macOS deployment targets. (commit `2f29ec `__). Version 0.3.0 (March 8, 2023) ----------------------------- * Botched release, replaced by 0.3.1 on the same day. Version 0.2.0 (March 3, 2023) ----------------------------- * Nanobind now features documentation on `readthedocs `__. * The documentation process revealed a number of inconsistencies in the :cpp:func:`class_\::def* ` naming scheme. nanobind will from now on use the following shortened and more logical interface: .. list-table:: :widths: 40 60 :header-rows: 1 * - Type - method * - Methods & constructors - :cpp:func:`.def() ` * - Fields - :cpp:func:`.def_ro() `, :cpp:func:`.def_rw() ` * - Properties - :cpp:func:`.def_prop_ro() `, :cpp:func:`.def_prop_rw() ` * - Static methods - :cpp:func:`.def_static() ` * - Static fields - :cpp:func:`.def_ro_static() `, :cpp:func:`.def_rw_static() ` * - Static properties - :cpp:func:`.def_prop_ro_static() `, :cpp:func:`.def_prop_rw_static() ` Compatibility wrappers with deprecation warnings were also added to help port existing code. They will be removed when nanobind reaches version 1.0. (commits `cb0dc3 `__ and `b5ed96 `__) * The ``nb::tensor<..>`` class has been renamed to :cpp:class:`nb::ndarray\<..\> `, and it is now located in a different header file (``nanobind/ndarray.h``). A compatibility wrappers with a deprecation warning was retained in the original header file. It will be removed when nanobind reaches version 1.0. (commit `a6ab8b `__). * Dropped the first two arguments of the :c:macro:`NB_OVERRIDE_*() ` macros that turned out to be unnecessary in nanobind. (commit `22bc21 `__). * Added casters for dense matrix/array types from the `Eigen library `__. (PR `#120 `__). * Added casters for sparse matrix/array types from the `Eigen library `__. (PR `#126 `_). * Implemented `nb::bind_vector\() ` analogous to similar functionality in pybind11. (commit `f2df8a `__). * Implemented :cpp:func:`nb::bind_map\() ` analogous to similar functionality in pybind11. (PR `#114 `__). * nanobind now :ref:`automatically downcasts ` polymorphic objects in return values analogous to pybind11. (commit `cab96a `__). * nanobind now supports :ref:`tag-based polymorphism `. (commit `6ade94 `__). * Updated tuple/list iterator to satisfy the ``std::forward_iterator`` concept. (PR `#117 `__). * Fixed issues with non-writeable tensors in NumPy. (commit `25cc3c `__). * Removed use of some C++20 features from the codebase. This now makes it possible to use nanobind on Visual Studio 2017 and GCC 7.3.1 (used on RHEL 7). (PR `#115 `__). * Added the :cpp:class:`nb::typed\<...\> ` wrapper to override the type signature of an argument in a bound function in the generated docstring. (commit `b3404c4 `__). * Added an :cpp:func:`nb::implicit_convertible\() ` function analogous to the one in pybind11. (commit `aba4af `__). * Updated :cpp:func:`nb::make_*_iterator\<..\>() ` so that it returns references of elements, not copies. (commit `8916f5 `__). * Changed the CMake build system so that the library component (``libnanobind``) is now compiled statically by default. (commit `8418a4 `__). * Switched shared library linking on macOS back to a two-level namespace. (commit `fe4965 `__). * Various minor fixes and improvements. * ABI version 7. Version 0.1.0 (January 3, 2023) ------------------------------- * Allow nanobind methods on non-nanobind) classes. (PR `#104 `__). * Fix dangling `tp_members` pointer in type initialization. (PR `#99 `__). * Added a runtime setting to suppress leak warnings. (PR `#109 `__). * Added the ability to hash ``nb::enum_<..>`` instances (PR `#106 `__). * Fixed the signature of ``nb::enum_<..>::export_values()``. (commit `714d17 `__). * Double-check GIL status when performing reference counting operations in debug mode. (commit `a1b245 `__). * Fixed a reference leak that occurred when module initialization fails. (commit `adfa9e `__). * Improved robustness of ``nb::tensor<..>`` caster. (commit `633672 `__). * Upgraded the internally used ``tsl::robin_map<>`` hash table to address a rare `overflow issue `__ discovered in this codebase. (commit `3b81b1 `__). * Various minor fixes and improvements. * ABI version 6. Version 0.0.9 (Nov 23, 2022) ---------------------------- * PyPy 7.3.10 or newer is now supported subject to `certain limitations `__. (commits `f935f93 `__ and `b343bbd `__). * Three changes that reduce the binary size and improve runtime performance of binding libraries. (commits `07b4e1fc `__, `9a803796 `__, and `cba4d285 `__). * Fixed a reference leak in ``python_error::what()`` (commit `61393ad `__). * Adopted a new policy for function type annotations. (commit `c855c90 `__). * Improved the effectiveness of link-time-optimization when building extension modules with the ``NB_STATIC`` flag. This leads to smaller binaries. (commit `f64d2b9 `__). * Nanobind now relies on standard mechanisms to inherit the ``tp_traverse`` and ``tp_clear`` type slots instead of trying to reimplement the underlying CPython logic (commit `efa09a6b `__). * Moved nanobind internal data structures from ``builtins`` to Python interpreter state dictionary. (issue `#96 `__, commit `ca23da7 `__). * Various minor fixes and improvements. Version 0.0.8 (Oct 27, 2022) ---------------------------- * Caster for ``std::array<..>``. (commit `be34b16 `__). * Caster for ``std::set<..>`` and ``std::unordered_set`` (PR `#87 `__). * Ported ``nb::make[_key_,_value]_iterator()`` from pybind11. (commit `34d0be1 `__). * Caster for untyped ``void *`` pointers. (commit `6455fff `__). * Exploit move constructors in ``nb::class_::def_readwrite()`` and ``nb::class_::def_readwrite_static()`` (PR `#94 `__). * Redesign of the ``std::function<>`` caster to enable cyclic garbage collector traversal through inter-language callbacks (PR `#95 `__). * New interface for specifying custom type slots during Python type construction. (commit `38ba18a `__). * Fixed potential undefined behavior related to ``nb_func`` garbage collection by Python's cyclic garbage collector. (commit `662e1b9 `__). * Added a workaround for spurious reference leak warnings caused by other extension modules in conjunction with ``typing.py`` (commit `5e11e80 `__). * Various minor fixes and improvements. * ABI version 5. Version 0.0.7 (Oct 14, 2022) ---------------------------- * Fixed a regression involving function docstrings in ``pydoc``. (commit `384f4a `__). Version 0.0.6 (Oct 14, 2022) ---------------------------- * Fixed undefined behavior that could lead to crashes when nanobind types were freed. (commit `39266e `__). * Refactored nanobind so that it works with ``Py_LIMITED_API`` (PR `#37 `__). * Dynamic instance attributes (PR `#38 `__). * Intrusive pointer support (PR `#43 `__). * Byte string support (PR `#62 `__). * Casters for ``std::variant<..>`` and ``std::optional<..>`` (PR `#67 `__). * Casters for ``std::map<..>`` and ``std::unordered_map<..>`` (PR `#73 `__). * Caster for ``std::string_view<..>`` (PR `#68 `__). * Custom exception support (commit `41b7da `__). * Register nanobind functions with Python's cyclic garbage collector (PR `#86 `__). * Various minor fixes and improvements. * ABI version 3. Version 0.0.5 (May 13, 2022) ---------------------------- * Enumeration export. * Implicit number conversion for NumPy scalars. * Various minor fixes and improvements. Version 0.0.4 (May 13, 2022) ---------------------------- * Botched release, replaced by 0.0.5 on the same day. Version 0.0.3 (Apr 14, 2022) ---------------------------- * DLPack support. * Iterators for various Python type wrappers. * Low-level interface to instance creation. * Docstring generation improvements. * Various minor fixes and improvements. Version 0.0.2 (Mar 10, 2022) ---------------------------- * Initial release of the nanobind codebase. * ABI version 1. Version 0.0.1 (Feb 21, 2022) ---------------------------- * Placeholder package on PyPI.