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