changelog.rst 12.1 KB
Newer Older
1
2
3
4
5
.. _changelog:

Changelog
#########

Wenzel Jakob's avatar
Wenzel Jakob committed
6
7
8
9
Starting with version 1.8, pybind11 releases use a
[semantic versioning](http://semver.org) policy.

Breaking changes queued for v2.0.0 (Not yet released)
10
-----------------------------------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
11
12
13
14
15
* Redesigned virtual call mechanism and user-facing syntax (see
  https://github.com/pybind/pybind11/commit/86d825f3302701d81414ddd3d38bcd09433076bc)

* Remove ``handle.call()`` method

Wenzel Jakob's avatar
Wenzel Jakob committed
16
1.9.0 (Not yet released)
17
------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
18
19
* Queued changes: map indexing suite, documentation for indexing suites.
* Mapping a stateless C++ function to Python and back is now "for free" (i.e. no call overheads)
Wenzel Jakob's avatar
Wenzel Jakob committed
20
* Support for translation of arbitrary C++ exceptions to Python counterparts
Wenzel Jakob's avatar
Wenzel Jakob committed
21
22
23
* Added ``eval`` and ``eval_file`` functions for evaluating expressions and
  statements from a string or file
* eigen.h type converter fixed for non-contiguous arrays (e.g. slices)
24
* Print more informative error messages when ``make_tuple()`` or ``cast()`` fail
Wenzel Jakob's avatar
Wenzel Jakob committed
25
* ``std::enable_shared_from_this<>`` now also works for ``const`` values
26
27
* A return value policy can now be passed to ``handle::operator()``
* ``make_iterator()`` improvements for better compatibility with various types
28
29
  (now uses prefix increment operator); it now also accepts iterators with
  different begin/end types as long as they are equality comparable.
Wenzel Jakob's avatar
Wenzel Jakob committed
30
* ``arg()`` now accepts a wider range of argument types for default values
31
* Added ``py::repr()`` function which is equivalent to Python's builtin ``repr()``.
Ivan Smirnov's avatar
Ivan Smirnov committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
* Added support for registering structured dtypes via ``PYBIND11_NUMPY_DTYPE()`` macro.
* Added ``PYBIND11_STR_TYPE`` macro which maps to the ``builtins.str`` type.
* Added a simplified ``buffer_info`` constructor for 1-dimensional buffers.
* Format descriptor strings should now be accessed via ``format_descriptor::format()``
  (for compatibility purposes, the old syntax ``format_descriptor::value`` will still
  work for non-structured data types).
* Added a class wrapping NumPy array descriptors: ``dtype``.
* Added buffer/NumPy support for ``char[N]`` and ``std::array<char, N>`` types.
* ``array`` gained new constructors accepting dtype objects.
* Added constructors for ``array`` and ``array_t`` explicitly accepting shape and
  strides; if strides are not provided, they are deduced assuming C-contiguity.
  Also added simplified constructors for 1-dimensional case.
* Added constructors for ``str`` from ``bytes`` and for ``bytes`` from ``str``.
  This will do the UTF-8 decoding/encoding as required.
* Added constructors for ``str`` and ``bytes`` from zero-terminated char pointers,
  and from char pointers and length.
* Added ``memoryview`` wrapper type which is constructible from ``buffer_info``.
49
50
51
52
53
54
55
* New syntax to call a Python function from C++ using keyword arguments and unpacking,
  e.g. ``foo(1, 2, "z"_a=3)`` or ``bar(1, *args, "z"_a=3, **kwargs)``.
* Added ``py::print()`` function which replicates Python's API and writes to Python's
  ``sys.stdout`` by default (as opposed to C's ``stdout`` like ``std::cout``).
* Added ``py::dict`` keyword constructor:``auto d = dict("number"_a=42, "name"_a="World");``
* Added ``py::str::format()`` method and ``_s`` literal:
  ``py::str s = "1 + 2 = {}"_s.format(3);``
56
57
* Attribute and item accessors now have a more complete interface which makes it possible
  to chain attributes ``obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)```.
58
59
* Added built-in support for ``std::shared_ptr`` holder type. There is no more need
  to do it manually via ``PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>)``.
60
61
* Default return values policy changes: non-static properties now use ``reference_internal``
  and static properties use ``reference`` (previous default was ``automatic``, i.e. ``copy``).
62
* Support for ``std::experimental::optional<T>`` and ``std::optional<T>`` (C++17).
63
64
65
66
* Various minor improvements of library internals (no user-visible changes)

1.8.1 (July 12, 2016)
----------------------
67
68
* Fixed a rare but potentially very severe issue when the garbage collector ran
  during pybind11 type creation.
Wenzel Jakob's avatar
Wenzel Jakob committed
69

Wenzel Jakob's avatar
Wenzel Jakob committed
70
1.8.0 (June 14, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
71
72
73
74
75
76
77
78
----------------------
* Redesigned CMake build system which exports a convenient
  ``pybind11_add_module`` function to parent projects.
* ``std::vector<>`` type bindings analogous to Boost.Python's ``indexing_suite``
* Transparent conversion of sparse and dense Eigen matrices and vectors (``eigen.h``)
* Added an ``ExtraFlags`` template argument to the NumPy ``array_t<>`` wrapper
  to disable an enforced cast that may lose precision, e.g. to create overloads
  for different precisions and complex vs real-valued matrices.
79
80
* Prevent implicit conversion of floating point values to integral types in
  function arguments
Wenzel Jakob's avatar
Wenzel Jakob committed
81
82
* Fixed incorrect default return value policy for functions returning a shared
  pointer
83
* Don't allow registering a type via ``class_`` twice
Wenzel Jakob's avatar
Wenzel Jakob committed
84
85
86
87
* Don't allow casting a ``None`` value into a C++ lvalue reference
* Fixed a crash in ``enum_::operator==`` that was triggered by the ``help()`` command
* Improved detection of whether or not custom C++ types can be copy/move-constructed
* Extended ``str`` type to also work with ``bytes`` instances
Wenzel Jakob's avatar
Wenzel Jakob committed
88
89
90
* Added a ``"name"_a`` user defined string literal that is equivalent to ``py::arg("name")``.
* When specifying function arguments via ``py::arg``, the test that verifies
  the number of arguments now runs at compile time.
Wenzel Jakob's avatar
Wenzel Jakob committed
91
92
* Added ``[[noreturn]]`` attribute to ``pybind11_fail()`` to quench some
  compiler warnings
93
94
* List function arguments in exception text when the dispatch code cannot find
  a matching overload
Wenzel Jakob's avatar
Wenzel Jakob committed
95
* Added ``PYBIND11_OVERLOAD_NAME`` and ``PYBIND11_OVERLOAD_PURE_NAME`` macros which
Wenzel Jakob's avatar
Wenzel Jakob committed
96
  can be used to override virtual methods whose name differs in C++ and Python
Wenzel Jakob's avatar
Wenzel Jakob committed
97
  (e.g. ``__call__`` and ``operator()``)
Wenzel Jakob's avatar
Wenzel Jakob committed
98
* Various minor ``iterator`` and ``make_iterator()`` improvements
99
100
* Transparently support ``__bool__`` on Python 2.x and Python 3.x
* Fixed issue with destructor of unpickled object not being called
Wenzel Jakob's avatar
Wenzel Jakob committed
101
* Minor CMake build system improvements on Windows
102
103
104
* New ``pybind11::args`` and ``pybind11::kwargs`` types to create functions which
  take an arbitrary number of arguments and keyword arguments
* New syntax to call a Python function from C++ using ``*args`` and ``*kwargs``
Wenzel Jakob's avatar
Wenzel Jakob committed
105
106
107
108
109
110
* The functions ``def_property_*`` now correctly process docstring arguments (these
  formerly caused a segmentation fault)
* Many ``mkdoc.py`` improvements (enumerations, template arguments, ``DOC()``
  macro accepts more arguments)
* Cygwin support
* Documentation improvements (pickling support, ``keep_alive``, macro usage)
Wenzel Jakob's avatar
Wenzel Jakob committed
111

Wenzel Jakob's avatar
Wenzel Jakob committed
112
1.7 (April 30, 2016)
113
----------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
114
* Added a new ``move`` return value policy that triggers C++11 move semantics.
Wenzel Jakob's avatar
Wenzel Jakob committed
115
  The automatic return value policy falls back to this case whenever a rvalue
Wenzel Jakob's avatar
Wenzel Jakob committed
116
  reference is encountered
Wenzel Jakob's avatar
Wenzel Jakob committed
117
118
* Significantly more general GIL state routines that are used instead of
  Python's troublesome ``PyGILState_Ensure`` and ``PyGILState_Release`` API
Wenzel Jakob's avatar
Wenzel Jakob committed
119
* Redesign of opaque types that drastically simplifies their usage
Wenzel Jakob's avatar
Wenzel Jakob committed
120
* Extended ability to pass values of type ``[const] void *``
Wenzel Jakob's avatar
Wenzel Jakob committed
121
* ``keep_alive`` fix: don't fail when there is no patient
Wenzel Jakob's avatar
Wenzel Jakob committed
122
* ``functional.h``: acquire the GIL before calling a Python function
Wenzel Jakob's avatar
Wenzel Jakob committed
123
124
125
* Added Python RAII type wrappers ``none`` and ``iterable``
* Added ``*args`` and ``*kwargs`` pass-through parameters to
  ``pybind11.get_include()`` function
Wenzel Jakob's avatar
Wenzel Jakob committed
126
127
* Iterator improvements and fixes
* Documentation on return value policies and opaque types improved
128

Wenzel Jakob's avatar
Wenzel Jakob committed
129
130
131
132
133
1.6 (April 30, 2016)
----------------------
* Skipped due to upload to PyPI gone wrong and inability to recover
  (https://github.com/pypa/packaging-problems/issues/74)

134
1.5 (April 21, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
135
----------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
136
* For polymorphic types, use RTTI to try to return the closest type registered with pybind11
137
* Pickling support for serializing and unserializing C++ instances to a byte stream in Python
138
139
140
* Added a convenience routine ``make_iterator()`` which turns a range indicated
  by a pair of C++ iterators into a iterable Python object
* Added ``len()`` and a variadic ``make_tuple()`` function
141
142
143
* Addressed a rare issue that could confuse the current virtual function
  dispatcher and another that could lead to crashes in multi-threaded
  applications
144
145
* Added a ``get_include()`` function to the Python module that returns the path
  of the directory containing the installed pybind11 header files
Wenzel Jakob's avatar
Wenzel Jakob committed
146
* Documentation improvements: import issues, symbol visibility, pickling, limitations
147
* Added casting support for ``std::reference_wrapper<>``
Wenzel Jakob's avatar
Wenzel Jakob committed
148

Wenzel Jakob's avatar
Wenzel Jakob committed
149
1.4 (April 7, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
150
--------------------------
151
* Transparent type conversion for ``std::wstring`` and ``wchar_t``
Wenzel Jakob's avatar
Wenzel Jakob committed
152
* Allow passing ``nullptr``-valued strings
Wenzel Jakob's avatar
Wenzel Jakob committed
153
* Transparent passing of ``void *`` pointers using capsules
Wenzel Jakob's avatar
Wenzel Jakob committed
154
* Transparent support for returning values wrapped in ``std::unique_ptr<>``
155
* Improved docstring generation for compatibility with Sphinx
Wenzel Jakob's avatar
Wenzel Jakob committed
156
157
158
* Nicer debug error message when default parameter construction fails
* Support for "opaque" types that bypass the transparent conversion layer for STL containers
* Redesigned type casting interface to avoid ambiguities that could occasionally cause compiler errors
Wenzel Jakob's avatar
Wenzel Jakob committed
159
* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy
160
* Anaconda package generation support
Wenzel Jakob's avatar
Wenzel Jakob committed
161
162

1.3 (March 8, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
163
--------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
164
165
166

* Added support for the Intel C++ compiler (v15+)
* Added support for the STL unordered set/map data structures
Wenzel Jakob's avatar
Wenzel Jakob committed
167
* Added support for the STL linked list data structure
Wenzel Jakob's avatar
Wenzel Jakob committed
168
* NumPy-style broadcasting support in ``pybind11::vectorize``
Wenzel Jakob's avatar
Wenzel Jakob committed
169
* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails
Wenzel Jakob's avatar
Wenzel Jakob committed
170
171
* pybind11 internal data structures now live in a version-dependent namespace to avoid ABI issues
* Many, many bugfixes involving corner cases and advanced usage
Wenzel Jakob's avatar
Wenzel Jakob committed
172
173

1.2 (February 7, 2016)
174
--------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
175

176
* Optional: efficient generation of function signatures at compile time using C++14
Wenzel Jakob's avatar
Wenzel Jakob committed
177
178
179
* Switched to a simpler and more general way of dealing with function default
  arguments. Unused keyword arguments in function calls are now detected and
  cause errors as expected
180
* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward``
Wenzel Jakob's avatar
Wenzel Jakob committed
181
* New ``pybind11::base<>`` attribute to indicate a subclass relationship
182
183
184
* Improved interface for RAII type wrappers in ``pytypes.h``
* Use RAII type wrappers consistently within pybind11 itself. This
  fixes various potential refcount leaks when exceptions occur
Wenzel Jakob's avatar
Wenzel Jakob committed
185
* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7)
Wenzel Jakob's avatar
Wenzel Jakob committed
186
187
* Made handle and related RAII classes const correct, using them more
  consistently everywhere now
188
189
190
191
192
193
194
* Got rid of the ugly ``__pybind11__`` attributes on the Python side---they are
  now stored in a C++ hash table that is not visible in Python
* Fixed refcount leaks involving NumPy arrays and bound functions
* Vastly improved handling of shared/smart pointers
* Removed an unnecessary copy operation in ``pybind11::vectorize``
* Fixed naming clashes when both pybind11 and NumPy headers are included
* Added conversions for additional exception types
Wenzel Jakob's avatar
Wenzel Jakob committed
195
196
* Documentation improvements (using multiple extension modules, smart pointers,
  other minor clarifications)
197
* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function
198
199
* Fixed license text (was: ZLIB, should have been: 3-clause BSD)
* Python 3.2 compatibility
Wenzel Jakob's avatar
Wenzel Jakob committed
200
201
202
203
* Fixed remaining issues when accessing types in another plugin module
* Added enum comparison and casting methods
* Improved SFINAE-based detection of whether types are copy-constructible
* Eliminated many warnings about unused variables and the use of ``offsetof()``
Wenzel Jakob's avatar
Wenzel Jakob committed
204
* Support for ``std::array<>`` conversions
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

1.1 (December 7, 2015)
--------------------------

* Documentation improvements (GIL, wrapping functions, casting, fixed many typos)
* Generalized conversion of integer types
* Improved support for casting function objects
* Improved support for ``std::shared_ptr<>`` conversions
* Initial support for ``std::set<>`` conversions
* Fixed type resolution issue for types defined in a separate plugin module
* Cmake build system improvements
* Factored out generic functionality to non-templated code (smaller code size)
* Added a code size / compile time benchmark vs Boost.Python
* Added an appveyor CI script

1.0 (October 15, 2015)
------------------------
* Initial release