pyo3/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

[0.9.0]

Changed

• #[new] does not take PyRawObject and can return Self. #683
• The blanket implementations for FromPyObject for &T and &mut T are no longer specializable. Implement PyTryFrom for your type to control the behavior of FromPyObject::extract() for your types. #713
• The implementation for IntoPy<U> for T where U: FromPy<T> is no longer specializable. Control the behavior of this via the implementation of FromPy. #713
• Use parking_lot::Mutex instead of spin::Mutex. #734
• Bumped minimum Rust version to 1.42.0-nightly 2020-01-21. #761

Added

• PyClass, PyClassShell, PyObjectLayout, PyClassInitializer. #683
• Implemented IntoIterator for PySet and PyFrozenSet. #716
• FromPyObject is now automatically implemented for T: Clone pyclasses. #730
• #[pyo3(get)] and #[pyo3(set)] will now use the Rust doc-comment from the field for the Python property. #755
• #[setter] functions may now take an argument of Pyo3::Python. #760

Fixed

• Fixed unsoundness of subclassing. #683.
• Clear error indicator when the exception is handled on the Rust side. #719
• Usage of raw identifiers with #[pyo3(set)]. #745
• Usage of PyObject with #[pyo3(get)]. #760
• #[pymethods] used in conjunction with #[cfg]. #769

Removed

• PyRef, PyRefMut, PyRawObject. #683
• PyNoArgsFunction. #741
• initialize_type(). To set the module name for a #[pyclass], use the module argument to the macro. #751

[0.8.5]

• Support for #[name = "foo"] attribute for #[pyfunction] and in #[pymethods]. #692
• Implemented FromPyObject for HashMap and BTreeMap

[0.8.4]

Added

• Support for #[text_signature] attribute. #675

[0.8.3]

Fixed

• Now all &Py~ types have !Send bound. #655
• Fix a compile error raised by the stabilization of ! type. #672.

Removed

• #[init] is removed. #658

0.8.2

Added

• FFI compatibility for PEP 590 Vectorcall. #641

Fixed

• Fix PySequenceProtocol::set_item. #624
• Fix a corner case of BigInt::FromPyObject. #630
• Fix index errors in parameter conversion. #631
• Fix handling of invalid utf-8 sequences in PyString::as_bytes. #639 and PyString::to_string_lossy #642.
• Remove __contains__ and __iter__ from PyMappingProtocol. #644
• Fix proc-macro definition of PySetAttrProtocol. #645

0.8.1

Added

• Conversion between num-bigint and Python int. #608

Fixed

• Make sure the right Python interpreter is used in OSX builds. #604
• Patch specialization being broken by Rust 1.40. #614
• Fix a segfault around PyErr. #597

0.8.0 - 2018-09-05

Added

• module argument to pyclass macro. #499
• py_run! macro #512
• Use existing fields and methods before calling custom getattr. #505
• PyBytes can now be indexed just like Vec<u8>
• Implement IntoPy<PyObject> for PyRef and PyRefMut.

Removed

• IntoPyObject was replaced with IntoPy<PyObject>
• #[pyclass(subclass)] is hidden a unsound-subclass feature because it's causing segmentation faults.

Fixed

• More readable error message for generics in pyclass #503

Changed

• Implementing the Using the gc parameter for pyclass (e.g. #[pyclass(gc)]) without implementing the class::PyGCProtocol trait is now a compile-time error. Failing to implement this trait could lead to segfaults. #532
• PyByteArray::data has been replaced with PyDataArray::to_vec because returning a &[u8] is unsound. (See this comment for a great write-up for why that was unsound)
• Replace mashup with paste.
• GILPool gained a Python marker to prevent it from being misused to release Python objects without the GIL held.

0.7.0 - 2018-05-26

Added

• PyPy support by omerbenamram in #393
• Have PyModule generate an index of its members (__all__ list).
• Allow slf: PyRef<T> for pyclass(#419)
• Allow to use lifetime specifiers in pymethods
• Add marshal module. #460

Changed

• Python::run returns PyResult<()> instead of PyResult<&PyAny>.
• Methods decorated with #[getter] and #[setter] can now omit wrapping the result type in PyResult if they don't raise exceptions.

Fixed

• type_object::PyTypeObject has been marked unsafe because breaking the contract type_object::PyTypeObject::init_type can lead to UB.
• Fixed automatic derive of PySequenceProtocol implementation in #423.
• Capitalization & better wording to README.md.
• Docstrings of properties is now properly set using the doc of the #[getter] method.
• Fixed issues with pymethods crashing on doc comments containing double quotes.
• PySet::new and PyFrozenSet::new now return PyResult<&Py[Frozen]Set>; exceptions are raised if the items are not hashable.
• Fixed building using venv on Windows.
• PyTuple::new now returns &PyTuple instead of Py<PyTuple>.
• Fixed several issues with argument parsing; notable, the *args and **kwargs tuple/dict now doesn't contain arguments that are otherwise assigned to parameters.

0.6.0 - 2018-03-28

Regressions

• Currently, #341 causes cargo test to fail with weird linking errors when the extension-module feature is activated. For now you can work around this by making the extension-module feature optional and running the tests with cargo test --no-default-features:

[dependencies.pyo3]
version = "0.6.0"

[features]
extension-module = ["pyo3/extension-module"]
default = ["extension-module"]

Added

• Added a wrap_pymodule! macro similar to the existing wrap_pyfunction! macro. Only available on python 3
• Added support for cross compiling (e.g. to arm v7) by mtp401 in #327. See the "Cross Compiling" section in the "Building and Distribution" chapter of the guide for more details.
• The PyRef and PyRefMut types, which allow to differentiate between an instance of a rust struct on the rust heap and an instance that is embedded inside a python object. By kngwyu in #335
• Added FromPy<T> and IntoPy<T> which are equivalent to From<T> and Into<T> except that they require a gil token.
• Added ManagedPyRef, which should eventually replace ToBorrowedObject.

Changed

• Renamed PyObjectRef to PyAny in #388
• Renamed add_function to add_wrapped as it now also supports modules.
• Renamed #[pymodinit] to #[pymodule]
• py.init(|| value) becomes Py::new(value)
• py.init_ref(|| value) becomes PyRef::new(value)
• py.init_mut(|| value) becomes PyRefMut::new(value).
• PyRawObject::init is now infallible, e.g. it returns () instead of PyResult<()>.
• Renamed py_exception! to create_exception! and refactored the error macros.
• Renamed wrap_function! to wrap_pyfunction!
• Renamed #[prop(get, set)] to #[pyo3(get, set)]
• #[pyfunction] now supports the same arguments as #[pyfn()]
• Some macros now emit proper spanned errors instead of panics.
• Migrated to the 2018 edition
• crate::types::exceptions moved to crate::exceptions
• Replace IntoPyTuple with IntoPy<Py<PyTuple>>.
• IntoPyPointer and ToPyPointer moved into the crate root.
• class::CompareOp moved into class::basic::CompareOp
• PyTypeObject is now a direct subtrait PyTypeCreate, removing the old cyclical implementation in #350
• Add PyList::{sort, reverse} by chr1sj0nes in #357 and #358
• Renamed the typeob module to type_object

Removed

• PyToken was removed due to unsoundness (See #94).
• Removed the unnecessary type parameter from PyObjectAlloc
• NoArgs. Just use an empty tuple
• PyObjectWithGIL. PyNativeType is sufficient now that PyToken is removed.

Fixed

• A soudness hole where every instances of a #[pyclass] struct was considered to be part of a python object, even though you can create instances that are not part of the python heap. This was fixed through PyRef and PyRefMut.
• Fix kwargs support in #328.
• Add full support for __dict__ in #403.

0.5.3 - 2019-01-04

Fixed

• Fix memory leak in ArrayList by kngwyu #316

0.5.2 - 2018-11-26

Fixed

• Fix undeterministic segfaults when creating many objects by kngwyu in #281

[0.5.1] - 2018-11-24

Yanked

0.5.0 - 2018-11-11

Added

• #[pyclass] objects can now be returned from rust functions
• PyComplex by kngwyu in #226
• PyDict::from_sequence(), equivalent to dict([(key, val), ...])
• Bindings for the datetime standard library types: PyDate, PyTime, PyDateTime, PyTzInfo, PyDelta with associated ffi types, by pganssle #200.
• PyString, PyUnicode, and PyBytes now have an as_bytes() method that returns &[u8].
• PyObjectProtocol::get_type_ptr() by ijl in #242

Removed

• Removed most entries from the prelude. The new prelude is small and clear.
• Slowly removing specialization uses
• PyString, PyUnicode, and PyBytes no longer have a data() method (replaced by as_bytes()) and PyStringData has been removed.
• The pyobject_extract macro

Changed

• Removes the types from the root module and the prelude. They now live in pyo3::types instead.
• All exceptions are consturcted with py_err instead of new, as they return PyErr and not Self.
• as_mut and friends take and &mut self instead of &self
• ObjectProtocol::call now takes an Option<&PyDict> for the kwargs instead of an IntoPyDictPointer.
• IntoPyDictPointer was replace by IntoPyDict which doesn't convert PyDict itself anymore and returns a PyDict instead of *mut PyObject.
• PyTuple::new now takes an IntoIterator instead of a slice
• Updated to syn 0.15
• Splitted PyTypeObject into PyTypeObject without the create method and PyTypeCreate with requires PyObjectAlloc<Self> + PyTypeInfo + Sized.
• Ran cargo edition --fix which prefixed path with crate:: for rust 2018
• Renamed async to pyasync as async will be a keyword in the 2018 edition.
• Starting to use NonNull<*mut PyObject> for Py and PyObject by ijl #260

Fixed

• Added an explanation that the GIL can temporarily be released even while holding a GILGuard.
• Lots of clippy errors
• Fix segfault on calling an unknown method on a PyObject
• Work around a bug in the rust compiler by kngwyu #252
• Fixed a segfault with subclassing pyo3 create classes and using __class__ by kngwyu #263

0.4.1 - 2018-08-20

Fixed

• Fixed compilation on nightly since use_extern_macros was stabilized

Changed

• PyTryFrom's error is always to PyDowncastError

Removed

• The pyobject_downcast macro

0.4.0 - 2018-07-30

Removed

• Conversions from tuples to PyDict due to rust-lang/rust#52050

Changed

• Merged both examples into one
• Rustfmt all the things ✔️
• Switched to Keep a Changelog

0.3.2 - 2018-07-22

Changed

• Replaced concat_idents with mashup

0.3.1 - 2018-07-18

Fixed

• Fixed scoping bug in pyobject_native_type that would break rust-numpy

0.3.0 - 2018-07-18

Changed

• Upgraded to syn 0.14 which means much better error messages 🎉
• 128 bit integer support by kngwyu (#137)
• proc_macro has been stabilized on nightly (rust-lang/rust#52081). This means that we can remove the proc_macro feature, but now we need the use_extern_macros from the 2018 edition instead.
• All proc macro are now prefixed with py and live in the prelude. This means you can use #[pyclass], #[pymethods], #[pyproto], #[pyfunction] and #[pymodinit] directly, at least after a use pyo3::prelude::*. They were also moved into a module called proc_macro. You shouldn't use #[pyo3::proc_macro::pyclass] or other longer paths in attributes because proc_macro_path_invoc isn't going to be stabilized soon.
• Renamed the base option in the pyclass macro to extends.
• #[pymodinit] uses the function name as module name, unless the name is overrriden with #[pymodinit(name)]
• The guide is now properly versioned.

Added

• A few internal macros became part of the public api (#155, #186)
• Always clone in getters. This allows using the get-annotation on all Clone-Types

0.2.7 - 2018-05-18

Fixed

• Fix nightly breakage with proc_macro_path

0.2.6 - 2018-04-03

Fixed

• Fix compatibility with TryFrom trait #137

0.2.5 - 2018-02-21

Added

• CPython 3.7 support

Fixed

• Embedded CPython 3.7b1 crashes on initialization #110
• Generated extension functions are weakly typed #108
• call_method*() crashes when the method does not exist #113
• Allow importing exceptions from nested modules #116

0.2.4 - 2018-01-19

Added

• Allow to get mutable ref from PyObject #106
• Drop RefFromPyObject trait
• Add Python::register_any() method

Fixed

• Fix impl FromPyObject for Py<T>
• Mark method that work with raw pointers as unsafe #95

0.2.3 - 11-27-2017

Fixed

• Proper c_char usage #93

Changed

• Rustup to 1.23.0-nightly 2017-11-07

Removed

• Remove use of now unneeded 'AsciiExt' trait

0.2.2 - 09-26-2017

Changed

• Rustup to 1.22.0-nightly 2017-09-30

0.2.1 - 09-26-2017

Fixed

• Fix rustc const_fn nightly breakage

0.2.0 - 08-12-2017

Changed

• Allow to add gc support without implementing PyGCProtocol #57
• Refactor PyErr implementation. Drop py parameter from constructor.

Added

• Added inheritance support #15
• Added weakref support #56
• Added subclass support #64
• Added self.__dict__ supoort #68
• Added pyo3::prelude module #70
• Better Iterator support for PyTuple, PyList, PyDict #75
• Introduce IntoPyDictPointer similar to IntoPyTuple #69

0.1.0 - 07-23-2017

Added

• Initial release