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