blob: 9576a8bc255ae8ca310a1fc74fbbea7a578570a9 [file] [log] [blame]
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001.. _changelog:
2
3Changelog
4#########
5
Wenzel Jakobed52f462016-12-26 13:18:26 +01006Starting with version 1.8.0, pybind11 releases use a `semantic versioning
Wenzel Jakobd3549d62016-12-23 16:01:04 +01007<http://semver.org>`_ policy.
Wenzel Jakobf9502152016-06-14 15:00:46 +02008
Wenzel Jakob64f2a5f2019-06-12 21:03:40 +02009
10v2.3.1 (Not yet released)
11-----------------------------------------------------
12
Andre Schmeißer19189b42019-08-19 12:54:33 +020013* ``py::details::overload_cast_impl`` is available in C++11 mode, can be used
14 like ``overload_cast`` with an additional set of parantheses.
15 `1581 <https://github.com/pybind/pybind11/pull/1581>`_.
Wenzel Jakob64f2a5f2019-06-12 21:03:40 +020016
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +020017v2.3.0 (June 11, 2019)
Wenzel Jakob8cf091a2017-08-31 14:01:08 +020018-----------------------------------------------------
19
Dean Moldovan56613942017-07-02 12:52:00 +020020* Significantly reduced module binary size (10-20%) when compiled in C++11 mode
21 with GCC/Clang, or in any mode with MSVC. Function signatures are now always
22 precomputed at compile time (this was previously only available in C++14 mode
23 for non-MSVC compilers).
24 `#934 <https://github.com/pybind/pybind11/pull/934>`_.
Wenzel Jakob8cf091a2017-08-31 14:01:08 +020025
Wenzel Jakob35c82c72018-09-11 10:08:48 +020026* Add basic support for tag-based static polymorphism, where classes
27 provide a method to returns the desired type of an instance.
28 `#1326 <https://github.com/pybind/pybind11/pull/1326>`_.
29
Wenzel Jakobf4245182018-09-01 01:20:24 +020030* Python type wrappers (``py::handle``, ``py::object``, etc.)
31 now support map Python's number protocol onto C++ arithmetic
32 operators such as ``operator+``, ``operator/=``, etc.
33 `#1511 <https://github.com/pybind/pybind11/pull/1511>`_.
34
Wenzel Jakob35c82c72018-09-11 10:08:48 +020035* A number of improvements related to enumerations:
36
37 1. The ``enum_`` implementation was rewritten from scratch to reduce
38 code bloat. Rather than instantiating a full implementation for each
39 enumeration, most code is now contained in a generic base class.
40 `#1511 <https://github.com/pybind/pybind11/pull/1511>`_.
41
42 2. The ``value()`` method of ``py::enum_`` now accepts an optional
43 docstring that will be shown in the documentation of the associated
44 enumeration. `#1160 <https://github.com/pybind/pybind11/pull/1160>`_.
45
46 3. check for already existing enum value and throw an error if present.
47 `#1453 <https://github.com/pybind/pybind11/pull/1453>`_.
48
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +020049* Support for over-aligned type allocation via C++17's aligned ``new``
50 statement. `#1582 <https://github.com/pybind/pybind11/pull/1582>`_.
51
52* Added ``py::ellipsis()`` method for slicing of multidimensional NumPy arrays
Wenzel Jakob35c82c72018-09-11 10:08:48 +020053 `#1502 <https://github.com/pybind/pybind11/pull/1502>`_.
54
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +020055* Numerous Improvements to the ``mkdoc.py`` script for extracting documentation
56 from C++ header files.
57 `#1788 <https://github.com/pybind/pybind11/pull/1788>`_.
58
Wenzel Jakob35c82c72018-09-11 10:08:48 +020059* ``pybind11_add_module()``: allow including Python as a ``SYSTEM`` include path.
60 `#1416 <https://github.com/pybind/pybind11/pull/1416>`_.
61
Allan Leale76dff72018-10-11 10:28:12 +020062* ``pybind11/stl.h`` does not convert strings to ``vector<string>`` anymore.
63 `#1258 <https://github.com/pybind/pybind11/issues/1258>`_.
64
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +020065* Mark static methods as such to fix auto-generated Sphinx documentation.
66 `#1732 <https://github.com/pybind/pybind11/pull/1732>`_.
67
68* Re-throw forced unwind exceptions (e.g. during pthread termination).
69 `#1208 <https://github.com/pybind/pybind11/pull/1208>`_.
70
71* Added ``__contains__`` method to the bindings of maps (``std::map``,
72 ``std::unordered_map``).
73 `#1767 <https://github.com/pybind/pybind11/pull/1767>`_.
74
75* Improvements to ``gil_scoped_acquire``.
76 `#1211 <https://github.com/pybind/pybind11/pull/1211>`_.
77
78* Type caster support for ``std::deque<T>``.
79 `#1609 <https://github.com/pybind/pybind11/pull/1609>`_.
80
81* Support for ``std::unique_ptr`` holders, whose deleters differ between a base and derived
82 class. `#1353 <https://github.com/pybind/pybind11/pull/1353>`_.
83
84* Construction of STL array/vector-like data structures from
85 iterators. Added an ``extend()`` operation.
86 `#1709 <https://github.com/pybind/pybind11/pull/1709>`_,
87
88* CMake build system improvements for projects that include non-C++
89 files (e.g. plain C, CUDA) in ``pybind11_add_module`` et al.
90 `#1678 <https://github.com/pybind/pybind11/pull/1678>`_.
91
92* Fixed asynchronous invocation and deallocation of Python functions
93 wrapped in ``std::function``.
94 `#1595 <https://github.com/pybind/pybind11/pull/1595>`_.
95
96* Fixes regarding return value policy propagation in STL type casters.
97 `#1603 <https://github.com/pybind/pybind11/pull/1603>`_.
98
99* Fixed scoped enum comparisons.
100 `#1571 <https://github.com/pybind/pybind11/pull/1571>`_.
101
102* Fixed iostream redirection for code that releases the GIL.
103 `#1368 <https://github.com/pybind/pybind11/pull/1368>`_,
104
105* A number of CI-related fixes.
106 `#1757 <https://github.com/pybind/pybind11/pull/1757>`_,
107 `#1744 <https://github.com/pybind/pybind11/pull/1744>`_,
108 `#1670 <https://github.com/pybind/pybind11/pull/1670>`_.
109
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200110v2.2.4 (September 11, 2018)
111-----------------------------------------------------
112
113* Use new Python 3.7 Thread Specific Storage (TSS) implementation if available.
114 `#1454 <https://github.com/pybind/pybind11/pull/1454>`_,
115 `#1517 <https://github.com/pybind/pybind11/pull/1517>`_.
116
117* Fixes for newer MSVC versions and C++17 mode.
118 `#1347 <https://github.com/pybind/pybind11/pull/1347>`_,
119 `#1462 <https://github.com/pybind/pybind11/pull/1462>`_.
120
121* Propagate return value policies to type-specific casters
122 when casting STL containers.
123 `#1455 <https://github.com/pybind/pybind11/pull/1455>`_.
124
125* Allow ostream-redirection of more than 1024 characters.
126 `#1479 <https://github.com/pybind/pybind11/pull/1479>`_.
127
128* Set ``Py_DEBUG`` define when compiling against a debug Python build.
129 `#1438 <https://github.com/pybind/pybind11/pull/1438>`_.
130
131* Untangle integer logic in number type caster to work for custom
132 types that may only be castable to a restricted set of builtin types.
133 `#1442 <https://github.com/pybind/pybind11/pull/1442>`_.
134
135* CMake build system: Remember Python version in cache file.
136 `#1434 <https://github.com/pybind/pybind11/pull/1434>`_.
137
138* Fix for custom smart pointers: use ``std::addressof`` to obtain holder
139 address instead of ``operator&``.
140 `#1435 <https://github.com/pybind/pybind11/pull/1435>`_.
141
142* Properly report exceptions thrown during module initialization.
143 `#1362 <https://github.com/pybind/pybind11/pull/1362>`_.
144
145* Fixed a segmentation fault when creating empty-shaped NumPy array.
146 `#1371 <https://github.com/pybind/pybind11/pull/1371>`_.
147
148* The version of Intel C++ compiler must be >= 2017, and this is now checked by
149 the header files. `#1363 <https://github.com/pybind/pybind11/pull/1363>`_.
150
151* A few minor typo fixes and improvements to the test suite, and
152 patches that silence compiler warnings.
Wenzel Jakob6d190362017-11-16 22:24:36 +0100153
Chris Rusby22859bb2018-08-22 22:38:27 +0100154* Vectors now support construction from generators, as well as ``extend()`` from a
155 list or generator.
156 `#1496 <https://github.com/pybind/pybind11/pull/1496>`_.
157
158
Wenzel Jakobf5f66182018-04-29 15:47:03 +0200159v2.2.3 (April 29, 2018)
160-----------------------------------------------------
161
162* The pybind11 header location detection was replaced by a new implementation
163 that no longer depends on ``pip`` internals (the recently released ``pip``
164 10 has restricted access to this API).
165 `#1190 <https://github.com/pybind/pybind11/pull/1190>`_.
166
167* Small adjustment to an implementation detail to work around a compiler segmentation fault in Clang 3.3/3.4.
168 `#1350 <https://github.com/pybind/pybind11/pull/1350>`_.
169
170* The minimal supported version of the Intel compiler was >= 17.0 since
171 pybind11 v2.1. This check is now explicit, and a compile-time error is raised
172 if the compiler meet the requirement.
173 `#1363 <https://github.com/pybind/pybind11/pull/1363>`_.
174
175* Fixed an endianness-related fault in the test suite.
176 `#1287 <https://github.com/pybind/pybind11/pull/1287>`_.
Lori A. Burnsbdbe8d02018-04-29 07:48:25 -0400177
Wenzel Jakob2d0507d2018-02-07 11:05:41 +0100178v2.2.2 (February 7, 2018)
179-----------------------------------------------------
180
181* Fixed a segfault when combining embedded interpreter
182 shutdown/reinitialization with external loaded pybind11 modules.
183 `#1092 <https://github.com/pybind/pybind11/pull/1092>`_.
184
185* Eigen support: fixed a bug where Nx1/1xN numpy inputs couldn't be passed as
186 arguments to Eigen vectors (which for Eigen are simply compile-time fixed
187 Nx1/1xN matrices).
188 `#1106 <https://github.com/pybind/pybind11/pull/1106>`_.
189
190* Clarified to license by moving the licensing of contributions from
191 ``LICENSE`` into ``CONTRIBUTING.md``: the licensing of contributions is not
192 actually part of the software license as distributed. This isn't meant to be
193 a substantial change in the licensing of the project, but addresses concerns
194 that the clause made the license non-standard.
195 `#1109 <https://github.com/pybind/pybind11/issues/1109>`_.
196
197* Fixed a regression introduced in 2.1 that broke binding functions with lvalue
198 character literal arguments.
199 `#1128 <https://github.com/pybind/pybind11/pull/1128>`_.
200
201* MSVC: fix for compilation failures under /permissive-, and added the flag to
202 the appveyor test suite.
203 `#1155 <https://github.com/pybind/pybind11/pull/1155>`_.
204
205* Fixed ``__qualname__`` generation, and in turn, fixes how class names
206 (especially nested class names) are shown in generated docstrings.
207 `#1171 <https://github.com/pybind/pybind11/pull/1171>`_.
208
209* Updated the FAQ with a suggested project citation reference.
210 `#1189 <https://github.com/pybind/pybind11/pull/1189>`_.
211
212* Added fixes for deprecation warnings when compiled under C++17 with
213 ``-Wdeprecated`` turned on, and add ``-Wdeprecated`` to the test suite
214 compilation flags.
215 `#1191 <https://github.com/pybind/pybind11/pull/1191>`_.
216
217* Fixed outdated PyPI URLs in ``setup.py``.
218 `#1213 <https://github.com/pybind/pybind11/pull/1213>`_.
219
220* Fixed a refcount leak for arguments that end up in a ``py::args`` argument
221 for functions with both fixed positional and ``py::args`` arguments.
222 `#1216 <https://github.com/pybind/pybind11/pull/1216>`_.
223
224* Fixed a potential segfault resulting from possible premature destruction of
225 ``py::args``/``py::kwargs`` arguments with overloaded functions.
226 `#1223 <https://github.com/pybind/pybind11/pull/1223>`_.
227
228* Fixed ``del map[item]`` for a ``stl_bind.h`` bound stl map.
229 `#1229 <https://github.com/pybind/pybind11/pull/1229>`_.
230
231* Fixed a regression from v2.1.x where the aggregate initialization could
232 unintentionally end up at a constructor taking a templated
233 ``std::initializer_list<T>`` argument.
234 `#1249 <https://github.com/pybind/pybind11/pull/1249>`_.
235
236* Fixed an issue where calling a function with a keep_alive policy on the same
237 nurse/patient pair would cause the internal patient storage to needlessly
238 grow (unboundedly, if the nurse is long-lived).
239 `#1251 <https://github.com/pybind/pybind11/issues/1251>`_.
240
241* Various other minor fixes.
242
Wenzel Jakobf94d7592017-09-14 08:49:47 +0200243v2.2.1 (September 14, 2017)
Dean Moldovan7939f4b2017-09-04 13:49:19 +0200244-----------------------------------------------------
245
Dean Moldovan27680302017-09-13 19:04:25 +0200246* Added ``py::module::reload()`` member function for reloading a module.
247 `#1040 <https://github.com/pybind/pybind11/pull/1040>`_.
Dean Moldovanb0a0e4a2017-09-04 21:16:09 +0200248
Dean Moldovan953d2422017-09-10 16:53:02 +0200249* Fixed a reference leak in the number converter.
250 `#1078 <https://github.com/pybind/pybind11/pull/1078>`_.
251
Dean Moldovan27680302017-09-13 19:04:25 +0200252* Fixed compilation with Clang on host GCC < 5 (old libstdc++ which isn't fully
253 C++11 compliant). `#1062 <https://github.com/pybind/pybind11/pull/1062>`_.
254
Dean Moldovan3c4933c2017-09-01 21:42:20 +0200255* Fixed a regression where the automatic ``std::vector<bool>`` caster would
256 fail to compile. The same fix also applies to any container which returns
257 element proxies instead of references.
258 `#1053 <https://github.com/pybind/pybind11/pull/1053>`_.
259
Dean Moldovan7939f4b2017-09-04 13:49:19 +0200260* Fixed a regression where the ``py::keep_alive`` policy could not be applied
261 to constructors. `#1065 <https://github.com/pybind/pybind11/pull/1065>`_.
262
Dean Moldovan7b1de1e2017-09-03 01:31:47 +0200263* Fixed a nullptr dereference when loading a ``py::module_local`` type
264 that's only registered in an external module.
265 `#1058 <https://github.com/pybind/pybind11/pull/1058>`_.
266
Dean Moldovan27680302017-09-13 19:04:25 +0200267* Fixed implicit conversion of accessors to types derived from ``py::object``.
268 `#1076 <https://github.com/pybind/pybind11/pull/1076>`_.
269
270* The ``name`` in ``PYBIND11_MODULE(name, variable)`` can now be a macro.
271 `#1082 <https://github.com/pybind/pybind11/pull/1082>`_.
272
273* Relaxed overly strict ``py::pickle()`` check for matching get and set types.
274 `#1064 <https://github.com/pybind/pybind11/pull/1064>`_.
275
Dean Moldovan2b4477e2017-09-09 20:21:34 +0200276* Conversion errors now try to be more informative when it's likely that
277 a missing header is the cause (e.g. forgetting ``<pybind11/stl.h>``).
278 `#1077 <https://github.com/pybind/pybind11/pull/1077>`_.
279
Wenzel Jakob2a5a5ec2017-08-31 13:58:24 +0200280v2.2.0 (August 31, 2017)
Wenzel Jakobd405b1b2017-03-22 22:20:07 +0100281-----------------------------------------------------
282
Dean Moldovandb46a892017-08-13 22:25:15 +0200283* Support for embedding the Python interpreter. See the
284 :doc:`documentation page </advanced/embedding>` for a
285 full overview of the new features.
286 `#774 <https://github.com/pybind/pybind11/pull/774>`_,
287 `#889 <https://github.com/pybind/pybind11/pull/889>`_,
288 `#892 <https://github.com/pybind/pybind11/pull/892>`_,
289 `#920 <https://github.com/pybind/pybind11/pull/920>`_.
290
291 .. code-block:: cpp
292
293 #include <pybind11/embed.h>
294 namespace py = pybind11;
295
296 int main() {
297 py::scoped_interpreter guard{}; // start the interpreter and keep it alive
298
299 py::print("Hello, World!"); // use the Python API
300 }
301
302* Support for inheriting from multiple C++ bases in Python.
303 `#693 <https://github.com/pybind/pybind11/pull/693>`_.
304
305 .. code-block:: python
306
307 from cpp_module import CppBase1, CppBase2
308
309 class PyDerived(CppBase1, CppBase2):
310 def __init__(self):
311 CppBase1.__init__(self) # C++ bases must be initialized explicitly
312 CppBase2.__init__(self)
313
314* ``PYBIND11_MODULE`` is now the preferred way to create module entry points.
315 ``PYBIND11_PLUGIN`` is deprecated. See :ref:`macros` for details.
316 `#879 <https://github.com/pybind/pybind11/pull/879>`_.
317
318 .. code-block:: cpp
319
320 // new
321 PYBIND11_MODULE(example, m) {
322 m.def("add", [](int a, int b) { return a + b; });
323 }
324
325 // old
326 PYBIND11_PLUGIN(example) {
327 py::module m("example");
328 m.def("add", [](int a, int b) { return a + b; });
329 return m.ptr();
330 }
331
332* pybind11's headers and build system now more strictly enforce hidden symbol
333 visibility for extension modules. This should be seamless for most users,
Dean Moldovan1fb9df62017-08-18 19:26:49 +0200334 but see the :doc:`upgrade` if you use a custom build system.
335 `#995 <https://github.com/pybind/pybind11/pull/995>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200336
337* Support for ``py::module_local`` types which allow multiple modules to
338 export the same C++ types without conflicts. This is useful for opaque
339 types like ``std::vector<int>``. ``py::bind_vector`` and ``py::bind_map``
340 now default to ``py::module_local`` if their elements are builtins or
341 local types. See :ref:`module_local` for details.
342 `#949 <https://github.com/pybind/pybind11/pull/949>`_,
343 `#981 <https://github.com/pybind/pybind11/pull/981>`_,
344 `#995 <https://github.com/pybind/pybind11/pull/995>`_,
345 `#997 <https://github.com/pybind/pybind11/pull/997>`_.
346
347* Custom constructors can now be added very easily using lambdas or factory
348 functions which return a class instance by value, pointer or holder. This
349 supersedes the old placement-new ``__init__`` technique.
350 See :ref:`custom_constructors` for details.
Dean Moldovan4c540442017-08-30 21:53:08 +0200351 `#805 <https://github.com/pybind/pybind11/pull/805>`_,
352 `#1014 <https://github.com/pybind/pybind11/pull/1014>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200353
354 .. code-block:: cpp
355
356 struct Example {
357 Example(std::string);
358 };
359
360 py::class_<Example>(m, "Example")
361 .def(py::init<std::string>()) // existing constructor
362 .def(py::init([](int n) { // custom constructor
363 return std::make_unique<Example>(std::to_string(n));
364 }));
365
Dean Moldovan1e5a7da2017-08-24 01:53:15 +0200366* Similarly to custom constructors, pickling support functions are now bound
367 using the ``py::pickle()`` adaptor which improves type safety. See the
368 :doc:`upgrade` and :ref:`pickling` for details.
369 `#1038 <https://github.com/pybind/pybind11/pull/1038>`_.
370
Dean Moldovandb46a892017-08-13 22:25:15 +0200371* Builtin support for converting C++17 standard library types and general
372 conversion improvements:
373
374 1. C++17 ``std::variant`` is supported right out of the box. C++11/14
375 equivalents (e.g. ``boost::variant``) can also be added with a simple
376 user-defined specialization. See :ref:`cpp17_container_casters` for details.
377 `#811 <https://github.com/pybind/pybind11/pull/811>`_,
378 `#845 <https://github.com/pybind/pybind11/pull/845>`_,
379 `#989 <https://github.com/pybind/pybind11/pull/989>`_.
380
381 2. Out-of-the-box support for C++17 ``std::string_view``.
382 `#906 <https://github.com/pybind/pybind11/pull/906>`_.
383
384 3. Improved compatibility of the builtin ``optional`` converter.
385 `#874 <https://github.com/pybind/pybind11/pull/874>`_.
386
387 4. The ``bool`` converter now accepts ``numpy.bool_`` and types which
388 define ``__bool__`` (Python 3.x) or ``__nonzero__`` (Python 2.7).
389 `#925 <https://github.com/pybind/pybind11/pull/925>`_.
390
391 5. C++-to-Python casters are now more efficient and move elements out
392 of rvalue containers whenever possible.
393 `#851 <https://github.com/pybind/pybind11/pull/851>`_,
394 `#936 <https://github.com/pybind/pybind11/pull/936>`_,
395 `#938 <https://github.com/pybind/pybind11/pull/938>`_.
396
397 6. Fixed ``bytes`` to ``std::string/char*`` conversion on Python 3.
398 `#817 <https://github.com/pybind/pybind11/pull/817>`_.
399
400 7. Fixed lifetime of temporary C++ objects created in Python-to-C++ conversions.
401 `#924 <https://github.com/pybind/pybind11/pull/924>`_.
402
Henry Schreiner8b405052017-08-24 17:12:43 -0700403* Scope guard call policy for RAII types, e.g. ``py::call_guard<py::gil_scoped_release>()``,
404 ``py::call_guard<py::scoped_ostream_redirect>()``. See :ref:`call_policies` for details.
Dean Moldovandb46a892017-08-13 22:25:15 +0200405 `#740 <https://github.com/pybind/pybind11/pull/740>`_.
406
Henry Schreiner8b405052017-08-24 17:12:43 -0700407* Utility for redirecting C++ streams to Python (e.g. ``std::cout`` ->
408 ``sys.stdout``). Scope guard ``py::scoped_ostream_redirect`` in C++ and
409 a context manager in Python. See :ref:`ostream_redirect`.
410 `#1009 <https://github.com/pybind/pybind11/pull/1009>`_.
411
Dean Moldovandb46a892017-08-13 22:25:15 +0200412* Improved handling of types and exceptions across module boundaries.
413 `#915 <https://github.com/pybind/pybind11/pull/915>`_,
414 `#951 <https://github.com/pybind/pybind11/pull/951>`_,
415 `#995 <https://github.com/pybind/pybind11/pull/995>`_.
416
417* Fixed destruction order of ``py::keep_alive`` nurse/patient objects
418 in reference cycles.
419 `#856 <https://github.com/pybind/pybind11/pull/856>`_.
420
421* Numpy and buffer protocol related improvements:
422
423 1. Support for negative strides in Python buffer objects/numpy arrays. This
424 required changing integers from unsigned to signed for the related C++ APIs.
425 Note: If you have compiler warnings enabled, you may notice some new conversion
426 warnings after upgrading. These can be resolved with ``static_cast``.
427 `#782 <https://github.com/pybind/pybind11/pull/782>`_.
428
429 2. Support ``std::complex`` and arrays inside ``PYBIND11_NUMPY_DTYPE``.
430 `#831 <https://github.com/pybind/pybind11/pull/831>`_,
431 `#832 <https://github.com/pybind/pybind11/pull/832>`_.
432
433 3. Support for constructing ``py::buffer_info`` and ``py::arrays`` using
434 arbitrary containers or iterators instead of requiring a ``std::vector``.
435 `#788 <https://github.com/pybind/pybind11/pull/788>`_,
436 `#822 <https://github.com/pybind/pybind11/pull/822>`_,
437 `#860 <https://github.com/pybind/pybind11/pull/860>`_.
438
439 4. Explicitly check numpy version and require >= 1.7.0.
440 `#819 <https://github.com/pybind/pybind11/pull/819>`_.
441
442* Support for allowing/prohibiting ``None`` for specific arguments and improved
443 ``None`` overload resolution order. See :ref:`none_arguments` for details.
444 `#843 <https://github.com/pybind/pybind11/pull/843>`_.
445 `#859 <https://github.com/pybind/pybind11/pull/859>`_.
446
447* Added ``py::exec()`` as a shortcut for ``py::eval<py::eval_statements>()``
448 and support for C++11 raw string literals as input. See :ref:`eval`.
449 `#766 <https://github.com/pybind/pybind11/pull/766>`_,
450 `#827 <https://github.com/pybind/pybind11/pull/827>`_.
451
452* ``py::vectorize()`` ignores non-vectorizable arguments and supports
453 member functions.
454 `#762 <https://github.com/pybind/pybind11/pull/762>`_.
455
456* Support for bound methods as callbacks (``pybind11/functional.h``).
457 `#815 <https://github.com/pybind/pybind11/pull/815>`_.
458
459* Allow aliasing pybind11 methods: ``cls.attr("foo") = cls.attr("bar")``.
460 `#802 <https://github.com/pybind/pybind11/pull/802>`_.
461
462* Don't allow mixed static/non-static overloads.
463 `#804 <https://github.com/pybind/pybind11/pull/804>`_.
464
465* Fixed overriding static properties in derived classes.
466 `#784 <https://github.com/pybind/pybind11/pull/784>`_.
467
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200468* Added support for write only properties.
469 `#1144 <https://github.com/pybind/pybind11/pull/1144>`_.
470
Dean Moldovan4c540442017-08-30 21:53:08 +0200471* Improved deduction of member functions of a derived class when its bases
472 aren't registered with pybind11.
Dean Moldovandb46a892017-08-13 22:25:15 +0200473 `#855 <https://github.com/pybind/pybind11/pull/855>`_.
474
475 .. code-block:: cpp
476
477 struct Base {
478 int foo() { return 42; }
479 }
480
481 struct Derived : Base {}
482
483 // Now works, but previously required also binding `Base`
484 py::class_<Derived>(m, "Derived")
485 .def("foo", &Derived::foo); // function is actually from `Base`
486
Wenzel Jakobb12a9d62017-08-23 16:30:56 +0200487* The implementation of ``py::init<>`` now uses C++11 brace initialization
488 syntax to construct instances, which permits binding implicit constructors of
489 aggregate types. `#1015 <https://github.com/pybind/pybind11/pull/1015>`_.
490
491 .. code-block:: cpp
492
493 struct Aggregate {
494 int a;
495 std::string b;
496 };
497
498 py::class_<Aggregate>(m, "Aggregate")
499 .def(py::init<int, const std::string &>());
500
Dean Moldovandb46a892017-08-13 22:25:15 +0200501* Fixed issues with multiple inheritance with offset base/derived pointers.
502 `#812 <https://github.com/pybind/pybind11/pull/812>`_,
503 `#866 <https://github.com/pybind/pybind11/pull/866>`_,
504 `#960 <https://github.com/pybind/pybind11/pull/960>`_.
505
Dean Moldovan4c540442017-08-30 21:53:08 +0200506* Fixed reference leak of type objects.
507 `#1030 <https://github.com/pybind/pybind11/pull/1030>`_.
508
Dean Moldovandb46a892017-08-13 22:25:15 +0200509* Improved support for the ``/std:c++14`` and ``/std:c++latest`` modes
510 on MSVC 2017.
511 `#841 <https://github.com/pybind/pybind11/pull/841>`_,
512 `#999 <https://github.com/pybind/pybind11/pull/999>`_.
513
514* Fixed detection of private operator new on MSVC.
515 `#893 <https://github.com/pybind/pybind11/pull/893>`_,
516 `#918 <https://github.com/pybind/pybind11/pull/918>`_.
517
518* Intel C++ compiler compatibility fixes.
519 `#937 <https://github.com/pybind/pybind11/pull/937>`_.
520
521* Fixed implicit conversion of `py::enum_` to integer types on Python 2.7.
522 `#821 <https://github.com/pybind/pybind11/pull/821>`_.
523
Bruce Merry37de2da2017-08-30 14:22:00 +0200524* Added ``py::hash`` to fetch the hash value of Python objects, and
525 ``.def(hash(py::self))`` to provide the C++ ``std::hash`` as the Python
526 ``__hash__`` method.
527 `#1034 <https://github.com/pybind/pybind11/pull/1034>`_.
528
Dean Moldovandb46a892017-08-13 22:25:15 +0200529* Fixed ``__truediv__`` on Python 2 and ``__itruediv__`` on Python 3.
530 `#867 <https://github.com/pybind/pybind11/pull/867>`_.
531
532* ``py::capsule`` objects now support the ``name`` attribute. This is useful
533 for interfacing with ``scipy.LowLevelCallable``.
534 `#902 <https://github.com/pybind/pybind11/pull/902>`_.
535
536* Fixed ``py::make_iterator``'s ``__next__()`` for past-the-end calls.
537 `#897 <https://github.com/pybind/pybind11/pull/897>`_.
538
539* Added ``error_already_set::matches()`` for checking Python exceptions.
540 `#772 <https://github.com/pybind/pybind11/pull/772>`_.
541
542* Deprecated ``py::error_already_set::clear()``. It's no longer needed
543 following a simplification of the ``py::error_already_set`` class.
544 `#954 <https://github.com/pybind/pybind11/pull/954>`_.
545
546* Deprecated ``py::handle::operator==()`` in favor of ``py::handle::is()``
547 `#825 <https://github.com/pybind/pybind11/pull/825>`_.
548
549* Deprecated ``py::object::borrowed``/``py::object::stolen``.
550 Use ``py::object::borrowed_t{}``/``py::object::stolen_t{}`` instead.
551 `#771 <https://github.com/pybind/pybind11/pull/771>`_.
552
Dean Moldovan4c540442017-08-30 21:53:08 +0200553* Changed internal data structure versioning to avoid conflicts between
554 modules compiled with different revisions of pybind11.
555 `#1012 <https://github.com/pybind/pybind11/pull/1012>`_.
556
Dean Moldovandb46a892017-08-13 22:25:15 +0200557* Additional compile-time and run-time error checking and more informative messages.
558 `#786 <https://github.com/pybind/pybind11/pull/786>`_,
559 `#794 <https://github.com/pybind/pybind11/pull/794>`_,
560 `#803 <https://github.com/pybind/pybind11/pull/803>`_.
561
562* Various minor improvements and fixes.
563 `#764 <https://github.com/pybind/pybind11/pull/764>`_,
564 `#791 <https://github.com/pybind/pybind11/pull/791>`_,
565 `#795 <https://github.com/pybind/pybind11/pull/795>`_,
566 `#840 <https://github.com/pybind/pybind11/pull/840>`_,
567 `#844 <https://github.com/pybind/pybind11/pull/844>`_,
568 `#846 <https://github.com/pybind/pybind11/pull/846>`_,
569 `#849 <https://github.com/pybind/pybind11/pull/849>`_,
570 `#858 <https://github.com/pybind/pybind11/pull/858>`_,
571 `#862 <https://github.com/pybind/pybind11/pull/862>`_,
572 `#871 <https://github.com/pybind/pybind11/pull/871>`_,
573 `#872 <https://github.com/pybind/pybind11/pull/872>`_,
574 `#881 <https://github.com/pybind/pybind11/pull/881>`_,
575 `#888 <https://github.com/pybind/pybind11/pull/888>`_,
576 `#899 <https://github.com/pybind/pybind11/pull/899>`_,
577 `#928 <https://github.com/pybind/pybind11/pull/928>`_,
578 `#931 <https://github.com/pybind/pybind11/pull/931>`_,
579 `#944 <https://github.com/pybind/pybind11/pull/944>`_,
580 `#950 <https://github.com/pybind/pybind11/pull/950>`_,
581 `#952 <https://github.com/pybind/pybind11/pull/952>`_,
582 `#962 <https://github.com/pybind/pybind11/pull/962>`_,
583 `#965 <https://github.com/pybind/pybind11/pull/965>`_,
584 `#970 <https://github.com/pybind/pybind11/pull/970>`_,
Dean Moldovandb46a892017-08-13 22:25:15 +0200585 `#978 <https://github.com/pybind/pybind11/pull/978>`_,
Dean Moldovan4c540442017-08-30 21:53:08 +0200586 `#979 <https://github.com/pybind/pybind11/pull/979>`_,
Wenzel Jakoba1041192017-08-28 16:35:32 +0200587 `#986 <https://github.com/pybind/pybind11/pull/986>`_,
Dean Moldovan4c540442017-08-30 21:53:08 +0200588 `#1020 <https://github.com/pybind/pybind11/pull/1020>`_,
589 `#1027 <https://github.com/pybind/pybind11/pull/1027>`_,
Wenzel Jakoba1041192017-08-28 16:35:32 +0200590 `#1037 <https://github.com/pybind/pybind11/pull/1037>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200591
592* Testing improvements.
593 `#798 <https://github.com/pybind/pybind11/pull/798>`_,
594 `#882 <https://github.com/pybind/pybind11/pull/882>`_,
595 `#898 <https://github.com/pybind/pybind11/pull/898>`_,
596 `#900 <https://github.com/pybind/pybind11/pull/900>`_,
597 `#921 <https://github.com/pybind/pybind11/pull/921>`_,
598 `#923 <https://github.com/pybind/pybind11/pull/923>`_,
599 `#963 <https://github.com/pybind/pybind11/pull/963>`_.
600
Wenzel Jakobdb200952017-04-07 02:03:46 +0200601v2.1.1 (April 7, 2017)
602-----------------------------------------------------
603
604* Fixed minimum version requirement for MSVC 2015u3
605 `#773 <https://github.com/pybind/pybind11/pull/773>`_.
606
Wenzel Jakobd405b1b2017-03-22 22:20:07 +0100607v2.1.0 (March 22, 2017)
Wenzel Jakoba9730be2017-01-06 14:18:44 +0100608-----------------------------------------------------
609
Wenzel Jakob62e5fef2017-03-22 22:07:45 +0100610* pybind11 now performs function overload resolution in two phases. The first
611 phase only considers exact type matches, while the second allows for implicit
612 conversions to take place. A special ``noconvert()`` syntax can be used to
613 completely disable implicit conversions for specific arguments.
614 `#643 <https://github.com/pybind/pybind11/pull/643>`_,
615 `#634 <https://github.com/pybind/pybind11/pull/634>`_,
616 `#650 <https://github.com/pybind/pybind11/pull/650>`_.
617
618* Fixed a regression where static properties no longer worked with classes
619 using multiple inheritance. The ``py::metaclass`` attribute is no longer
620 necessary (and deprecated as of this release) when binding classes with
621 static properties.
622 `#679 <https://github.com/pybind/pybind11/pull/679>`_,
623
624* Classes bound using ``pybind11`` can now use custom metaclasses.
625 `#679 <https://github.com/pybind/pybind11/pull/679>`_,
626
627* ``py::args`` and ``py::kwargs`` can now be mixed with other positional
628 arguments when binding functions using pybind11.
629 `#611 <https://github.com/pybind/pybind11/pull/611>`_.
630
631* Improved support for C++11 unicode string and character types; added
632 extensive documentation regarding pybind11's string conversion behavior.
633 `#624 <https://github.com/pybind/pybind11/pull/624>`_,
634 `#636 <https://github.com/pybind/pybind11/pull/636>`_,
635 `#715 <https://github.com/pybind/pybind11/pull/715>`_.
636
637* pybind11 can now avoid expensive copies when converting Eigen arrays to NumPy
638 arrays (and vice versa). `#610 <https://github.com/pybind/pybind11/pull/610>`_.
639
640* The "fast path" in ``py::vectorize`` now works for any full-size group of C or
641 F-contiguous arrays. The non-fast path is also faster since it no longer performs
642 copies of the input arguments (except when type conversions are necessary).
643 `#610 <https://github.com/pybind/pybind11/pull/610>`_.
644
645* Added fast, unchecked access to NumPy arrays via a proxy object.
646 `#746 <https://github.com/pybind/pybind11/pull/746>`_.
647
Wenzel Jakob0d929382017-03-22 22:52:29 +0100648* Transparent support for class-specific ``operator new`` and
Wenzel Jakob62e5fef2017-03-22 22:07:45 +0100649 ``operator delete`` implementations.
650 `#755 <https://github.com/pybind/pybind11/pull/755>`_.
651
652* Slimmer and more efficient STL-compatible iterator interface for sequence types.
653 `#662 <https://github.com/pybind/pybind11/pull/662>`_.
654
655* Improved custom holder type support.
656 `#607 <https://github.com/pybind/pybind11/pull/607>`_.
657
658* ``nullptr`` to ``None`` conversion fixed in various builtin type casters.
659 `#732 <https://github.com/pybind/pybind11/pull/732>`_.
660
661* ``enum_`` now exposes its members via a special ``__members__`` attribute.
662 `#666 <https://github.com/pybind/pybind11/pull/666>`_.
663
664* ``std::vector`` bindings created using ``stl_bind.h`` can now optionally
665 implement the buffer protocol. `#488 <https://github.com/pybind/pybind11/pull/488>`_.
666
667* Automated C++ reference documentation using doxygen and breathe.
668 `#598 <https://github.com/pybind/pybind11/pull/598>`_.
669
670* Added minimum compiler version assertions.
671 `#727 <https://github.com/pybind/pybind11/pull/727>`_.
672
673* Improved compatibility with C++1z.
674 `#677 <https://github.com/pybind/pybind11/pull/677>`_.
675
676* Improved ``py::capsule`` API. Can be used to implement cleanup
677 callbacks that are involved at module destruction time.
678 `#752 <https://github.com/pybind/pybind11/pull/752>`_.
679
680* Various minor improvements and fixes.
681 `#595 <https://github.com/pybind/pybind11/pull/595>`_,
682 `#588 <https://github.com/pybind/pybind11/pull/588>`_,
683 `#589 <https://github.com/pybind/pybind11/pull/589>`_,
684 `#603 <https://github.com/pybind/pybind11/pull/603>`_,
685 `#619 <https://github.com/pybind/pybind11/pull/619>`_,
686 `#648 <https://github.com/pybind/pybind11/pull/648>`_,
687 `#695 <https://github.com/pybind/pybind11/pull/695>`_,
688 `#720 <https://github.com/pybind/pybind11/pull/720>`_,
689 `#723 <https://github.com/pybind/pybind11/pull/723>`_,
690 `#729 <https://github.com/pybind/pybind11/pull/729>`_,
691 `#724 <https://github.com/pybind/pybind11/pull/724>`_,
692 `#742 <https://github.com/pybind/pybind11/pull/742>`_,
693 `#753 <https://github.com/pybind/pybind11/pull/753>`_.
Wenzel Jakoba9730be2017-01-06 14:18:44 +0100694
Wenzel Jakobf8dafe92017-01-04 15:09:49 +0100695v2.0.1 (Jan 4, 2017)
696-----------------------------------------------------
697
698* Fix pointer to reference error in type_caster on MSVC
699 `#583 <https://github.com/pybind/pybind11/pull/583>`_.
700
701* Fixed a segmentation in the test suite due to a typo
702 `cd7eac <https://github.com/pybind/pybind11/commit/cd7eac>`_.
703
Wenzel Jakobe33ef9c2017-01-01 13:55:06 +0100704v2.0.0 (Jan 1, 2017)
Wenzel Jakobed52f462016-12-26 13:18:26 +0100705-----------------------------------------------------
706
707* Fixed a reference counting regression affecting types with custom metaclasses
708 (introduced in v2.0.0-rc1).
709 `#571 <https://github.com/pybind/pybind11/pull/571>`_.
710
711* Quenched a CMake policy warning.
712 `#570 <https://github.com/pybind/pybind11/pull/570>`_.
713
Wenzel Jakobe33ef9c2017-01-01 13:55:06 +0100714v2.0.0-rc1 (Dec 23, 2016)
Wenzel Jakobf88af0c2016-06-22 13:52:31 +0200715-----------------------------------------------------
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +0200716
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100717The pybind11 developers are excited to issue a release candidate of pybind11
718with a subsequent v2.0.0 release planned in early January next year.
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +0200719
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100720An incredible amount of effort by went into pybind11 over the last ~5 months,
721leading to a release that is jam-packed with exciting new features and numerous
Wenzel Jakobf8dafe92017-01-04 15:09:49 +0100722usability improvements. The following list links PRs or individual commits
Wenzel Jakobed52f462016-12-26 13:18:26 +0100723whenever applicable.
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100724
725Happy Christmas!
726
727* Support for binding C++ class hierarchies that make use of multiple
728 inheritance. `#410 <https://github.com/pybind/pybind11/pull/410>`_.
729
730* PyPy support: pybind11 now supports nightly builds of PyPy and will
731 interoperate with the future 5.7 release. No code changes are necessary,
732 everything "just" works as usual. Note that we only target the Python 2.7
733 branch for now; support for 3.x will be added once its ``cpyext`` extension
Wenzel Jakobed52f462016-12-26 13:18:26 +0100734 support catches up. A few minor features remain unsupported for the time
735 being (notably dynamic attributes in custom types).
736 `#527 <https://github.com/pybind/pybind11/pull/527>`_.
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100737
luzpaz4b874612018-05-06 13:54:10 +0000738* Significant work on the documentation -- in particular, the monolithic
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100739 ``advanced.rst`` file was restructured into a easier to read hierarchical
740 organization. `#448 <https://github.com/pybind/pybind11/pull/448>`_.
741
742* Many NumPy-related improvements:
743
744 1. Object-oriented API to access and modify NumPy ``ndarray`` instances,
745 replicating much of the corresponding NumPy C API functionality.
746 `#402 <https://github.com/pybind/pybind11/pull/402>`_.
747
748 2. NumPy array ``dtype`` array descriptors are now first-class citizens and
749 are exposed via a new class ``py::dtype``.
750
751 3. Structured dtypes can be registered using the ``PYBIND11_NUMPY_DTYPE()``
752 macro. Special ``array`` constructors accepting dtype objects were also
753 added.
754
755 One potential caveat involving this change: format descriptor strings
756 should now be accessed via ``format_descriptor::format()`` (however, for
757 compatibility purposes, the old syntax ``format_descriptor::value`` will
758 still work for non-structured data types). `#308
759 <https://github.com/pybind/pybind11/pull/308>`_.
760
761 4. Further improvements to support structured dtypes throughout the system.
762 `#472 <https://github.com/pybind/pybind11/pull/472>`_,
763 `#474 <https://github.com/pybind/pybind11/pull/474>`_,
764 `#459 <https://github.com/pybind/pybind11/pull/459>`_,
765 `#453 <https://github.com/pybind/pybind11/pull/453>`_,
766 `#452 <https://github.com/pybind/pybind11/pull/452>`_, and
767 `#505 <https://github.com/pybind/pybind11/pull/505>`_.
768
769 5. Fast access operators. `#497 <https://github.com/pybind/pybind11/pull/497>`_.
770
771 6. Constructors for arrays whose storage is owned by another object.
772 `#440 <https://github.com/pybind/pybind11/pull/440>`_.
773
774 7. Added constructors for ``array`` and ``array_t`` explicitly accepting shape
775 and strides; if strides are not provided, they are deduced assuming
776 C-contiguity. Also added simplified constructors for 1-dimensional case.
777
778 8. Added buffer/NumPy support for ``char[N]`` and ``std::array<char, N>`` types.
779
780 9. Added ``memoryview`` wrapper type which is constructible from ``buffer_info``.
781
782* Eigen: many additional conversions and support for non-contiguous
783 arrays/slices.
784 `#427 <https://github.com/pybind/pybind11/pull/427>`_,
785 `#315 <https://github.com/pybind/pybind11/pull/315>`_,
786 `#316 <https://github.com/pybind/pybind11/pull/316>`_,
787 `#312 <https://github.com/pybind/pybind11/pull/312>`_, and
788 `#267 <https://github.com/pybind/pybind11/pull/267>`_
789
790* Incompatible changes in ``class_<...>::class_()``:
791
792 1. Declarations of types that provide access via the buffer protocol must
793 now include the ``py::buffer_protocol()`` annotation as an argument to
794 the ``class_`` constructor.
795
796 2. Declarations of types that require a custom metaclass (i.e. all classes
797 which include static properties via commands such as
798 ``def_readwrite_static()``) must now include the ``py::metaclass()``
799 annotation as an argument to the ``class_`` constructor.
800
801 These two changes were necessary to make type definitions in pybind11
802 future-proof, and to support PyPy via its cpyext mechanism. `#527
803 <https://github.com/pybind/pybind11/pull/527>`_.
804
805
luzpaz4b874612018-05-06 13:54:10 +0000806 3. This version of pybind11 uses a redesigned mechanism for instantiating
807 trampoline classes that are used to override virtual methods from within
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100808 Python. This led to the following user-visible syntax change: instead of
809
810 .. code-block:: cpp
811
812 py::class_<TrampolineClass>("MyClass")
813 .alias<MyClass>()
814 ....
815
816 write
817
818 .. code-block:: cpp
819
820 py::class_<MyClass, TrampolineClass>("MyClass")
821 ....
822
823 Importantly, both the original and the trampoline class are now
824 specified as an arguments (in arbitrary order) to the ``py::class_``
825 template, and the ``alias<..>()`` call is gone. The new scheme has zero
826 overhead in cases when Python doesn't override any functions of the
827 underlying C++ class. `rev. 86d825
828 <https://github.com/pybind/pybind11/commit/86d825>`_.
829
Wenzel Jakobe6b2f752016-07-10 10:54:46 +0200830* Added ``eval`` and ``eval_file`` functions for evaluating expressions and
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100831 statements from a string or file. `rev. 0d3fc3
832 <https://github.com/pybind/pybind11/commit/0d3fc3>`_.
833
834* pybind11 can now create types with a modifiable dictionary.
835 `#437 <https://github.com/pybind/pybind11/pull/437>`_ and
836 `#444 <https://github.com/pybind/pybind11/pull/444>`_.
837
838* Support for translation of arbitrary C++ exceptions to Python counterparts.
839 `#296 <https://github.com/pybind/pybind11/pull/296>`_ and
840 `#273 <https://github.com/pybind/pybind11/pull/273>`_.
841
842* Report full backtraces through mixed C++/Python code, better reporting for
843 import errors, fixed GIL management in exception processing.
844 `#537 <https://github.com/pybind/pybind11/pull/537>`_,
845 `#494 <https://github.com/pybind/pybind11/pull/494>`_,
846 `rev. e72d95 <https://github.com/pybind/pybind11/commit/e72d95>`_, and
847 `rev. 099d6e <https://github.com/pybind/pybind11/commit/099d6e>`_.
848
849* Support for bit-level operations, comparisons, and serialization of C++
850 enumerations. `#503 <https://github.com/pybind/pybind11/pull/503>`_,
851 `#508 <https://github.com/pybind/pybind11/pull/508>`_,
852 `#380 <https://github.com/pybind/pybind11/pull/380>`_,
853 `#309 <https://github.com/pybind/pybind11/pull/309>`_.
854 `#311 <https://github.com/pybind/pybind11/pull/311>`_.
855
856* The ``class_`` constructor now accepts its template arguments in any order.
857 `#385 <https://github.com/pybind/pybind11/pull/385>`_.
858
859* Attribute and item accessors now have a more complete interface which makes
860 it possible to chain attributes as in
861 ``obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)``. `#425
862 <https://github.com/pybind/pybind11/pull/425>`_.
863
864* Major redesign of the default and conversion constructors in ``pytypes.h``.
865 `#464 <https://github.com/pybind/pybind11/pull/464>`_.
866
867* Added built-in support for ``std::shared_ptr`` holder type. It is no longer
868 necessary to to include a declaration of the form
869 ``PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>)`` (though continuing to
870 do so won't cause an error).
871 `#454 <https://github.com/pybind/pybind11/pull/454>`_.
872
873* New ``py::overload_cast`` casting operator to select among multiple possible
874 overloads of a function. An example:
875
876 .. code-block:: cpp
877
878 py::class_<Pet>(m, "Pet")
879 .def("set", py::overload_cast<int>(&Pet::set), "Set the pet's age")
880 .def("set", py::overload_cast<const std::string &>(&Pet::set), "Set the pet's name");
881
882 This feature only works on C++14-capable compilers.
883 `#541 <https://github.com/pybind/pybind11/pull/541>`_.
884
885* C++ types are automatically cast to Python types, e.g. when assigning
886 them as an attribute. For instance, the following is now legal:
887
888 .. code-block:: cpp
889
890 py::module m = /* ... */
891 m.attr("constant") = 123;
892
893 (Previously, a ``py::cast`` call was necessary to avoid a compilation error.)
894 `#551 <https://github.com/pybind/pybind11/pull/551>`_.
895
896* Redesigned ``pytest``-based test suite. `#321 <https://github.com/pybind/pybind11/pull/321>`_.
897
898* Instance tracking to detect reference leaks in test suite. `#324 <https://github.com/pybind/pybind11/pull/324>`_
899
900* pybind11 can now distinguish between multiple different instances that are
901 located at the same memory address, but which have different types.
902 `#329 <https://github.com/pybind/pybind11/pull/329>`_.
903
904* Improved logic in ``move`` return value policy.
905 `#510 <https://github.com/pybind/pybind11/pull/510>`_,
906 `#297 <https://github.com/pybind/pybind11/pull/297>`_.
907
908* Generalized unpacking API to permit calling Python functions from C++ using
909 notation such as ``foo(a1, a2, *args, "ka"_a=1, "kb"_a=2, **kwargs)``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
910
911* ``py::print()`` function whose behavior matches that of the native Python
912 ``print()`` function. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
913
914* Added ``py::dict`` keyword constructor:``auto d = dict("number"_a=42,
915 "name"_a="World");``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
916
917* Added ``py::str::format()`` method and ``_s`` literal: ``py::str s = "1 + 2
918 = {}"_s.format(3);``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
919
920* Added ``py::repr()`` function which is equivalent to Python's builtin
921 ``repr()``. `#333 <https://github.com/pybind/pybind11/pull/333>`_.
922
923* Improved construction and destruction logic for holder types. It is now
924 possible to reference instances with smart pointer holder types without
925 constructing the holder if desired. The ``PYBIND11_DECLARE_HOLDER_TYPE``
926 macro now accepts an optional second parameter to indicate whether the holder
927 type uses intrusive reference counting.
928 `#533 <https://github.com/pybind/pybind11/pull/533>`_ and
929 `#561 <https://github.com/pybind/pybind11/pull/561>`_.
930
931* Mapping a stateless C++ function to Python and back is now "for free" (i.e.
932 no extra indirections or argument conversion overheads). `rev. 954b79
933 <https://github.com/pybind/pybind11/commit/954b79>`_.
934
935* Bindings for ``std::valarray<T>``.
936 `#545 <https://github.com/pybind/pybind11/pull/545>`_.
937
938* Improved support for C++17 capable compilers.
939 `#562 <https://github.com/pybind/pybind11/pull/562>`_.
940
941* Bindings for ``std::optional<t>``.
942 `#475 <https://github.com/pybind/pybind11/pull/475>`_,
943 `#476 <https://github.com/pybind/pybind11/pull/476>`_,
944 `#479 <https://github.com/pybind/pybind11/pull/479>`_,
945 `#499 <https://github.com/pybind/pybind11/pull/499>`_, and
946 `#501 <https://github.com/pybind/pybind11/pull/501>`_.
947
948* ``stl_bind.h``: general improvements and support for ``std::map`` and
949 ``std::unordered_map``.
950 `#490 <https://github.com/pybind/pybind11/pull/490>`_,
951 `#282 <https://github.com/pybind/pybind11/pull/282>`_,
952 `#235 <https://github.com/pybind/pybind11/pull/235>`_.
953
954* The ``std::tuple``, ``std::pair``, ``std::list``, and ``std::vector`` type
955 casters now accept any Python sequence type as input. `rev. 107285
956 <https://github.com/pybind/pybind11/commit/107285>`_.
957
958* Improved CMake Python detection on multi-architecture Linux.
959 `#532 <https://github.com/pybind/pybind11/pull/532>`_.
960
961* Infrastructure to selectively disable or enable parts of the automatically
962 generated docstrings. `#486 <https://github.com/pybind/pybind11/pull/486>`_.
963
964* ``reference`` and ``reference_internal`` are now the default return value
965 properties for static and non-static properties, respectively. `#473
966 <https://github.com/pybind/pybind11/pull/473>`_. (the previous defaults
967 were ``automatic``). `#473 <https://github.com/pybind/pybind11/pull/473>`_.
968
969* Support for ``std::unique_ptr`` with non-default deleters or no deleter at
970 all (``py::nodelete``). `#384 <https://github.com/pybind/pybind11/pull/384>`_.
971
Wenzel Jakob3c796712016-12-23 16:19:36 +0100972* Deprecated ``handle::call()`` method. The new syntax to call Python
973 functions is simply ``handle()``. It can also be invoked explicitly via
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100974 ``handle::operator<X>()``, where ``X`` is an optional return value policy.
975
976* Print more informative error messages when ``make_tuple()`` or ``cast()``
977 fail. `#262 <https://github.com/pybind/pybind11/pull/262>`_.
978
979* Creation of holder types for classes deriving from
980 ``std::enable_shared_from_this<>`` now also works for ``const`` values.
981 `#260 <https://github.com/pybind/pybind11/pull/260>`_.
982
983* ``make_iterator()`` improvements for better compatibility with various
984 types (now uses prefix increment operator); it now also accepts iterators
985 with different begin/end types as long as they are equality comparable.
986 `#247 <https://github.com/pybind/pybind11/pull/247>`_.
987
988* ``arg()`` now accepts a wider range of argument types for default values.
989 `#244 <https://github.com/pybind/pybind11/pull/244>`_.
990
991* Support ``keep_alive`` where the nurse object may be ``None``. `#341
992 <https://github.com/pybind/pybind11/pull/341>`_.
993
994* Added constructors for ``str`` and ``bytes`` from zero-terminated char
995 pointers, and from char pointers and length. Added constructors for ``str``
996 from ``bytes`` and for ``bytes`` from ``str``, which will perform UTF-8
997 decoding/encoding as required.
998
999* Many other improvements of library internals without user-visible changes
1000
Wenzel Jakoba720a602016-07-12 18:02:13 +02001001
10021.8.1 (July 12, 2016)
1003----------------------
Wenzel Jakobc47d4982016-07-11 23:40:28 +02001004* Fixed a rare but potentially very severe issue when the garbage collector ran
1005 during pybind11 type creation.
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001006
Wenzel Jakobf9502152016-06-14 15:00:46 +020010071.8.0 (June 14, 2016)
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001008----------------------
1009* Redesigned CMake build system which exports a convenient
1010 ``pybind11_add_module`` function to parent projects.
1011* ``std::vector<>`` type bindings analogous to Boost.Python's ``indexing_suite``
1012* Transparent conversion of sparse and dense Eigen matrices and vectors (``eigen.h``)
1013* Added an ``ExtraFlags`` template argument to the NumPy ``array_t<>`` wrapper
1014 to disable an enforced cast that may lose precision, e.g. to create overloads
1015 for different precisions and complex vs real-valued matrices.
Wenzel Jakob3f200fa2016-05-17 15:35:29 +02001016* Prevent implicit conversion of floating point values to integral types in
1017 function arguments
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001018* Fixed incorrect default return value policy for functions returning a shared
1019 pointer
Wenzel Jakob38d8b8c2016-05-31 09:53:28 +02001020* Don't allow registering a type via ``class_`` twice
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001021* Don't allow casting a ``None`` value into a C++ lvalue reference
1022* Fixed a crash in ``enum_::operator==`` that was triggered by the ``help()`` command
1023* Improved detection of whether or not custom C++ types can be copy/move-constructed
1024* Extended ``str`` type to also work with ``bytes`` instances
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001025* Added a ``"name"_a`` user defined string literal that is equivalent to ``py::arg("name")``.
1026* When specifying function arguments via ``py::arg``, the test that verifies
1027 the number of arguments now runs at compile time.
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001028* Added ``[[noreturn]]`` attribute to ``pybind11_fail()`` to quench some
1029 compiler warnings
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001030* List function arguments in exception text when the dispatch code cannot find
1031 a matching overload
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001032* Added ``PYBIND11_OVERLOAD_NAME`` and ``PYBIND11_OVERLOAD_PURE_NAME`` macros which
Wenzel Jakobf9502152016-06-14 15:00:46 +02001033 can be used to override virtual methods whose name differs in C++ and Python
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001034 (e.g. ``__call__`` and ``operator()``)
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001035* Various minor ``iterator`` and ``make_iterator()`` improvements
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001036* Transparently support ``__bool__`` on Python 2.x and Python 3.x
1037* Fixed issue with destructor of unpickled object not being called
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001038* Minor CMake build system improvements on Windows
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001039* New ``pybind11::args`` and ``pybind11::kwargs`` types to create functions which
1040 take an arbitrary number of arguments and keyword arguments
1041* New syntax to call a Python function from C++ using ``*args`` and ``*kwargs``
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001042* The functions ``def_property_*`` now correctly process docstring arguments (these
1043 formerly caused a segmentation fault)
1044* Many ``mkdoc.py`` improvements (enumerations, template arguments, ``DOC()``
1045 macro accepts more arguments)
1046* Cygwin support
1047* Documentation improvements (pickling support, ``keep_alive``, macro usage)
Wenzel Jakobc4d7ccd2016-04-30 22:00:44 +02001048
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +020010491.7 (April 30, 2016)
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +02001050----------------------
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001051* Added a new ``move`` return value policy that triggers C++11 move semantics.
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001052 The automatic return value policy falls back to this case whenever a rvalue
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001053 reference is encountered
Wenzel Jakobe84f5572016-04-26 23:19:19 +02001054* Significantly more general GIL state routines that are used instead of
1055 Python's troublesome ``PyGILState_Ensure`` and ``PyGILState_Release`` API
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001056* Redesign of opaque types that drastically simplifies their usage
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +02001057* Extended ability to pass values of type ``[const] void *``
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001058* ``keep_alive`` fix: don't fail when there is no patient
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001059* ``functional.h``: acquire the GIL before calling a Python function
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001060* Added Python RAII type wrappers ``none`` and ``iterable``
1061* Added ``*args`` and ``*kwargs`` pass-through parameters to
1062 ``pybind11.get_include()`` function
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001063* Iterator improvements and fixes
1064* Documentation on return value policies and opaque types improved
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +02001065
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +020010661.6 (April 30, 2016)
1067----------------------
1068* Skipped due to upload to PyPI gone wrong and inability to recover
1069 (https://github.com/pypa/packaging-problems/issues/74)
1070
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +020010711.5 (April 21, 2016)
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001072----------------------
Wenzel Jakobc79dbe42016-04-17 21:54:31 +02001073* For polymorphic types, use RTTI to try to return the closest type registered with pybind11
Wenzel Jakobd7efa4f2016-04-13 13:45:09 +02001074* Pickling support for serializing and unserializing C++ instances to a byte stream in Python
Wenzel Jakobb2825952016-04-13 23:33:00 +02001075* Added a convenience routine ``make_iterator()`` which turns a range indicated
1076 by a pair of C++ iterators into a iterable Python object
1077* Added ``len()`` and a variadic ``make_tuple()`` function
Wenzel Jakobb2b44a92016-04-15 17:50:40 +02001078* Addressed a rare issue that could confuse the current virtual function
1079 dispatcher and another that could lead to crashes in multi-threaded
1080 applications
Wenzel Jakobb2825952016-04-13 23:33:00 +02001081* Added a ``get_include()`` function to the Python module that returns the path
1082 of the directory containing the installed pybind11 header files
Wenzel Jakob1c329aa2016-04-13 02:37:36 +02001083* Documentation improvements: import issues, symbol visibility, pickling, limitations
Wenzel Jakobdbe43ff2016-04-21 12:21:14 +02001084* Added casting support for ``std::reference_wrapper<>``
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001085
Wenzel Jakob33c2a042016-04-07 09:06:49 +020010861.4 (April 7, 2016)
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001087--------------------------
Wenzel Jakob81dfd2c2016-03-08 19:40:32 +01001088* Transparent type conversion for ``std::wstring`` and ``wchar_t``
Wenzel Jakob0e6ca592016-04-07 08:49:37 +02001089* Allow passing ``nullptr``-valued strings
Wenzel Jakob34116732016-04-06 17:55:41 +02001090* Transparent passing of ``void *`` pointers using capsules
Wenzel Jakob0e6ca592016-04-07 08:49:37 +02001091* Transparent support for returning values wrapped in ``std::unique_ptr<>``
Wenzel Jakob4e455dd2016-03-09 16:38:28 +01001092* Improved docstring generation for compatibility with Sphinx
Wenzel Jakob34116732016-04-06 17:55:41 +02001093* Nicer debug error message when default parameter construction fails
1094* Support for "opaque" types that bypass the transparent conversion layer for STL containers
1095* Redesigned type casting interface to avoid ambiguities that could occasionally cause compiler errors
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001096* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy
Wenzel Jakob4e455dd2016-03-09 16:38:28 +01001097* Anaconda package generation support
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001098
10991.3 (March 8, 2016)
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001100--------------------------
Wenzel Jakobcf2b87a2016-02-22 17:32:44 +01001101
1102* Added support for the Intel C++ compiler (v15+)
1103* Added support for the STL unordered set/map data structures
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001104* Added support for the STL linked list data structure
Wenzel Jakobcf2b87a2016-02-22 17:32:44 +01001105* NumPy-style broadcasting support in ``pybind11::vectorize``
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001106* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001107* pybind11 internal data structures now live in a version-dependent namespace to avoid ABI issues
1108* Many, many bugfixes involving corner cases and advanced usage
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001109
11101.2 (February 7, 2016)
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001111--------------------------
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001112
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001113* Optional: efficient generation of function signatures at compile time using C++14
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001114* Switched to a simpler and more general way of dealing with function default
1115 arguments. Unused keyword arguments in function calls are now detected and
1116 cause errors as expected
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001117* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward``
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001118* New ``pybind11::base<>`` attribute to indicate a subclass relationship
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001119* Improved interface for RAII type wrappers in ``pytypes.h``
1120* Use RAII type wrappers consistently within pybind11 itself. This
1121 fixes various potential refcount leaks when exceptions occur
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001122* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7)
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001123* Made handle and related RAII classes const correct, using them more
1124 consistently everywhere now
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001125* Got rid of the ugly ``__pybind11__`` attributes on the Python side---they are
1126 now stored in a C++ hash table that is not visible in Python
1127* Fixed refcount leaks involving NumPy arrays and bound functions
1128* Vastly improved handling of shared/smart pointers
1129* Removed an unnecessary copy operation in ``pybind11::vectorize``
1130* Fixed naming clashes when both pybind11 and NumPy headers are included
1131* Added conversions for additional exception types
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001132* Documentation improvements (using multiple extension modules, smart pointers,
1133 other minor clarifications)
Wenzel Jakob61587162016-01-18 22:38:52 +01001134* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001135* Fixed license text (was: ZLIB, should have been: 3-clause BSD)
1136* Python 3.2 compatibility
Wenzel Jakobcd4e6ae2016-01-29 11:48:40 +01001137* Fixed remaining issues when accessing types in another plugin module
1138* Added enum comparison and casting methods
1139* Improved SFINAE-based detection of whether types are copy-constructible
1140* Eliminated many warnings about unused variables and the use of ``offsetof()``
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001141* Support for ``std::array<>`` conversions
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001142
11431.1 (December 7, 2015)
1144--------------------------
1145
1146* Documentation improvements (GIL, wrapping functions, casting, fixed many typos)
1147* Generalized conversion of integer types
1148* Improved support for casting function objects
1149* Improved support for ``std::shared_ptr<>`` conversions
1150* Initial support for ``std::set<>`` conversions
1151* Fixed type resolution issue for types defined in a separate plugin module
1152* Cmake build system improvements
1153* Factored out generic functionality to non-templated code (smaller code size)
1154* Added a code size / compile time benchmark vs Boost.Python
1155* Added an appveyor CI script
1156
11571.0 (October 15, 2015)
1158------------------------
1159* Initial release