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