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