This release is the first PyO3 release to be dual-licensed under Apache 2.0 OR MIT licensing (expanding from just Apache 2.0 of previous releases).
Python 3.12 stable is now supported. The minimum supported Rust version has been increased to Rust 1.56.
The __eq__, __ne__, __lt__, __le__, __gt__ and __ge__ magic methods are now usable in #[pymethods] to implement Python operators as an alternative to the __richcmp__ method PyO3 already offered.
#[pyclass(rename_all = "renaming_rule")] has been added to rename all fields of structs exposed to Python (e.g. rename_all = "snake_case") .
PyDict::get_item now returns Result<Option<&PyAny>> instead of just Option<&PyAny>. The previous implementation which ignored Python errors used APIs now considered deprecated by the Python language designers; it is now considered best practice to bubble up any exception raised during dictionary __getitem__. For most users migration for this change will simply require addition of a ? on each use of PyDict::get_item.
Note that Python 3.7 is end of life but PyO3 will continue to support for now as a number of downstream Python packages still have high proportions of downloads on 3.7. A future release is expected to drop Python 3.7 when these numbers reduce.
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 users' commits are included in this release:
Add as_ptr and into_ptr inherent methods for Py, PyAny, PyRef, and PyRefMut. #3359
Implement DoubleEndedIterator for PyTupleIterator and PyListIterator. #3366
Add #[pyclass(rename_all = "...")] option: this allows renaming all getters and setters of a struct, or all variants of an enum. Available renaming rules are: "camelCase", "kebab-case", "lowercase", "PascalCase", "SCREAMING-KEBAB-CASE", "SCREAMING_SNAKE_CASE", "snake_case", "UPPERCASE". #3384
Add FFI definitions PyObject_GC_IsTracked and PyObject_GC_IsFinalized on Python 3.9 and up (PyPy 3.10 and up). #3403
Add types for None, Ellipsis, and NotImplemented. #3408
Add FFI definitions for the Py_mod_multiple_interpreters constant and its possible values. #3494
Add FFI definitions for PyInterpreterConfig struct, its constants and Py_NewInterpreterFromConfig. #3502
Changed
Change PySet::discard to return PyResult<bool> (previously returned nothing). #3281
Optimize implmentation of IntoPy for Rust tuples to Python tuples. #3321
Change PyDict::get_item to no longer suppress arbitrary exceptions (the return type is now PyResult<Option<&PyAny>> instead of Option<&PyAny>), and deprecate PyDict::get_item_with_error. #3330
Deprecate FFI definitions which are deprecated in Python 3.12. #3336
Accept all os.PathLike values in implementation of FromPyObject for PathBuf. #3374
Add __builtins__ to globals in py.run() and py.eval() if they're missing. #3378
Optimize implementation of FromPyObject for BigInt and BigUint. #3379
PyIterator::from_object and PyByteArray::from now take a single argument of type &PyAny (previously took two arguments Python and AsPyPointer). #3389
Replace AsPyPointer with AsRef<PyAny> as a bound in the blanket implementation of From<&T> for PyObject. #3391
Replace blanket impl IntoPy<PyObject> for &T where T: AsPyPointer with implementations of impl IntoPy<PyObject> for &PyAny, &T where T: AsRef<PyAny>, and &Py<T>. #3393
Preserve std::io::Error kind in implementation of From<std::io::IntoInnerError> for PyErr#3396
Try to select a relevant ErrorKind in implementation of From<PyErr> for OSError subclass. #3397
Retrieve the original PyErr in implementation of From<std::io::Error> for PyErr if the std::io::Error has been built using a Python exception (previously would create a new exception wrapping the std::io::Error). #3402
#[pymodule] will now return the same module object on repeated import by the same Python interpreter, on Python 3.9 and up. #3446
Truncate leap-seconds and warn when converting chrono types to Python datetime types (datetime cannot represent leap-seconds). #3458
Err returned from #[pyfunction] will now have a non-None __context__ if called from inside a catch block. #3455
Deprecate undocumented #[__new__] form of #[new] attribute. #3505
Removed
Remove all functionality deprecated in PyO3 0.18, including #[args] attribute for #[pymethods]. #3232
Remove IntoPyPointer trait in favour of into_ptr inherent methods. #3385
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)
Bumps pyo3 from 0.19.2 to 0.20.0.
Release notes
Sourced from pyo3's releases.
Changelog
Sourced from pyo3's changelog.
... (truncated)
Commits
c77deeerelease: 0.20.0b03c4cbMerge pull request #3506 from davidhewitt/default-nee1d4173Fix bug in default implementation of__ne__b73c069Merge pull request #3504 from davidhewitt/classmethod-receiver76bf521Merge pull request #3505 from davidhewitt/deprecate_dunder_new6c90325deprecate undocumented#[__new__]form of#[new]c0b5004Merge pull request #3455 from davidhewitt/normalized-exceptions80bbb30Merge pull request #3500 from ecarrara/fix-eval-frame-py311ddc04eaemit helpful error hint for classmethod with receiver0e0e662fix _PyFrameEvalFunction. Since python 3.11 it receives a_PyInterpreterFrameDependabot 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