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

Changelog
#########

6
7
1.6 (not yet released)
----------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
8
9
10
* Added a new ``move`` return value policy that triggers C++11 move semantics.
  The automatic return value policy falls back to this case when a rvalue
  reference is encountered
Wenzel Jakob's avatar
Wenzel Jakob committed
11
12
* 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
13
14
15
16
17
18
* ``keep_alive`` fix: don't fail when there is no patient
* ``functional.h``: acquire the GIL before calling Python function
* Added Python RAII type wrappers ``none`` and ``iterable``
* Added ``*args`` and ``*kwargs`` pass-through parameters to
  ``pybind11.get_include()`` function
* Documentation improvements: ``opaque``, return value policies
19
20

1.5 (April 21, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
21
----------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
22
* For polymorphic types, use RTTI to try to return the closest type registered with pybind11
23
* Pickling support for serializing and unserializing C++ instances to a byte stream in Python
24
25
26
* 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
27
28
29
* Addressed a rare issue that could confuse the current virtual function
  dispatcher and another that could lead to crashes in multi-threaded
  applications
30
31
* 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
32
* Documentation improvements: import issues, symbol visibility, pickling, limitations
33
* Added casting support for ``std::reference_wrapper<>``
Wenzel Jakob's avatar
Wenzel Jakob committed
34

Wenzel Jakob's avatar
Wenzel Jakob committed
35
1.4 (April 7, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
36
--------------------------
37
* Transparent type conversion for ``std::wstring`` and ``wchar_t``
Wenzel Jakob's avatar
Wenzel Jakob committed
38
* Allow passing ``nullptr``-valued strings
Wenzel Jakob's avatar
Wenzel Jakob committed
39
* Transparent passing of ``void *`` pointers using capsules
Wenzel Jakob's avatar
Wenzel Jakob committed
40
* Transparent support for returning values wrapped in ``std::unique_ptr<>``
41
* Improved docstring generation for compatibility with Sphinx
Wenzel Jakob's avatar
Wenzel Jakob committed
42
43
44
* 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
45
* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy
46
* Anaconda package generation support
Wenzel Jakob's avatar
Wenzel Jakob committed
47
48

1.3 (March 8, 2016)
Wenzel Jakob's avatar
Wenzel Jakob committed
49
--------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
50
51
52

* 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
53
* Added support for the STL linked list data structure
Wenzel Jakob's avatar
Wenzel Jakob committed
54
* NumPy-style broadcasting support in ``pybind11::vectorize``
Wenzel Jakob's avatar
Wenzel Jakob committed
55
* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails
Wenzel Jakob's avatar
Wenzel Jakob committed
56
57
* 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
58
59

1.2 (February 7, 2016)
60
--------------------------
Wenzel Jakob's avatar
Wenzel Jakob committed
61

62
* Optional: efficient generation of function signatures at compile time using C++14
Wenzel Jakob's avatar
Wenzel Jakob committed
63
64
65
* 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
66
* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward``
Wenzel Jakob's avatar
Wenzel Jakob committed
67
* New ``pybind11::base<>`` attribute to indicate a subclass relationship
68
69
70
* 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
71
* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7)
Wenzel Jakob's avatar
Wenzel Jakob committed
72
73
* Made handle and related RAII classes const correct, using them more
  consistently everywhere now
74
75
76
77
78
79
80
* 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
81
82
* Documentation improvements (using multiple extension modules, smart pointers,
  other minor clarifications)
83
* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function
84
85
* Fixed license text (was: ZLIB, should have been: 3-clause BSD)
* Python 3.2 compatibility
Wenzel Jakob's avatar
Wenzel Jakob committed
86
87
88
89
* 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
90
* Support for ``std::array<>`` conversions
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

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