This release completes the implementation of automatically generated __text_signature__ for #[pymethods] and #[pyfunctions] by extending support for #[new] functions as well as rendering the value of simple default values such as integers, bools, and None in the generated signature.
Support for rust_decimal conversions to Python's decimal.Decimal has been added.
Usage of #[pyclass(frozen)] types becomes more powerful with the addition of Py::get to access contents of frozen classes without needing the Python GIL.
Some important fixes and removals have landed:
__traverse__ implementations may no longer access Python APIs or acquire the Python GIL. Attempting to use Python::with_gil will panic.
#[pyclass(unsendable)] types will now warn and skip Drop implementations when dropped on a thread other than the one the type was created on.
The deprecated Python::acquire_gil has been 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:
Correct dependency on syn to version 1.0.85 instead of the incorrect version 1.0.56. #3152
Added
Accept text_signature option (and automatically generate signature) for #[new] in #[pymethods]. #2980
Add support for converting to and from Python's decimal.Decimal and rust_decimal::Decimal. #3016
Add #[pyo3(from_item_all)] when deriving FromPyObject to specify get_item as getter for all fields. #3120
Add pyo3::exceptions::PyBaseExceptionGroup for Python 3.11, and corresponding FFI definition PyExc_BaseExceptionGroup. #3141
Accept #[new] with #[classmethod] to create a constructor which receives a (subtype's) class/PyType as its first argument. #3157
Add PyClass::get and Py::get for GIL-indepedent access to classes with #[pyclass(frozen)]. #3158
Add PyAny::is_exact_instance and PyAny::is_exact_instance_of. #3161
Changed
PyAny::is_instance_of::<T>(obj) is now equivalent to T::is_type_of(obj), and now returns bool instead of PyResult<bool>. #2881
Deprecate text_signature option on #[pyclass] structs. #2980
No longer wrap anyhow::Error/eyre::Report containing a basic PyErr without a chain in a PyRuntimeError. #3004
Change #[getter] and #[setter] to use a common call "trampoline" to slightly reduce generated code size and compile times. #3029
Improve default values for str, numbers and bool in automatically-generated text_signature. #3050
Improve default value for None in automatically-generated text_signature. #3066
Rename PySequence::list and PySequence::tuple to PySequence::to_list and PySequence::to_tuple. (The old names continue to exist as deprecated forms.) #3111
Extend the lifetime of the GIL token returned by PyRef::py and PyRefMut::py to match the underlying borrow. #3131
Safe access to the GIL, for example via Python::with_gil, is now locked inside of implementations of the __traverse__ slot. #3168
Removed
Remove all functionality deprecated in PyO3 0.17, most prominently Python::acquire_gil is replaced by Python::with_gil. #2981
Fixed
Correct FFI definitions PyGetSetDef, PyMemberDef, PyStructSequence_Field and PyStructSequence_Desc to have *const c_char members for name and doc (not *mut c_char). #3036
Fix panic on fmt::Display, instead return "<unprintable object>" string and report error via sys.unraisablehook()#3062
Fix a compile error of "temporary value dropped while borrowed" when #[pyfunction]s take references into #[pyclass]es #3142
Fix crashes caused by PyO3 applying deferred reference count updates when entering a __traverse__ implementation. #3168
Forbid running the Drop implementations of unsendable classes on other threads. #3176
Fix a compile error when #[pymethods] items come from somewhere else (for example, as a macro argument) and a custom receiver like Py<Self> is used. #3178
[0.18.3] - 2023-04-13
Added
Add GILProtected<T> to mediate concurrent access to a value using Python's global interpreter lock (GIL). #2975
Support PyASCIIObject / PyUnicode and associated methods on big-endian architectures. #3015
Add FFI definition _PyDict_Contains_KnownHash() for CPython 3.10 and up. #3088
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)
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
2500e22release: 0.19.0c7dd2e3Merge #3194c928a7apin chrono for msrv build03137e4Merge #3188c2d4e8aUse a full path for#[new]method which is also#[classmethod].d930bc1Verify that various macros do work without any PyO3 imports.cd4b27fMerge #3183f0b7399Add benchmark showing that extract::<i64> is costly due to PyNumber_Index try...0e50338Merge #31710f628c9Be more explicit of the soundness hole implied by tying Ungil to Send and men...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)