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