blob: 2def2b071933d7abe76d2154cf60c15c1df4fd9d [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 Jakob3b1dbeb2020-03-31 12:55:48 +02009v2.5.0 (Mar 31, 2020)
10-----------------------------------------------------
11
12* Use C++17 fold expressions in type casters, if available. This can
13 improve performance during overload resolution when functions have
14 multiple arguments.
15 `#2043 <https://github.com/pybind/pybind11/pull/2043>`_.
16
17* Changed include directory resolution in ``pybind11/__init__.py``
18 and installation in ``setup.py``. This fixes a number of open issues
19 where pybind11 headers could not be found in certain environments.
20 `#1995 <https://github.com/pybind/pybind11/pull/1995>`_.
21
22* C++20 ``char8_t`` and ``u8string`` support. `#2026
23 <https://github.com/pybind/pybind11/pull/2026>`_.
24
25* CMake: search for Python 3.9. `bb9c91
26 <https://github.com/pybind/pybind11/commit/bb9c91>`_.
27
28* Fixes for MSYS-based build environments.
29 `#2087 <https://github.com/pybind/pybind11/pull/2087>`_,
30 `#2053 <https://github.com/pybind/pybind11/pull/2053>`_.
31
32* STL bindings for ``std::vector<...>::clear``. `#2074
33 <https://github.com/pybind/pybind11/pull/2074>`_.
34
35* Read-only flag for ``py::buffer``. `#1466
36 <https://github.com/pybind/pybind11/pull/1466>`_.
37
38* Exception handling during module initialization.
39 `bf2b031 <https://github.com/pybind/pybind11/commit/bf2b031>`_.
40
41* Support linking against a CPython debug build.
42 `#2025 <https://github.com/pybind/pybind11/pull/2025>`_.
43
44* Fixed issues involving the availability and use of aligned ``new`` and
45 ``delete``. `#1988 <https://github.com/pybind/pybind11/pull/1988>`_,
46 `759221 <https://github.com/pybind/pybind11/commit/759221>`_.
47
48* Fixed a resource leak upon interpreter shutdown.
49 `#2020 <https://github.com/pybind/pybind11/pull/2020>`_.
50
51* Fixed error handling in the boolean caster.
52 `#1976 <https://github.com/pybind/pybind11/pull/1976>`_.
53
Wenzel Jakob80d45242019-10-15 01:57:24 +020054v2.4.3 (Oct 15, 2019)
55-----------------------------------------------------
56
57* Adapt pybind11 to a C API convention change in Python 3.8. `#1950
58 <https://github.com/pybind/pybind11/pull/1950>`_.
59
Wenzel Jakob7ec2ddf2019-09-21 20:19:58 +020060v2.4.2 (Sep 21, 2019)
61-----------------------------------------------------
62
63* Replaced usage of a C++14 only construct. `#1929
64 <https://github.com/pybind/pybind11/pull/1929>`_.
65
66* Made an ifdef future-proof for Python >= 4. `f3109d
67 <https://github.com/pybind/pybind11/commit/f3109d>`_.
68
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020069v2.4.1 (Sep 20, 2019)
70-----------------------------------------------------
71
72* Fixed a problem involving implicit conversion from enumerations to integers
Wenzel Jakob7ec2ddf2019-09-21 20:19:58 +020073 on Python 3.8. `#1780 <https://github.com/pybind/pybind11/pull/1780>`_.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020074
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020075v2.4.0 (Sep 19, 2019)
Wenzel Jakob64f2a5f2019-06-12 21:03:40 +020076-----------------------------------------------------
77
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020078* Try harder to keep pybind11-internal data structures separate when there
79 are potential ABI incompatibilities. Fixes crashes that occurred when loading
80 multiple pybind11 extensions that were e.g. compiled by GCC (libstdc++)
81 and Clang (libc++).
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020082 `#1588 <https://github.com/pybind/pybind11/pull/1588>`_ and
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020083 `c9f5a <https://github.com/pybind/pybind11/commit/c9f5a>`_.
84
85* Added support for ``__await__``, ``__aiter__``, and ``__anext__`` protocols.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020086 `#1842 <https://github.com/pybind/pybind11/pull/1842>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020087
88* ``pybind11_add_module()``: don't strip symbols when compiling in
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020089 ``RelWithDebInfo`` mode. `#1980
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020090 <https://github.com/pybind/pybind11/pull/1980>`_.
91
92* ``enum_``: Reproduce Python behavior when comparing against invalid values
93 (e.g. ``None``, strings, etc.). Add back support for ``__invert__()``.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +020094 `#1912 <https://github.com/pybind/pybind11/pull/1912>`_,
95 `#1907 <https://github.com/pybind/pybind11/pull/1907>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +020096
97* List insertion operation for ``py::list``.
98 Added ``.empty()`` to all collection types.
99 Added ``py::set::contains()`` and ``py::dict::contains()``.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200100 `#1887 <https://github.com/pybind/pybind11/pull/1887>`_,
101 `#1884 <https://github.com/pybind/pybind11/pull/1884>`_,
102 `#1888 <https://github.com/pybind/pybind11/pull/1888>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200103
Andre Schmeißer19189b42019-08-19 12:54:33 +0200104* ``py::details::overload_cast_impl`` is available in C++11 mode, can be used
105 like ``overload_cast`` with an additional set of parantheses.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200106 `#1581 <https://github.com/pybind/pybind11/pull/1581>`_.
Wenzel Jakob64f2a5f2019-06-12 21:03:40 +0200107
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200108* Fixed ``get_include()`` on Conda.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200109 `#1877 <https://github.com/pybind/pybind11/pull/1877>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200110
111* ``stl_bind.h``: negative indexing support.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200112 `#1882 <https://github.com/pybind/pybind11/pull/1882>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200113
114* Minor CMake fix to add MinGW compatibility.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200115 `#1851 <https://github.com/pybind/pybind11/pull/1851>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200116
117* GIL-related fixes.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200118 `#1836 <https://github.com/pybind/pybind11/pull/1836>`_,
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200119 `8b90b <https://github.com/pybind/pybind11/commit/8b90b>`_.
120
121* Other very minor/subtle fixes and improvements.
Wenzel Jakobe44fcc32019-09-20 11:10:49 +0200122 `#1329 <https://github.com/pybind/pybind11/pull/1329>`_,
123 `#1910 <https://github.com/pybind/pybind11/pull/1910>`_,
124 `#1863 <https://github.com/pybind/pybind11/pull/1863>`_,
125 `#1847 <https://github.com/pybind/pybind11/pull/1847>`_,
126 `#1890 <https://github.com/pybind/pybind11/pull/1890>`_,
127 `#1860 <https://github.com/pybind/pybind11/pull/1860>`_,
128 `#1848 <https://github.com/pybind/pybind11/pull/1848>`_,
129 `#1821 <https://github.com/pybind/pybind11/pull/1821>`_,
130 `#1837 <https://github.com/pybind/pybind11/pull/1837>`_,
131 `#1833 <https://github.com/pybind/pybind11/pull/1833>`_,
132 `#1748 <https://github.com/pybind/pybind11/pull/1748>`_,
133 `#1852 <https://github.com/pybind/pybind11/pull/1852>`_.
Wenzel Jakob00a0aa92019-09-19 23:06:22 +0200134
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200135v2.3.0 (June 11, 2019)
Wenzel Jakob8cf091a2017-08-31 14:01:08 +0200136-----------------------------------------------------
137
Dean Moldovan56613942017-07-02 12:52:00 +0200138* Significantly reduced module binary size (10-20%) when compiled in C++11 mode
139 with GCC/Clang, or in any mode with MSVC. Function signatures are now always
140 precomputed at compile time (this was previously only available in C++14 mode
141 for non-MSVC compilers).
142 `#934 <https://github.com/pybind/pybind11/pull/934>`_.
Wenzel Jakob8cf091a2017-08-31 14:01:08 +0200143
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200144* Add basic support for tag-based static polymorphism, where classes
145 provide a method to returns the desired type of an instance.
146 `#1326 <https://github.com/pybind/pybind11/pull/1326>`_.
147
Wenzel Jakobf4245182018-09-01 01:20:24 +0200148* Python type wrappers (``py::handle``, ``py::object``, etc.)
149 now support map Python's number protocol onto C++ arithmetic
150 operators such as ``operator+``, ``operator/=``, etc.
151 `#1511 <https://github.com/pybind/pybind11/pull/1511>`_.
152
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200153* A number of improvements related to enumerations:
154
155 1. The ``enum_`` implementation was rewritten from scratch to reduce
156 code bloat. Rather than instantiating a full implementation for each
157 enumeration, most code is now contained in a generic base class.
158 `#1511 <https://github.com/pybind/pybind11/pull/1511>`_.
159
160 2. The ``value()`` method of ``py::enum_`` now accepts an optional
161 docstring that will be shown in the documentation of the associated
162 enumeration. `#1160 <https://github.com/pybind/pybind11/pull/1160>`_.
163
164 3. check for already existing enum value and throw an error if present.
165 `#1453 <https://github.com/pybind/pybind11/pull/1453>`_.
166
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200167* Support for over-aligned type allocation via C++17's aligned ``new``
168 statement. `#1582 <https://github.com/pybind/pybind11/pull/1582>`_.
169
170* Added ``py::ellipsis()`` method for slicing of multidimensional NumPy arrays
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200171 `#1502 <https://github.com/pybind/pybind11/pull/1502>`_.
172
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200173* Numerous Improvements to the ``mkdoc.py`` script for extracting documentation
174 from C++ header files.
175 `#1788 <https://github.com/pybind/pybind11/pull/1788>`_.
176
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200177* ``pybind11_add_module()``: allow including Python as a ``SYSTEM`` include path.
178 `#1416 <https://github.com/pybind/pybind11/pull/1416>`_.
179
Allan Leale76dff72018-10-11 10:28:12 +0200180* ``pybind11/stl.h`` does not convert strings to ``vector<string>`` anymore.
181 `#1258 <https://github.com/pybind/pybind11/issues/1258>`_.
182
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200183* Mark static methods as such to fix auto-generated Sphinx documentation.
184 `#1732 <https://github.com/pybind/pybind11/pull/1732>`_.
185
186* Re-throw forced unwind exceptions (e.g. during pthread termination).
187 `#1208 <https://github.com/pybind/pybind11/pull/1208>`_.
188
189* Added ``__contains__`` method to the bindings of maps (``std::map``,
190 ``std::unordered_map``).
191 `#1767 <https://github.com/pybind/pybind11/pull/1767>`_.
192
193* Improvements to ``gil_scoped_acquire``.
194 `#1211 <https://github.com/pybind/pybind11/pull/1211>`_.
195
196* Type caster support for ``std::deque<T>``.
197 `#1609 <https://github.com/pybind/pybind11/pull/1609>`_.
198
199* Support for ``std::unique_ptr`` holders, whose deleters differ between a base and derived
200 class. `#1353 <https://github.com/pybind/pybind11/pull/1353>`_.
201
202* Construction of STL array/vector-like data structures from
203 iterators. Added an ``extend()`` operation.
204 `#1709 <https://github.com/pybind/pybind11/pull/1709>`_,
205
206* CMake build system improvements for projects that include non-C++
207 files (e.g. plain C, CUDA) in ``pybind11_add_module`` et al.
208 `#1678 <https://github.com/pybind/pybind11/pull/1678>`_.
209
210* Fixed asynchronous invocation and deallocation of Python functions
211 wrapped in ``std::function``.
212 `#1595 <https://github.com/pybind/pybind11/pull/1595>`_.
213
214* Fixes regarding return value policy propagation in STL type casters.
215 `#1603 <https://github.com/pybind/pybind11/pull/1603>`_.
216
217* Fixed scoped enum comparisons.
218 `#1571 <https://github.com/pybind/pybind11/pull/1571>`_.
219
220* Fixed iostream redirection for code that releases the GIL.
221 `#1368 <https://github.com/pybind/pybind11/pull/1368>`_,
222
223* A number of CI-related fixes.
224 `#1757 <https://github.com/pybind/pybind11/pull/1757>`_,
225 `#1744 <https://github.com/pybind/pybind11/pull/1744>`_,
226 `#1670 <https://github.com/pybind/pybind11/pull/1670>`_.
227
Wenzel Jakob35c82c72018-09-11 10:08:48 +0200228v2.2.4 (September 11, 2018)
229-----------------------------------------------------
230
231* Use new Python 3.7 Thread Specific Storage (TSS) implementation if available.
232 `#1454 <https://github.com/pybind/pybind11/pull/1454>`_,
233 `#1517 <https://github.com/pybind/pybind11/pull/1517>`_.
234
235* Fixes for newer MSVC versions and C++17 mode.
236 `#1347 <https://github.com/pybind/pybind11/pull/1347>`_,
237 `#1462 <https://github.com/pybind/pybind11/pull/1462>`_.
238
239* Propagate return value policies to type-specific casters
240 when casting STL containers.
241 `#1455 <https://github.com/pybind/pybind11/pull/1455>`_.
242
243* Allow ostream-redirection of more than 1024 characters.
244 `#1479 <https://github.com/pybind/pybind11/pull/1479>`_.
245
246* Set ``Py_DEBUG`` define when compiling against a debug Python build.
247 `#1438 <https://github.com/pybind/pybind11/pull/1438>`_.
248
249* Untangle integer logic in number type caster to work for custom
250 types that may only be castable to a restricted set of builtin types.
251 `#1442 <https://github.com/pybind/pybind11/pull/1442>`_.
252
253* CMake build system: Remember Python version in cache file.
254 `#1434 <https://github.com/pybind/pybind11/pull/1434>`_.
255
256* Fix for custom smart pointers: use ``std::addressof`` to obtain holder
257 address instead of ``operator&``.
258 `#1435 <https://github.com/pybind/pybind11/pull/1435>`_.
259
260* Properly report exceptions thrown during module initialization.
261 `#1362 <https://github.com/pybind/pybind11/pull/1362>`_.
262
263* Fixed a segmentation fault when creating empty-shaped NumPy array.
264 `#1371 <https://github.com/pybind/pybind11/pull/1371>`_.
265
266* The version of Intel C++ compiler must be >= 2017, and this is now checked by
267 the header files. `#1363 <https://github.com/pybind/pybind11/pull/1363>`_.
268
269* A few minor typo fixes and improvements to the test suite, and
270 patches that silence compiler warnings.
Wenzel Jakob6d190362017-11-16 22:24:36 +0100271
Chris Rusby22859bb2018-08-22 22:38:27 +0100272* Vectors now support construction from generators, as well as ``extend()`` from a
273 list or generator.
274 `#1496 <https://github.com/pybind/pybind11/pull/1496>`_.
275
276
Wenzel Jakobf5f66182018-04-29 15:47:03 +0200277v2.2.3 (April 29, 2018)
278-----------------------------------------------------
279
280* The pybind11 header location detection was replaced by a new implementation
281 that no longer depends on ``pip`` internals (the recently released ``pip``
282 10 has restricted access to this API).
283 `#1190 <https://github.com/pybind/pybind11/pull/1190>`_.
284
285* Small adjustment to an implementation detail to work around a compiler segmentation fault in Clang 3.3/3.4.
286 `#1350 <https://github.com/pybind/pybind11/pull/1350>`_.
287
288* The minimal supported version of the Intel compiler was >= 17.0 since
289 pybind11 v2.1. This check is now explicit, and a compile-time error is raised
290 if the compiler meet the requirement.
291 `#1363 <https://github.com/pybind/pybind11/pull/1363>`_.
292
293* Fixed an endianness-related fault in the test suite.
294 `#1287 <https://github.com/pybind/pybind11/pull/1287>`_.
Lori A. Burnsbdbe8d02018-04-29 07:48:25 -0400295
Wenzel Jakob2d0507d2018-02-07 11:05:41 +0100296v2.2.2 (February 7, 2018)
297-----------------------------------------------------
298
299* Fixed a segfault when combining embedded interpreter
300 shutdown/reinitialization with external loaded pybind11 modules.
301 `#1092 <https://github.com/pybind/pybind11/pull/1092>`_.
302
303* Eigen support: fixed a bug where Nx1/1xN numpy inputs couldn't be passed as
304 arguments to Eigen vectors (which for Eigen are simply compile-time fixed
305 Nx1/1xN matrices).
306 `#1106 <https://github.com/pybind/pybind11/pull/1106>`_.
307
308* Clarified to license by moving the licensing of contributions from
309 ``LICENSE`` into ``CONTRIBUTING.md``: the licensing of contributions is not
310 actually part of the software license as distributed. This isn't meant to be
311 a substantial change in the licensing of the project, but addresses concerns
312 that the clause made the license non-standard.
313 `#1109 <https://github.com/pybind/pybind11/issues/1109>`_.
314
315* Fixed a regression introduced in 2.1 that broke binding functions with lvalue
316 character literal arguments.
317 `#1128 <https://github.com/pybind/pybind11/pull/1128>`_.
318
319* MSVC: fix for compilation failures under /permissive-, and added the flag to
320 the appveyor test suite.
321 `#1155 <https://github.com/pybind/pybind11/pull/1155>`_.
322
323* Fixed ``__qualname__`` generation, and in turn, fixes how class names
324 (especially nested class names) are shown in generated docstrings.
325 `#1171 <https://github.com/pybind/pybind11/pull/1171>`_.
326
327* Updated the FAQ with a suggested project citation reference.
328 `#1189 <https://github.com/pybind/pybind11/pull/1189>`_.
329
330* Added fixes for deprecation warnings when compiled under C++17 with
331 ``-Wdeprecated`` turned on, and add ``-Wdeprecated`` to the test suite
332 compilation flags.
333 `#1191 <https://github.com/pybind/pybind11/pull/1191>`_.
334
335* Fixed outdated PyPI URLs in ``setup.py``.
336 `#1213 <https://github.com/pybind/pybind11/pull/1213>`_.
337
338* Fixed a refcount leak for arguments that end up in a ``py::args`` argument
339 for functions with both fixed positional and ``py::args`` arguments.
340 `#1216 <https://github.com/pybind/pybind11/pull/1216>`_.
341
342* Fixed a potential segfault resulting from possible premature destruction of
343 ``py::args``/``py::kwargs`` arguments with overloaded functions.
344 `#1223 <https://github.com/pybind/pybind11/pull/1223>`_.
345
346* Fixed ``del map[item]`` for a ``stl_bind.h`` bound stl map.
347 `#1229 <https://github.com/pybind/pybind11/pull/1229>`_.
348
349* Fixed a regression from v2.1.x where the aggregate initialization could
350 unintentionally end up at a constructor taking a templated
351 ``std::initializer_list<T>`` argument.
352 `#1249 <https://github.com/pybind/pybind11/pull/1249>`_.
353
354* Fixed an issue where calling a function with a keep_alive policy on the same
355 nurse/patient pair would cause the internal patient storage to needlessly
356 grow (unboundedly, if the nurse is long-lived).
357 `#1251 <https://github.com/pybind/pybind11/issues/1251>`_.
358
359* Various other minor fixes.
360
Wenzel Jakobf94d7592017-09-14 08:49:47 +0200361v2.2.1 (September 14, 2017)
Dean Moldovan7939f4b2017-09-04 13:49:19 +0200362-----------------------------------------------------
363
Dean Moldovan27680302017-09-13 19:04:25 +0200364* Added ``py::module::reload()`` member function for reloading a module.
365 `#1040 <https://github.com/pybind/pybind11/pull/1040>`_.
Dean Moldovanb0a0e4a2017-09-04 21:16:09 +0200366
Dean Moldovan953d2422017-09-10 16:53:02 +0200367* Fixed a reference leak in the number converter.
368 `#1078 <https://github.com/pybind/pybind11/pull/1078>`_.
369
Dean Moldovan27680302017-09-13 19:04:25 +0200370* Fixed compilation with Clang on host GCC < 5 (old libstdc++ which isn't fully
371 C++11 compliant). `#1062 <https://github.com/pybind/pybind11/pull/1062>`_.
372
Dean Moldovan3c4933c2017-09-01 21:42:20 +0200373* Fixed a regression where the automatic ``std::vector<bool>`` caster would
374 fail to compile. The same fix also applies to any container which returns
375 element proxies instead of references.
376 `#1053 <https://github.com/pybind/pybind11/pull/1053>`_.
377
Dean Moldovan7939f4b2017-09-04 13:49:19 +0200378* Fixed a regression where the ``py::keep_alive`` policy could not be applied
379 to constructors. `#1065 <https://github.com/pybind/pybind11/pull/1065>`_.
380
Dean Moldovan7b1de1e2017-09-03 01:31:47 +0200381* Fixed a nullptr dereference when loading a ``py::module_local`` type
382 that's only registered in an external module.
383 `#1058 <https://github.com/pybind/pybind11/pull/1058>`_.
384
Dean Moldovan27680302017-09-13 19:04:25 +0200385* Fixed implicit conversion of accessors to types derived from ``py::object``.
386 `#1076 <https://github.com/pybind/pybind11/pull/1076>`_.
387
388* The ``name`` in ``PYBIND11_MODULE(name, variable)`` can now be a macro.
389 `#1082 <https://github.com/pybind/pybind11/pull/1082>`_.
390
391* Relaxed overly strict ``py::pickle()`` check for matching get and set types.
392 `#1064 <https://github.com/pybind/pybind11/pull/1064>`_.
393
Dean Moldovan2b4477e2017-09-09 20:21:34 +0200394* Conversion errors now try to be more informative when it's likely that
395 a missing header is the cause (e.g. forgetting ``<pybind11/stl.h>``).
396 `#1077 <https://github.com/pybind/pybind11/pull/1077>`_.
397
Wenzel Jakob2a5a5ec2017-08-31 13:58:24 +0200398v2.2.0 (August 31, 2017)
Wenzel Jakobd405b1b2017-03-22 22:20:07 +0100399-----------------------------------------------------
400
Dean Moldovandb46a892017-08-13 22:25:15 +0200401* Support for embedding the Python interpreter. See the
402 :doc:`documentation page </advanced/embedding>` for a
403 full overview of the new features.
404 `#774 <https://github.com/pybind/pybind11/pull/774>`_,
405 `#889 <https://github.com/pybind/pybind11/pull/889>`_,
406 `#892 <https://github.com/pybind/pybind11/pull/892>`_,
407 `#920 <https://github.com/pybind/pybind11/pull/920>`_.
408
409 .. code-block:: cpp
410
411 #include <pybind11/embed.h>
412 namespace py = pybind11;
413
414 int main() {
415 py::scoped_interpreter guard{}; // start the interpreter and keep it alive
416
417 py::print("Hello, World!"); // use the Python API
418 }
419
420* Support for inheriting from multiple C++ bases in Python.
421 `#693 <https://github.com/pybind/pybind11/pull/693>`_.
422
423 .. code-block:: python
424
425 from cpp_module import CppBase1, CppBase2
426
427 class PyDerived(CppBase1, CppBase2):
428 def __init__(self):
429 CppBase1.__init__(self) # C++ bases must be initialized explicitly
430 CppBase2.__init__(self)
431
432* ``PYBIND11_MODULE`` is now the preferred way to create module entry points.
433 ``PYBIND11_PLUGIN`` is deprecated. See :ref:`macros` for details.
434 `#879 <https://github.com/pybind/pybind11/pull/879>`_.
435
436 .. code-block:: cpp
437
438 // new
439 PYBIND11_MODULE(example, m) {
440 m.def("add", [](int a, int b) { return a + b; });
441 }
442
443 // old
444 PYBIND11_PLUGIN(example) {
445 py::module m("example");
446 m.def("add", [](int a, int b) { return a + b; });
447 return m.ptr();
448 }
449
450* pybind11's headers and build system now more strictly enforce hidden symbol
451 visibility for extension modules. This should be seamless for most users,
Dean Moldovan1fb9df62017-08-18 19:26:49 +0200452 but see the :doc:`upgrade` if you use a custom build system.
453 `#995 <https://github.com/pybind/pybind11/pull/995>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200454
455* Support for ``py::module_local`` types which allow multiple modules to
456 export the same C++ types without conflicts. This is useful for opaque
457 types like ``std::vector<int>``. ``py::bind_vector`` and ``py::bind_map``
458 now default to ``py::module_local`` if their elements are builtins or
459 local types. See :ref:`module_local` for details.
460 `#949 <https://github.com/pybind/pybind11/pull/949>`_,
461 `#981 <https://github.com/pybind/pybind11/pull/981>`_,
462 `#995 <https://github.com/pybind/pybind11/pull/995>`_,
463 `#997 <https://github.com/pybind/pybind11/pull/997>`_.
464
465* Custom constructors can now be added very easily using lambdas or factory
466 functions which return a class instance by value, pointer or holder. This
467 supersedes the old placement-new ``__init__`` technique.
468 See :ref:`custom_constructors` for details.
Dean Moldovan4c540442017-08-30 21:53:08 +0200469 `#805 <https://github.com/pybind/pybind11/pull/805>`_,
470 `#1014 <https://github.com/pybind/pybind11/pull/1014>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200471
472 .. code-block:: cpp
473
474 struct Example {
475 Example(std::string);
476 };
477
478 py::class_<Example>(m, "Example")
479 .def(py::init<std::string>()) // existing constructor
480 .def(py::init([](int n) { // custom constructor
481 return std::make_unique<Example>(std::to_string(n));
482 }));
483
Dean Moldovan1e5a7da2017-08-24 01:53:15 +0200484* Similarly to custom constructors, pickling support functions are now bound
485 using the ``py::pickle()`` adaptor which improves type safety. See the
486 :doc:`upgrade` and :ref:`pickling` for details.
487 `#1038 <https://github.com/pybind/pybind11/pull/1038>`_.
488
Dean Moldovandb46a892017-08-13 22:25:15 +0200489* Builtin support for converting C++17 standard library types and general
490 conversion improvements:
491
492 1. C++17 ``std::variant`` is supported right out of the box. C++11/14
493 equivalents (e.g. ``boost::variant``) can also be added with a simple
494 user-defined specialization. See :ref:`cpp17_container_casters` for details.
495 `#811 <https://github.com/pybind/pybind11/pull/811>`_,
496 `#845 <https://github.com/pybind/pybind11/pull/845>`_,
497 `#989 <https://github.com/pybind/pybind11/pull/989>`_.
498
499 2. Out-of-the-box support for C++17 ``std::string_view``.
500 `#906 <https://github.com/pybind/pybind11/pull/906>`_.
501
502 3. Improved compatibility of the builtin ``optional`` converter.
503 `#874 <https://github.com/pybind/pybind11/pull/874>`_.
504
505 4. The ``bool`` converter now accepts ``numpy.bool_`` and types which
506 define ``__bool__`` (Python 3.x) or ``__nonzero__`` (Python 2.7).
507 `#925 <https://github.com/pybind/pybind11/pull/925>`_.
508
509 5. C++-to-Python casters are now more efficient and move elements out
510 of rvalue containers whenever possible.
511 `#851 <https://github.com/pybind/pybind11/pull/851>`_,
512 `#936 <https://github.com/pybind/pybind11/pull/936>`_,
513 `#938 <https://github.com/pybind/pybind11/pull/938>`_.
514
515 6. Fixed ``bytes`` to ``std::string/char*`` conversion on Python 3.
516 `#817 <https://github.com/pybind/pybind11/pull/817>`_.
517
518 7. Fixed lifetime of temporary C++ objects created in Python-to-C++ conversions.
519 `#924 <https://github.com/pybind/pybind11/pull/924>`_.
520
Henry Schreiner8b405052017-08-24 17:12:43 -0700521* Scope guard call policy for RAII types, e.g. ``py::call_guard<py::gil_scoped_release>()``,
522 ``py::call_guard<py::scoped_ostream_redirect>()``. See :ref:`call_policies` for details.
Dean Moldovandb46a892017-08-13 22:25:15 +0200523 `#740 <https://github.com/pybind/pybind11/pull/740>`_.
524
Henry Schreiner8b405052017-08-24 17:12:43 -0700525* Utility for redirecting C++ streams to Python (e.g. ``std::cout`` ->
526 ``sys.stdout``). Scope guard ``py::scoped_ostream_redirect`` in C++ and
527 a context manager in Python. See :ref:`ostream_redirect`.
528 `#1009 <https://github.com/pybind/pybind11/pull/1009>`_.
529
Dean Moldovandb46a892017-08-13 22:25:15 +0200530* Improved handling of types and exceptions across module boundaries.
531 `#915 <https://github.com/pybind/pybind11/pull/915>`_,
532 `#951 <https://github.com/pybind/pybind11/pull/951>`_,
533 `#995 <https://github.com/pybind/pybind11/pull/995>`_.
534
535* Fixed destruction order of ``py::keep_alive`` nurse/patient objects
536 in reference cycles.
537 `#856 <https://github.com/pybind/pybind11/pull/856>`_.
538
539* Numpy and buffer protocol related improvements:
540
541 1. Support for negative strides in Python buffer objects/numpy arrays. This
542 required changing integers from unsigned to signed for the related C++ APIs.
543 Note: If you have compiler warnings enabled, you may notice some new conversion
544 warnings after upgrading. These can be resolved with ``static_cast``.
545 `#782 <https://github.com/pybind/pybind11/pull/782>`_.
546
547 2. Support ``std::complex`` and arrays inside ``PYBIND11_NUMPY_DTYPE``.
548 `#831 <https://github.com/pybind/pybind11/pull/831>`_,
549 `#832 <https://github.com/pybind/pybind11/pull/832>`_.
550
551 3. Support for constructing ``py::buffer_info`` and ``py::arrays`` using
552 arbitrary containers or iterators instead of requiring a ``std::vector``.
553 `#788 <https://github.com/pybind/pybind11/pull/788>`_,
554 `#822 <https://github.com/pybind/pybind11/pull/822>`_,
555 `#860 <https://github.com/pybind/pybind11/pull/860>`_.
556
557 4. Explicitly check numpy version and require >= 1.7.0.
558 `#819 <https://github.com/pybind/pybind11/pull/819>`_.
559
560* Support for allowing/prohibiting ``None`` for specific arguments and improved
561 ``None`` overload resolution order. See :ref:`none_arguments` for details.
562 `#843 <https://github.com/pybind/pybind11/pull/843>`_.
563 `#859 <https://github.com/pybind/pybind11/pull/859>`_.
564
565* Added ``py::exec()`` as a shortcut for ``py::eval<py::eval_statements>()``
566 and support for C++11 raw string literals as input. See :ref:`eval`.
567 `#766 <https://github.com/pybind/pybind11/pull/766>`_,
568 `#827 <https://github.com/pybind/pybind11/pull/827>`_.
569
570* ``py::vectorize()`` ignores non-vectorizable arguments and supports
571 member functions.
572 `#762 <https://github.com/pybind/pybind11/pull/762>`_.
573
574* Support for bound methods as callbacks (``pybind11/functional.h``).
575 `#815 <https://github.com/pybind/pybind11/pull/815>`_.
576
577* Allow aliasing pybind11 methods: ``cls.attr("foo") = cls.attr("bar")``.
578 `#802 <https://github.com/pybind/pybind11/pull/802>`_.
579
580* Don't allow mixed static/non-static overloads.
581 `#804 <https://github.com/pybind/pybind11/pull/804>`_.
582
583* Fixed overriding static properties in derived classes.
584 `#784 <https://github.com/pybind/pybind11/pull/784>`_.
585
Wenzel Jakobcf36e3d2019-06-11 22:03:10 +0200586* Added support for write only properties.
587 `#1144 <https://github.com/pybind/pybind11/pull/1144>`_.
588
Dean Moldovan4c540442017-08-30 21:53:08 +0200589* Improved deduction of member functions of a derived class when its bases
590 aren't registered with pybind11.
Dean Moldovandb46a892017-08-13 22:25:15 +0200591 `#855 <https://github.com/pybind/pybind11/pull/855>`_.
592
593 .. code-block:: cpp
594
595 struct Base {
596 int foo() { return 42; }
597 }
598
599 struct Derived : Base {}
600
601 // Now works, but previously required also binding `Base`
602 py::class_<Derived>(m, "Derived")
603 .def("foo", &Derived::foo); // function is actually from `Base`
604
Wenzel Jakobb12a9d62017-08-23 16:30:56 +0200605* The implementation of ``py::init<>`` now uses C++11 brace initialization
606 syntax to construct instances, which permits binding implicit constructors of
607 aggregate types. `#1015 <https://github.com/pybind/pybind11/pull/1015>`_.
608
609 .. code-block:: cpp
610
611 struct Aggregate {
612 int a;
613 std::string b;
614 };
615
616 py::class_<Aggregate>(m, "Aggregate")
617 .def(py::init<int, const std::string &>());
618
Dean Moldovandb46a892017-08-13 22:25:15 +0200619* Fixed issues with multiple inheritance with offset base/derived pointers.
620 `#812 <https://github.com/pybind/pybind11/pull/812>`_,
621 `#866 <https://github.com/pybind/pybind11/pull/866>`_,
622 `#960 <https://github.com/pybind/pybind11/pull/960>`_.
623
Dean Moldovan4c540442017-08-30 21:53:08 +0200624* Fixed reference leak of type objects.
625 `#1030 <https://github.com/pybind/pybind11/pull/1030>`_.
626
Dean Moldovandb46a892017-08-13 22:25:15 +0200627* Improved support for the ``/std:c++14`` and ``/std:c++latest`` modes
628 on MSVC 2017.
629 `#841 <https://github.com/pybind/pybind11/pull/841>`_,
630 `#999 <https://github.com/pybind/pybind11/pull/999>`_.
631
632* Fixed detection of private operator new on MSVC.
633 `#893 <https://github.com/pybind/pybind11/pull/893>`_,
634 `#918 <https://github.com/pybind/pybind11/pull/918>`_.
635
636* Intel C++ compiler compatibility fixes.
637 `#937 <https://github.com/pybind/pybind11/pull/937>`_.
638
639* Fixed implicit conversion of `py::enum_` to integer types on Python 2.7.
640 `#821 <https://github.com/pybind/pybind11/pull/821>`_.
641
Bruce Merry37de2da2017-08-30 14:22:00 +0200642* Added ``py::hash`` to fetch the hash value of Python objects, and
643 ``.def(hash(py::self))`` to provide the C++ ``std::hash`` as the Python
644 ``__hash__`` method.
645 `#1034 <https://github.com/pybind/pybind11/pull/1034>`_.
646
Dean Moldovandb46a892017-08-13 22:25:15 +0200647* Fixed ``__truediv__`` on Python 2 and ``__itruediv__`` on Python 3.
648 `#867 <https://github.com/pybind/pybind11/pull/867>`_.
649
650* ``py::capsule`` objects now support the ``name`` attribute. This is useful
651 for interfacing with ``scipy.LowLevelCallable``.
652 `#902 <https://github.com/pybind/pybind11/pull/902>`_.
653
654* Fixed ``py::make_iterator``'s ``__next__()`` for past-the-end calls.
655 `#897 <https://github.com/pybind/pybind11/pull/897>`_.
656
657* Added ``error_already_set::matches()`` for checking Python exceptions.
658 `#772 <https://github.com/pybind/pybind11/pull/772>`_.
659
660* Deprecated ``py::error_already_set::clear()``. It's no longer needed
661 following a simplification of the ``py::error_already_set`` class.
662 `#954 <https://github.com/pybind/pybind11/pull/954>`_.
663
664* Deprecated ``py::handle::operator==()`` in favor of ``py::handle::is()``
665 `#825 <https://github.com/pybind/pybind11/pull/825>`_.
666
667* Deprecated ``py::object::borrowed``/``py::object::stolen``.
668 Use ``py::object::borrowed_t{}``/``py::object::stolen_t{}`` instead.
669 `#771 <https://github.com/pybind/pybind11/pull/771>`_.
670
Dean Moldovan4c540442017-08-30 21:53:08 +0200671* Changed internal data structure versioning to avoid conflicts between
672 modules compiled with different revisions of pybind11.
673 `#1012 <https://github.com/pybind/pybind11/pull/1012>`_.
674
Dean Moldovandb46a892017-08-13 22:25:15 +0200675* Additional compile-time and run-time error checking and more informative messages.
676 `#786 <https://github.com/pybind/pybind11/pull/786>`_,
677 `#794 <https://github.com/pybind/pybind11/pull/794>`_,
678 `#803 <https://github.com/pybind/pybind11/pull/803>`_.
679
680* Various minor improvements and fixes.
681 `#764 <https://github.com/pybind/pybind11/pull/764>`_,
682 `#791 <https://github.com/pybind/pybind11/pull/791>`_,
683 `#795 <https://github.com/pybind/pybind11/pull/795>`_,
684 `#840 <https://github.com/pybind/pybind11/pull/840>`_,
685 `#844 <https://github.com/pybind/pybind11/pull/844>`_,
686 `#846 <https://github.com/pybind/pybind11/pull/846>`_,
687 `#849 <https://github.com/pybind/pybind11/pull/849>`_,
688 `#858 <https://github.com/pybind/pybind11/pull/858>`_,
689 `#862 <https://github.com/pybind/pybind11/pull/862>`_,
690 `#871 <https://github.com/pybind/pybind11/pull/871>`_,
691 `#872 <https://github.com/pybind/pybind11/pull/872>`_,
692 `#881 <https://github.com/pybind/pybind11/pull/881>`_,
693 `#888 <https://github.com/pybind/pybind11/pull/888>`_,
694 `#899 <https://github.com/pybind/pybind11/pull/899>`_,
695 `#928 <https://github.com/pybind/pybind11/pull/928>`_,
696 `#931 <https://github.com/pybind/pybind11/pull/931>`_,
697 `#944 <https://github.com/pybind/pybind11/pull/944>`_,
698 `#950 <https://github.com/pybind/pybind11/pull/950>`_,
699 `#952 <https://github.com/pybind/pybind11/pull/952>`_,
700 `#962 <https://github.com/pybind/pybind11/pull/962>`_,
701 `#965 <https://github.com/pybind/pybind11/pull/965>`_,
702 `#970 <https://github.com/pybind/pybind11/pull/970>`_,
Dean Moldovandb46a892017-08-13 22:25:15 +0200703 `#978 <https://github.com/pybind/pybind11/pull/978>`_,
Dean Moldovan4c540442017-08-30 21:53:08 +0200704 `#979 <https://github.com/pybind/pybind11/pull/979>`_,
Wenzel Jakoba1041192017-08-28 16:35:32 +0200705 `#986 <https://github.com/pybind/pybind11/pull/986>`_,
Dean Moldovan4c540442017-08-30 21:53:08 +0200706 `#1020 <https://github.com/pybind/pybind11/pull/1020>`_,
707 `#1027 <https://github.com/pybind/pybind11/pull/1027>`_,
Wenzel Jakoba1041192017-08-28 16:35:32 +0200708 `#1037 <https://github.com/pybind/pybind11/pull/1037>`_.
Dean Moldovandb46a892017-08-13 22:25:15 +0200709
710* Testing improvements.
711 `#798 <https://github.com/pybind/pybind11/pull/798>`_,
712 `#882 <https://github.com/pybind/pybind11/pull/882>`_,
713 `#898 <https://github.com/pybind/pybind11/pull/898>`_,
714 `#900 <https://github.com/pybind/pybind11/pull/900>`_,
715 `#921 <https://github.com/pybind/pybind11/pull/921>`_,
716 `#923 <https://github.com/pybind/pybind11/pull/923>`_,
717 `#963 <https://github.com/pybind/pybind11/pull/963>`_.
718
Wenzel Jakobdb200952017-04-07 02:03:46 +0200719v2.1.1 (April 7, 2017)
720-----------------------------------------------------
721
722* Fixed minimum version requirement for MSVC 2015u3
723 `#773 <https://github.com/pybind/pybind11/pull/773>`_.
724
Wenzel Jakobd405b1b2017-03-22 22:20:07 +0100725v2.1.0 (March 22, 2017)
Wenzel Jakoba9730be2017-01-06 14:18:44 +0100726-----------------------------------------------------
727
Wenzel Jakob62e5fef2017-03-22 22:07:45 +0100728* pybind11 now performs function overload resolution in two phases. The first
729 phase only considers exact type matches, while the second allows for implicit
730 conversions to take place. A special ``noconvert()`` syntax can be used to
731 completely disable implicit conversions for specific arguments.
732 `#643 <https://github.com/pybind/pybind11/pull/643>`_,
733 `#634 <https://github.com/pybind/pybind11/pull/634>`_,
734 `#650 <https://github.com/pybind/pybind11/pull/650>`_.
735
736* Fixed a regression where static properties no longer worked with classes
737 using multiple inheritance. The ``py::metaclass`` attribute is no longer
738 necessary (and deprecated as of this release) when binding classes with
739 static properties.
740 `#679 <https://github.com/pybind/pybind11/pull/679>`_,
741
742* Classes bound using ``pybind11`` can now use custom metaclasses.
743 `#679 <https://github.com/pybind/pybind11/pull/679>`_,
744
745* ``py::args`` and ``py::kwargs`` can now be mixed with other positional
746 arguments when binding functions using pybind11.
747 `#611 <https://github.com/pybind/pybind11/pull/611>`_.
748
749* Improved support for C++11 unicode string and character types; added
750 extensive documentation regarding pybind11's string conversion behavior.
751 `#624 <https://github.com/pybind/pybind11/pull/624>`_,
752 `#636 <https://github.com/pybind/pybind11/pull/636>`_,
753 `#715 <https://github.com/pybind/pybind11/pull/715>`_.
754
755* pybind11 can now avoid expensive copies when converting Eigen arrays to NumPy
756 arrays (and vice versa). `#610 <https://github.com/pybind/pybind11/pull/610>`_.
757
758* The "fast path" in ``py::vectorize`` now works for any full-size group of C or
759 F-contiguous arrays. The non-fast path is also faster since it no longer performs
760 copies of the input arguments (except when type conversions are necessary).
761 `#610 <https://github.com/pybind/pybind11/pull/610>`_.
762
763* Added fast, unchecked access to NumPy arrays via a proxy object.
764 `#746 <https://github.com/pybind/pybind11/pull/746>`_.
765
Wenzel Jakob0d929382017-03-22 22:52:29 +0100766* Transparent support for class-specific ``operator new`` and
Wenzel Jakob62e5fef2017-03-22 22:07:45 +0100767 ``operator delete`` implementations.
768 `#755 <https://github.com/pybind/pybind11/pull/755>`_.
769
770* Slimmer and more efficient STL-compatible iterator interface for sequence types.
771 `#662 <https://github.com/pybind/pybind11/pull/662>`_.
772
773* Improved custom holder type support.
774 `#607 <https://github.com/pybind/pybind11/pull/607>`_.
775
776* ``nullptr`` to ``None`` conversion fixed in various builtin type casters.
777 `#732 <https://github.com/pybind/pybind11/pull/732>`_.
778
779* ``enum_`` now exposes its members via a special ``__members__`` attribute.
780 `#666 <https://github.com/pybind/pybind11/pull/666>`_.
781
782* ``std::vector`` bindings created using ``stl_bind.h`` can now optionally
783 implement the buffer protocol. `#488 <https://github.com/pybind/pybind11/pull/488>`_.
784
785* Automated C++ reference documentation using doxygen and breathe.
786 `#598 <https://github.com/pybind/pybind11/pull/598>`_.
787
788* Added minimum compiler version assertions.
789 `#727 <https://github.com/pybind/pybind11/pull/727>`_.
790
791* Improved compatibility with C++1z.
792 `#677 <https://github.com/pybind/pybind11/pull/677>`_.
793
794* Improved ``py::capsule`` API. Can be used to implement cleanup
795 callbacks that are involved at module destruction time.
796 `#752 <https://github.com/pybind/pybind11/pull/752>`_.
797
798* Various minor improvements and fixes.
799 `#595 <https://github.com/pybind/pybind11/pull/595>`_,
800 `#588 <https://github.com/pybind/pybind11/pull/588>`_,
801 `#589 <https://github.com/pybind/pybind11/pull/589>`_,
802 `#603 <https://github.com/pybind/pybind11/pull/603>`_,
803 `#619 <https://github.com/pybind/pybind11/pull/619>`_,
804 `#648 <https://github.com/pybind/pybind11/pull/648>`_,
805 `#695 <https://github.com/pybind/pybind11/pull/695>`_,
806 `#720 <https://github.com/pybind/pybind11/pull/720>`_,
807 `#723 <https://github.com/pybind/pybind11/pull/723>`_,
808 `#729 <https://github.com/pybind/pybind11/pull/729>`_,
809 `#724 <https://github.com/pybind/pybind11/pull/724>`_,
810 `#742 <https://github.com/pybind/pybind11/pull/742>`_,
811 `#753 <https://github.com/pybind/pybind11/pull/753>`_.
Wenzel Jakoba9730be2017-01-06 14:18:44 +0100812
Wenzel Jakobf8dafe92017-01-04 15:09:49 +0100813v2.0.1 (Jan 4, 2017)
814-----------------------------------------------------
815
816* Fix pointer to reference error in type_caster on MSVC
817 `#583 <https://github.com/pybind/pybind11/pull/583>`_.
818
819* Fixed a segmentation in the test suite due to a typo
820 `cd7eac <https://github.com/pybind/pybind11/commit/cd7eac>`_.
821
Wenzel Jakobe33ef9c2017-01-01 13:55:06 +0100822v2.0.0 (Jan 1, 2017)
Wenzel Jakobed52f462016-12-26 13:18:26 +0100823-----------------------------------------------------
824
825* Fixed a reference counting regression affecting types with custom metaclasses
826 (introduced in v2.0.0-rc1).
827 `#571 <https://github.com/pybind/pybind11/pull/571>`_.
828
829* Quenched a CMake policy warning.
830 `#570 <https://github.com/pybind/pybind11/pull/570>`_.
831
Wenzel Jakobe33ef9c2017-01-01 13:55:06 +0100832v2.0.0-rc1 (Dec 23, 2016)
Wenzel Jakobf88af0c2016-06-22 13:52:31 +0200833-----------------------------------------------------
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +0200834
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100835The pybind11 developers are excited to issue a release candidate of pybind11
836with a subsequent v2.0.0 release planned in early January next year.
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +0200837
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100838An incredible amount of effort by went into pybind11 over the last ~5 months,
839leading to a release that is jam-packed with exciting new features and numerous
Wenzel Jakobf8dafe92017-01-04 15:09:49 +0100840usability improvements. The following list links PRs or individual commits
Wenzel Jakobed52f462016-12-26 13:18:26 +0100841whenever applicable.
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100842
843Happy Christmas!
844
845* Support for binding C++ class hierarchies that make use of multiple
846 inheritance. `#410 <https://github.com/pybind/pybind11/pull/410>`_.
847
848* PyPy support: pybind11 now supports nightly builds of PyPy and will
849 interoperate with the future 5.7 release. No code changes are necessary,
850 everything "just" works as usual. Note that we only target the Python 2.7
851 branch for now; support for 3.x will be added once its ``cpyext`` extension
Wenzel Jakobed52f462016-12-26 13:18:26 +0100852 support catches up. A few minor features remain unsupported for the time
853 being (notably dynamic attributes in custom types).
854 `#527 <https://github.com/pybind/pybind11/pull/527>`_.
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100855
luzpaz4b874612018-05-06 13:54:10 +0000856* Significant work on the documentation -- in particular, the monolithic
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100857 ``advanced.rst`` file was restructured into a easier to read hierarchical
858 organization. `#448 <https://github.com/pybind/pybind11/pull/448>`_.
859
860* Many NumPy-related improvements:
861
862 1. Object-oriented API to access and modify NumPy ``ndarray`` instances,
863 replicating much of the corresponding NumPy C API functionality.
864 `#402 <https://github.com/pybind/pybind11/pull/402>`_.
865
866 2. NumPy array ``dtype`` array descriptors are now first-class citizens and
867 are exposed via a new class ``py::dtype``.
868
869 3. Structured dtypes can be registered using the ``PYBIND11_NUMPY_DTYPE()``
870 macro. Special ``array`` constructors accepting dtype objects were also
871 added.
872
873 One potential caveat involving this change: format descriptor strings
874 should now be accessed via ``format_descriptor::format()`` (however, for
875 compatibility purposes, the old syntax ``format_descriptor::value`` will
876 still work for non-structured data types). `#308
877 <https://github.com/pybind/pybind11/pull/308>`_.
878
879 4. Further improvements to support structured dtypes throughout the system.
880 `#472 <https://github.com/pybind/pybind11/pull/472>`_,
881 `#474 <https://github.com/pybind/pybind11/pull/474>`_,
882 `#459 <https://github.com/pybind/pybind11/pull/459>`_,
883 `#453 <https://github.com/pybind/pybind11/pull/453>`_,
884 `#452 <https://github.com/pybind/pybind11/pull/452>`_, and
885 `#505 <https://github.com/pybind/pybind11/pull/505>`_.
886
887 5. Fast access operators. `#497 <https://github.com/pybind/pybind11/pull/497>`_.
888
889 6. Constructors for arrays whose storage is owned by another object.
890 `#440 <https://github.com/pybind/pybind11/pull/440>`_.
891
892 7. Added constructors for ``array`` and ``array_t`` explicitly accepting shape
893 and strides; if strides are not provided, they are deduced assuming
894 C-contiguity. Also added simplified constructors for 1-dimensional case.
895
896 8. Added buffer/NumPy support for ``char[N]`` and ``std::array<char, N>`` types.
897
898 9. Added ``memoryview`` wrapper type which is constructible from ``buffer_info``.
899
900* Eigen: many additional conversions and support for non-contiguous
901 arrays/slices.
902 `#427 <https://github.com/pybind/pybind11/pull/427>`_,
903 `#315 <https://github.com/pybind/pybind11/pull/315>`_,
904 `#316 <https://github.com/pybind/pybind11/pull/316>`_,
905 `#312 <https://github.com/pybind/pybind11/pull/312>`_, and
906 `#267 <https://github.com/pybind/pybind11/pull/267>`_
907
908* Incompatible changes in ``class_<...>::class_()``:
909
910 1. Declarations of types that provide access via the buffer protocol must
911 now include the ``py::buffer_protocol()`` annotation as an argument to
912 the ``class_`` constructor.
913
914 2. Declarations of types that require a custom metaclass (i.e. all classes
915 which include static properties via commands such as
916 ``def_readwrite_static()``) must now include the ``py::metaclass()``
917 annotation as an argument to the ``class_`` constructor.
918
919 These two changes were necessary to make type definitions in pybind11
920 future-proof, and to support PyPy via its cpyext mechanism. `#527
921 <https://github.com/pybind/pybind11/pull/527>`_.
922
923
luzpaz4b874612018-05-06 13:54:10 +0000924 3. This version of pybind11 uses a redesigned mechanism for instantiating
925 trampoline classes that are used to override virtual methods from within
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100926 Python. This led to the following user-visible syntax change: instead of
927
928 .. code-block:: cpp
929
930 py::class_<TrampolineClass>("MyClass")
931 .alias<MyClass>()
932 ....
933
934 write
935
936 .. code-block:: cpp
937
938 py::class_<MyClass, TrampolineClass>("MyClass")
939 ....
940
941 Importantly, both the original and the trampoline class are now
942 specified as an arguments (in arbitrary order) to the ``py::class_``
943 template, and the ``alias<..>()`` call is gone. The new scheme has zero
944 overhead in cases when Python doesn't override any functions of the
945 underlying C++ class. `rev. 86d825
946 <https://github.com/pybind/pybind11/commit/86d825>`_.
947
Wenzel Jakobe6b2f752016-07-10 10:54:46 +0200948* Added ``eval`` and ``eval_file`` functions for evaluating expressions and
Wenzel Jakobd3549d62016-12-23 16:01:04 +0100949 statements from a string or file. `rev. 0d3fc3
950 <https://github.com/pybind/pybind11/commit/0d3fc3>`_.
951
952* pybind11 can now create types with a modifiable dictionary.
953 `#437 <https://github.com/pybind/pybind11/pull/437>`_ and
954 `#444 <https://github.com/pybind/pybind11/pull/444>`_.
955
956* Support for translation of arbitrary C++ exceptions to Python counterparts.
957 `#296 <https://github.com/pybind/pybind11/pull/296>`_ and
958 `#273 <https://github.com/pybind/pybind11/pull/273>`_.
959
960* Report full backtraces through mixed C++/Python code, better reporting for
961 import errors, fixed GIL management in exception processing.
962 `#537 <https://github.com/pybind/pybind11/pull/537>`_,
963 `#494 <https://github.com/pybind/pybind11/pull/494>`_,
964 `rev. e72d95 <https://github.com/pybind/pybind11/commit/e72d95>`_, and
965 `rev. 099d6e <https://github.com/pybind/pybind11/commit/099d6e>`_.
966
967* Support for bit-level operations, comparisons, and serialization of C++
968 enumerations. `#503 <https://github.com/pybind/pybind11/pull/503>`_,
969 `#508 <https://github.com/pybind/pybind11/pull/508>`_,
970 `#380 <https://github.com/pybind/pybind11/pull/380>`_,
971 `#309 <https://github.com/pybind/pybind11/pull/309>`_.
972 `#311 <https://github.com/pybind/pybind11/pull/311>`_.
973
974* The ``class_`` constructor now accepts its template arguments in any order.
975 `#385 <https://github.com/pybind/pybind11/pull/385>`_.
976
977* Attribute and item accessors now have a more complete interface which makes
978 it possible to chain attributes as in
979 ``obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)``. `#425
980 <https://github.com/pybind/pybind11/pull/425>`_.
981
982* Major redesign of the default and conversion constructors in ``pytypes.h``.
983 `#464 <https://github.com/pybind/pybind11/pull/464>`_.
984
985* Added built-in support for ``std::shared_ptr`` holder type. It is no longer
986 necessary to to include a declaration of the form
987 ``PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>)`` (though continuing to
988 do so won't cause an error).
989 `#454 <https://github.com/pybind/pybind11/pull/454>`_.
990
991* New ``py::overload_cast`` casting operator to select among multiple possible
992 overloads of a function. An example:
993
994 .. code-block:: cpp
995
996 py::class_<Pet>(m, "Pet")
997 .def("set", py::overload_cast<int>(&Pet::set), "Set the pet's age")
998 .def("set", py::overload_cast<const std::string &>(&Pet::set), "Set the pet's name");
999
1000 This feature only works on C++14-capable compilers.
1001 `#541 <https://github.com/pybind/pybind11/pull/541>`_.
1002
1003* C++ types are automatically cast to Python types, e.g. when assigning
1004 them as an attribute. For instance, the following is now legal:
1005
1006 .. code-block:: cpp
1007
1008 py::module m = /* ... */
1009 m.attr("constant") = 123;
1010
1011 (Previously, a ``py::cast`` call was necessary to avoid a compilation error.)
1012 `#551 <https://github.com/pybind/pybind11/pull/551>`_.
1013
1014* Redesigned ``pytest``-based test suite. `#321 <https://github.com/pybind/pybind11/pull/321>`_.
1015
1016* Instance tracking to detect reference leaks in test suite. `#324 <https://github.com/pybind/pybind11/pull/324>`_
1017
1018* pybind11 can now distinguish between multiple different instances that are
1019 located at the same memory address, but which have different types.
1020 `#329 <https://github.com/pybind/pybind11/pull/329>`_.
1021
1022* Improved logic in ``move`` return value policy.
1023 `#510 <https://github.com/pybind/pybind11/pull/510>`_,
1024 `#297 <https://github.com/pybind/pybind11/pull/297>`_.
1025
1026* Generalized unpacking API to permit calling Python functions from C++ using
1027 notation such as ``foo(a1, a2, *args, "ka"_a=1, "kb"_a=2, **kwargs)``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
1028
1029* ``py::print()`` function whose behavior matches that of the native Python
1030 ``print()`` function. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
1031
1032* Added ``py::dict`` keyword constructor:``auto d = dict("number"_a=42,
1033 "name"_a="World");``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
1034
1035* Added ``py::str::format()`` method and ``_s`` literal: ``py::str s = "1 + 2
1036 = {}"_s.format(3);``. `#372 <https://github.com/pybind/pybind11/pull/372>`_.
1037
1038* Added ``py::repr()`` function which is equivalent to Python's builtin
1039 ``repr()``. `#333 <https://github.com/pybind/pybind11/pull/333>`_.
1040
1041* Improved construction and destruction logic for holder types. It is now
1042 possible to reference instances with smart pointer holder types without
1043 constructing the holder if desired. The ``PYBIND11_DECLARE_HOLDER_TYPE``
1044 macro now accepts an optional second parameter to indicate whether the holder
1045 type uses intrusive reference counting.
1046 `#533 <https://github.com/pybind/pybind11/pull/533>`_ and
1047 `#561 <https://github.com/pybind/pybind11/pull/561>`_.
1048
1049* Mapping a stateless C++ function to Python and back is now "for free" (i.e.
1050 no extra indirections or argument conversion overheads). `rev. 954b79
1051 <https://github.com/pybind/pybind11/commit/954b79>`_.
1052
1053* Bindings for ``std::valarray<T>``.
1054 `#545 <https://github.com/pybind/pybind11/pull/545>`_.
1055
1056* Improved support for C++17 capable compilers.
1057 `#562 <https://github.com/pybind/pybind11/pull/562>`_.
1058
1059* Bindings for ``std::optional<t>``.
1060 `#475 <https://github.com/pybind/pybind11/pull/475>`_,
1061 `#476 <https://github.com/pybind/pybind11/pull/476>`_,
1062 `#479 <https://github.com/pybind/pybind11/pull/479>`_,
1063 `#499 <https://github.com/pybind/pybind11/pull/499>`_, and
1064 `#501 <https://github.com/pybind/pybind11/pull/501>`_.
1065
1066* ``stl_bind.h``: general improvements and support for ``std::map`` and
1067 ``std::unordered_map``.
1068 `#490 <https://github.com/pybind/pybind11/pull/490>`_,
1069 `#282 <https://github.com/pybind/pybind11/pull/282>`_,
1070 `#235 <https://github.com/pybind/pybind11/pull/235>`_.
1071
1072* The ``std::tuple``, ``std::pair``, ``std::list``, and ``std::vector`` type
1073 casters now accept any Python sequence type as input. `rev. 107285
1074 <https://github.com/pybind/pybind11/commit/107285>`_.
1075
1076* Improved CMake Python detection on multi-architecture Linux.
1077 `#532 <https://github.com/pybind/pybind11/pull/532>`_.
1078
1079* Infrastructure to selectively disable or enable parts of the automatically
1080 generated docstrings. `#486 <https://github.com/pybind/pybind11/pull/486>`_.
1081
1082* ``reference`` and ``reference_internal`` are now the default return value
1083 properties for static and non-static properties, respectively. `#473
1084 <https://github.com/pybind/pybind11/pull/473>`_. (the previous defaults
1085 were ``automatic``). `#473 <https://github.com/pybind/pybind11/pull/473>`_.
1086
1087* Support for ``std::unique_ptr`` with non-default deleters or no deleter at
1088 all (``py::nodelete``). `#384 <https://github.com/pybind/pybind11/pull/384>`_.
1089
Wenzel Jakob3c796712016-12-23 16:19:36 +01001090* Deprecated ``handle::call()`` method. The new syntax to call Python
1091 functions is simply ``handle()``. It can also be invoked explicitly via
Wenzel Jakobd3549d62016-12-23 16:01:04 +01001092 ``handle::operator<X>()``, where ``X`` is an optional return value policy.
1093
1094* Print more informative error messages when ``make_tuple()`` or ``cast()``
1095 fail. `#262 <https://github.com/pybind/pybind11/pull/262>`_.
1096
1097* Creation of holder types for classes deriving from
1098 ``std::enable_shared_from_this<>`` now also works for ``const`` values.
1099 `#260 <https://github.com/pybind/pybind11/pull/260>`_.
1100
1101* ``make_iterator()`` improvements for better compatibility with various
1102 types (now uses prefix increment operator); it now also accepts iterators
1103 with different begin/end types as long as they are equality comparable.
1104 `#247 <https://github.com/pybind/pybind11/pull/247>`_.
1105
1106* ``arg()`` now accepts a wider range of argument types for default values.
1107 `#244 <https://github.com/pybind/pybind11/pull/244>`_.
1108
1109* Support ``keep_alive`` where the nurse object may be ``None``. `#341
1110 <https://github.com/pybind/pybind11/pull/341>`_.
1111
1112* Added constructors for ``str`` and ``bytes`` from zero-terminated char
1113 pointers, and from char pointers and length. Added constructors for ``str``
1114 from ``bytes`` and for ``bytes`` from ``str``, which will perform UTF-8
1115 decoding/encoding as required.
1116
1117* Many other improvements of library internals without user-visible changes
1118
Wenzel Jakoba720a602016-07-12 18:02:13 +02001119
11201.8.1 (July 12, 2016)
1121----------------------
Wenzel Jakobc47d4982016-07-11 23:40:28 +02001122* Fixed a rare but potentially very severe issue when the garbage collector ran
1123 during pybind11 type creation.
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001124
Wenzel Jakobf9502152016-06-14 15:00:46 +020011251.8.0 (June 14, 2016)
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001126----------------------
1127* Redesigned CMake build system which exports a convenient
1128 ``pybind11_add_module`` function to parent projects.
1129* ``std::vector<>`` type bindings analogous to Boost.Python's ``indexing_suite``
1130* Transparent conversion of sparse and dense Eigen matrices and vectors (``eigen.h``)
1131* Added an ``ExtraFlags`` template argument to the NumPy ``array_t<>`` wrapper
1132 to disable an enforced cast that may lose precision, e.g. to create overloads
1133 for different precisions and complex vs real-valued matrices.
Wenzel Jakob3f200fa2016-05-17 15:35:29 +02001134* Prevent implicit conversion of floating point values to integral types in
1135 function arguments
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001136* Fixed incorrect default return value policy for functions returning a shared
1137 pointer
Wenzel Jakob38d8b8c2016-05-31 09:53:28 +02001138* Don't allow registering a type via ``class_`` twice
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001139* Don't allow casting a ``None`` value into a C++ lvalue reference
1140* Fixed a crash in ``enum_::operator==`` that was triggered by the ``help()`` command
1141* Improved detection of whether or not custom C++ types can be copy/move-constructed
1142* Extended ``str`` type to also work with ``bytes`` instances
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001143* Added a ``"name"_a`` user defined string literal that is equivalent to ``py::arg("name")``.
1144* When specifying function arguments via ``py::arg``, the test that verifies
1145 the number of arguments now runs at compile time.
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001146* Added ``[[noreturn]]`` attribute to ``pybind11_fail()`` to quench some
1147 compiler warnings
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001148* List function arguments in exception text when the dispatch code cannot find
1149 a matching overload
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001150* Added ``PYBIND11_OVERLOAD_NAME`` and ``PYBIND11_OVERLOAD_PURE_NAME`` macros which
Wenzel Jakobf9502152016-06-14 15:00:46 +02001151 can be used to override virtual methods whose name differs in C++ and Python
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001152 (e.g. ``__call__`` and ``operator()``)
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001153* Various minor ``iterator`` and ``make_iterator()`` improvements
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001154* Transparently support ``__bool__`` on Python 2.x and Python 3.x
1155* Fixed issue with destructor of unpickled object not being called
Wenzel Jakob163ac2e2016-05-03 14:16:18 +02001156* Minor CMake build system improvements on Windows
Wenzel Jakob86d825f2016-05-26 13:19:27 +02001157* New ``pybind11::args`` and ``pybind11::kwargs`` types to create functions which
1158 take an arbitrary number of arguments and keyword arguments
1159* New syntax to call a Python function from C++ using ``*args`` and ``*kwargs``
Wenzel Jakob1cbe7ef2016-06-14 14:55:10 +02001160* The functions ``def_property_*`` now correctly process docstring arguments (these
1161 formerly caused a segmentation fault)
1162* Many ``mkdoc.py`` improvements (enumerations, template arguments, ``DOC()``
1163 macro accepts more arguments)
1164* Cygwin support
1165* Documentation improvements (pickling support, ``keep_alive``, macro usage)
Wenzel Jakobc4d7ccd2016-04-30 22:00:44 +02001166
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +020011671.7 (April 30, 2016)
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +02001168----------------------
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001169* Added a new ``move`` return value policy that triggers C++11 move semantics.
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001170 The automatic return value policy falls back to this case whenever a rvalue
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001171 reference is encountered
Wenzel Jakobe84f5572016-04-26 23:19:19 +02001172* Significantly more general GIL state routines that are used instead of
1173 Python's troublesome ``PyGILState_Ensure`` and ``PyGILState_Release`` API
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001174* Redesign of opaque types that drastically simplifies their usage
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +02001175* Extended ability to pass values of type ``[const] void *``
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001176* ``keep_alive`` fix: don't fail when there is no patient
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001177* ``functional.h``: acquire the GIL before calling a Python function
Wenzel Jakob1ac22e32016-04-25 23:25:40 +02001178* Added Python RAII type wrappers ``none`` and ``iterable``
1179* Added ``*args`` and ``*kwargs`` pass-through parameters to
1180 ``pybind11.get_include()`` function
Wenzel Jakobdd7ec342016-04-29 10:06:24 +02001181* Iterator improvements and fixes
1182* Documentation on return value policies and opaque types improved
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +02001183
Wenzel Jakobe70b2ab2016-04-30 19:58:33 +020011841.6 (April 30, 2016)
1185----------------------
1186* Skipped due to upload to PyPI gone wrong and inability to recover
1187 (https://github.com/pypa/packaging-problems/issues/74)
1188
Wenzel Jakobbb79d7b2016-04-21 12:23:20 +020011891.5 (April 21, 2016)
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001190----------------------
Wenzel Jakobc79dbe42016-04-17 21:54:31 +02001191* For polymorphic types, use RTTI to try to return the closest type registered with pybind11
Wenzel Jakobd7efa4f2016-04-13 13:45:09 +02001192* Pickling support for serializing and unserializing C++ instances to a byte stream in Python
Wenzel Jakobb2825952016-04-13 23:33:00 +02001193* Added a convenience routine ``make_iterator()`` which turns a range indicated
1194 by a pair of C++ iterators into a iterable Python object
1195* Added ``len()`` and a variadic ``make_tuple()`` function
Wenzel Jakobb2b44a92016-04-15 17:50:40 +02001196* Addressed a rare issue that could confuse the current virtual function
1197 dispatcher and another that could lead to crashes in multi-threaded
1198 applications
Wenzel Jakobb2825952016-04-13 23:33:00 +02001199* Added a ``get_include()`` function to the Python module that returns the path
1200 of the directory containing the installed pybind11 header files
Wenzel Jakob1c329aa2016-04-13 02:37:36 +02001201* Documentation improvements: import issues, symbol visibility, pickling, limitations
Wenzel Jakobdbe43ff2016-04-21 12:21:14 +02001202* Added casting support for ``std::reference_wrapper<>``
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001203
Wenzel Jakob33c2a042016-04-07 09:06:49 +020012041.4 (April 7, 2016)
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001205--------------------------
Wenzel Jakob81dfd2c2016-03-08 19:40:32 +01001206* Transparent type conversion for ``std::wstring`` and ``wchar_t``
Wenzel Jakob0e6ca592016-04-07 08:49:37 +02001207* Allow passing ``nullptr``-valued strings
Wenzel Jakob34116732016-04-06 17:55:41 +02001208* Transparent passing of ``void *`` pointers using capsules
Wenzel Jakob0e6ca592016-04-07 08:49:37 +02001209* Transparent support for returning values wrapped in ``std::unique_ptr<>``
Wenzel Jakob4e455dd2016-03-09 16:38:28 +01001210* Improved docstring generation for compatibility with Sphinx
Wenzel Jakob34116732016-04-06 17:55:41 +02001211* Nicer debug error message when default parameter construction fails
1212* Support for "opaque" types that bypass the transparent conversion layer for STL containers
1213* Redesigned type casting interface to avoid ambiguities that could occasionally cause compiler errors
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001214* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy
Wenzel Jakob4e455dd2016-03-09 16:38:28 +01001215* Anaconda package generation support
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001216
12171.3 (March 8, 2016)
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001218--------------------------
Wenzel Jakobcf2b87a2016-02-22 17:32:44 +01001219
1220* Added support for the Intel C++ compiler (v15+)
1221* Added support for the STL unordered set/map data structures
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001222* Added support for the STL linked list data structure
Wenzel Jakobcf2b87a2016-02-22 17:32:44 +01001223* NumPy-style broadcasting support in ``pybind11::vectorize``
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001224* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails
Wenzel Jakobd2385e82016-03-08 18:04:43 +01001225* pybind11 internal data structures now live in a version-dependent namespace to avoid ABI issues
1226* Many, many bugfixes involving corner cases and advanced usage
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001227
12281.2 (February 7, 2016)
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001229--------------------------
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001230
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001231* Optional: efficient generation of function signatures at compile time using C++14
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001232* Switched to a simpler and more general way of dealing with function default
1233 arguments. Unused keyword arguments in function calls are now detected and
1234 cause errors as expected
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001235* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward``
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001236* New ``pybind11::base<>`` attribute to indicate a subclass relationship
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001237* Improved interface for RAII type wrappers in ``pytypes.h``
1238* Use RAII type wrappers consistently within pybind11 itself. This
1239 fixes various potential refcount leaks when exceptions occur
Wenzel Jakob2c5d5602016-04-11 18:46:11 +02001240* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7)
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001241* Made handle and related RAII classes const correct, using them more
1242 consistently everywhere now
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001243* Got rid of the ugly ``__pybind11__`` attributes on the Python side---they are
1244 now stored in a C++ hash table that is not visible in Python
1245* Fixed refcount leaks involving NumPy arrays and bound functions
1246* Vastly improved handling of shared/smart pointers
1247* Removed an unnecessary copy operation in ``pybind11::vectorize``
1248* Fixed naming clashes when both pybind11 and NumPy headers are included
1249* Added conversions for additional exception types
Wenzel Jakob48548ea2016-01-17 22:36:44 +01001250* Documentation improvements (using multiple extension modules, smart pointers,
1251 other minor clarifications)
Wenzel Jakob61587162016-01-18 22:38:52 +01001252* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001253* Fixed license text (was: ZLIB, should have been: 3-clause BSD)
1254* Python 3.2 compatibility
Wenzel Jakobcd4e6ae2016-01-29 11:48:40 +01001255* Fixed remaining issues when accessing types in another plugin module
1256* Added enum comparison and casting methods
1257* Improved SFINAE-based detection of whether types are copy-constructible
1258* Eliminated many warnings about unused variables and the use of ``offsetof()``
Wenzel Jakob8ed28082016-02-07 17:32:37 +01001259* Support for ``std::array<>`` conversions
Wenzel Jakob1ae77fe2016-01-17 22:36:43 +01001260
12611.1 (December 7, 2015)
1262--------------------------
1263
1264* Documentation improvements (GIL, wrapping functions, casting, fixed many typos)
1265* Generalized conversion of integer types
1266* Improved support for casting function objects
1267* Improved support for ``std::shared_ptr<>`` conversions
1268* Initial support for ``std::set<>`` conversions
1269* Fixed type resolution issue for types defined in a separate plugin module
1270* Cmake build system improvements
1271* Factored out generic functionality to non-templated code (smaller code size)
1272* Added a code size / compile time benchmark vs Boost.Python
1273* Added an appveyor CI script
1274
12751.0 (October 15, 2015)
1276------------------------
1277* Initial release