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