This release fixes several bugs identified since PyO3 0.18.0, including a segfault and a Windows-specific issue with the PyIterator type, which would incorrectly accept any Python class regardless of whether it defined __next__ or not.
Some new APIs have been added such as PyErr::write_unraisable(), PyAny::is_ellipsis() and PyDict::update.
Thank you to the following users for the improvements:
This release contains a number of new features for PyO3's macros which should make maintaining PyO3 projects easier.
#[pyfunction] and #[pymethods] have a new #[pyo3(signature = (...))] option which allows specifying the Python signature. This replaces the #[args] option already present for #[pymethods]; the new option is better-validated and offers a syntax much more intuitive to users familiar with writing pure-Python functions.
#[pyclass] has new get_all and set_all options for cases where all fields of a type should be readable or writable from Python.
The #[pyo3(text_signature = "...")] option is now autogenerated for all functions created with #[pyfunction] and #[pymethods]. It can still be applied manually when it is necessary to override the generated form.
As well as the macro API improvements, some other notable changes include:
PySet::new and PyFrozenSet::new now accept Rust iterators rather than requiring a slice.
Rust types have been added for all Python's built-in Warning types.
Non-zero integer types in std::num now have a conversion to/from Python int.
The deprecated #[pyproto] attribute is now 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 users' commits are included in this release:
Add Python::Ellipsis() and PyAny::is_ellipsis() methods. #2911
Add PyDict::update() and PyDict::update_if_missing() methods. #2912
Changed
FFI definition PyIter_Check on CPython 3.7 is now implemented as hasattr(type(obj), "__next__"), which works correctly on all platforms and adds support for abi3. #2914
Warn about unknown config keys in PYO3_CONFIG_FILE instead of denying. #2926
Fixed
Send errors returned by __releasebuffer__ to sys.unraisablehook rather than causing SystemError. #2886
Fix downcast to PyIterator succeeding for Python classes which did not implement __next__. #2914
Fix segfault in __traverse__ when visiting None fields of Option<T: AsPyPointer>. #2921
Fix #[pymethods(crate = "...")] option being ignored. #2923
Link against pythonXY_d.dll for debug Python builds on Windows. #2937
Add GILOnceCell::get_or_try_init for fallible GILOnceCell initialization. #2398
Add experimental feature experimental-inspect with type_input() and type_output() helpers to get the Python type of any Python-compatible object. #2490#2882
The #[pyclass] macro can now take get_all and set_all to create getters and setters for every field. #2692
Add #[pyo3(signature = (...))] option for #[pyfunction] and #[pymethods]. #2702
pyo3-build-config: rebuild when PYO3_ENVIRONMENT_SIGNATURE environment variable value changes. #2727
Add conversions between non-zero int types in std::num and Python int. #2730
Add Py::downcast() as a companion to PyAny::downcast(), as well as downcast_unchecked() for both types. #2734
Add types for all built-in Warning classes as well as PyErr::warn_explicit. #2742
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 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.16.5 to 0.18.1.
Release notes
Sourced from pyo3's releases.
... (truncated)
Changelog
Sourced from pyo3's changelog.
... (truncated)
Commits
37d377e
release: 0.18.19e5c845
Merge #29342db351b
Merge #2937d67a8dc
link against pythonXY_d.dll for debug Python on Windows1e4dc54
Merge #2936bc1a33f
bump maturin version in getting_started.md4d80475
Merge #29299306d56
docs: Precise the abscense ofpy: Python
for the #[pyo3(signature)]c709f30
guide: add documentation for trailing option arguments806eed5
Merge #2914Dependabot 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 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)