This release introduces support for Python 3.13. Please note that Python 3.13 is still in beta, and while breaking changes are not expected it is very possible that code compiled against Python 3.13 beta versions will be incompatible with the final 3.13 release later in the year.
The minimum supported Rust version has been increased to Rust 1.63.
PyO3's deferred reference counting used to implement Clone for Py<T> without the global interpreter lock has been demonstrated to be impossible to implement safely in the general case and has consequently been changed to panic instead of deferring when cloning Py<T> without the GIL being held. Given the nature of panics inside Clone operations being a potential footgun, this implementation has been moved behind the opt-in py-clone feature.
Other particularly notable changes include:
The #[pyclass] macro now has additional options #[pyclass(eq, ord, hash)] to automatically generate Python implementations for equality, ordering and hashing based upon the Rust PartialEq, PartialOrd and Hash traits. This can ensure consistency and reduce boilerplate compared to implementing __eq__, __hash__ and so on manually.
The experimental-declarative-modules feature to support #[pymodule] on Rust mod items has been stabilised (and the feature flag removed). The existing implementation of #[pymodule] on fn items is still present but soft-deprecated; in the future new features will likely be added only to declarative modules, and the fn modules may eventually be deprecated and removed.
The GIL Refs API deprecation started in PyO3 0.21 continues with all related APIs now being gated behind the gil-refs feature, and unconditionally deprecated. In PyO3 0.23 these APIs are expected to be removed.
There have been numerous other smaller improvements, changes and fixes. For full details see the CHANGELOG.
Thank you to everyone who contributed code, documentation, design ideas, bug reports, and feedback. The following contributors' commits are included in this release:
Add PyWeakref, PyWeakrefReference and PyWeakrefProxy. #3835
Support #[pyclass] on enums that have tuple variants. #4072
Add support for scientific notation in Decimal conversion. #4079
Add pyo3_disable_reference_pool conditional compilation flag to avoid the overhead of the global reference pool at the cost of known limitations as explained in the performance section of the guide. #4095
Add #[pyo3(constructor = (...))] to customize the generated constructors for complex enum variants. #4158
Add PyType::module, which always matches Python __module__. #4196
Add PyType::fully_qualified_name which matches the "fully qualified name" defined in PEP 737. #4196
Add PyTypeMethods::mro and PyTypeMethods::bases. #4197
Add #[pyclass(ord)] to implement ordering based on PartialOrd. #4202
Implement ToPyObject and IntoPy<PyObject> for PyBackedStr and PyBackedBytes. #4205
Add #[pyclass(hash)] option to implement __hash__ in terms of the Hash implementation #4206
Add #[pyclass(eq)] option to generate __eq__ based on PartialEq, and #[pyclass(eq_int)] for simple enums to implement equality based on their discriminants. #4210
Implement From<Bound<'py, T>> for PyClassInitializer<T>. #4214
Add as_super methods to PyRef and PyRefMut for accesing the base class by reference. #4219
Implement PartialEq<str> for Bound<'py, PyString>. #4245
Implement PyModuleMethods::filename on PyPy. #4249
Implement PartialEq<[u8]> for Bound<'py, PyBytes>. #4250
Add pyo3_ffi::c_str macro to create &'static CStr on Rust versions which don't have 1.77's c"" literals. #4255
Support bool conversion with numpy 2.0's numpy.bool type #4258
Change the type of PySliceIndices::slicelength and the length parameter of PySlice::indices(). #3761
Deprecate implicit default for trailing optional arguments #4078
Cloneing pointers into the Python heap has been moved behind the py-clone feature, as it must panic without the GIL being held as a soundness fix. #4095
Add #[track_caller] to all Py<T>, Bound<'py, T> and Borrowed<'a, 'py, T> methods which can panic. #4098
Change PyAnyMethods::dir to be fallible and return PyResult<Bound<'py, PyList>> (and similar for PyAny::dir). #4100
The global reference pool (to track pending reference count decrements) is now initialized lazily to avoid the overhead of taking a mutex upon function entry when the functionality is not actually used. #4178
Emit error messages when using weakref or dict when compiling for abi3 for Python older than 3.9. #4194
Change PyType::name to always match Python __name__. #4196
Deprecate implicit integer comparision for simple enums in favor of #[pyclass(eq_int)]. #4210
Set the module= attribute of declarative modules' child #[pymodule]s and #[pyclass]es. #4213
Set the module option for complex enum variants from the value set on the complex enum module. #4228
Respect the Python "limited API" when building for the abi3 feature on PyPy or GraalPy. #4237
Optimize code generated by #[pyo3(get)] on #[pyclass] fields. #4254
PyCFunction::new, PyCFunction::new_with_keywords and PyCFunction::new_closure now take &'static CStr name and doc arguments (previously was &'static str). #4255
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Updates the requirements on pyo3 to permit the latest version.
Release notes
Sourced from pyo3's releases.
Changelog
Sourced from pyo3's changelog.
... (truncated)
Commits
2e2d440
release: 0.22.0 (#4266)91d8683
improve deprecation message on implicit trailing optionals (#4282)6a0221b
document FnType and refactor FnType::self_arg (#4276)c67625d
Revamp PyType name functions to match PEP 737 (#4196)a2f9399
make datetime from timestamp tests compare against Python result (#4275)908ef6a
Implement PartialEq for PyBytes and [u8] (#4259)c4d18e5
Changesearch_lib_dir
's return type to Result (#4043)0b967d4
useffi::MemberGef
for#[pyo3(get)]
fields ofPy\<T>
(#4254)41fb957
docs: update docstring onPython
forBound
API (#4274)9ff3d23
Update dependencies to reflect minimal versions (#4272)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show