4dc6c1643e
Adds a "threadsafe" variant of `PyCell::try_borrow` which will fail instead of panicking if called on the wrong thread and use it in `call_traverse` to turn GC traversals of unsendable pyclasses into no-ops if on the wrong thread. This can imply leaking the underlying resource if the originator thread has already exited so that the GC will never run there again, but it does avoid hard aborts as we cannot raise an exception from within `call_traverse`.
3.6 KiB
3.6 KiB
#[pyclass] can be used with the following parameters:
| Parameter | Description |
|---|---|
crate = "some::path" |
Path to import the pyo3 crate, if it's not accessible at ::pyo3. |
dict |
Gives instances of this class an empty __dict__ to store custom attributes. |
extends = BaseType |
Use a custom baseclass. Defaults to PyAny |
freelist = N |
Implements a free list of size N. This can improve performance for types that are often created and deleted in quick succession. Profile your code to see whether freelist is right for you. |
frozen |
Declares that your pyclass is immutable. It removes the borrow checker overhead when retrieving a shared reference to the Rust struct, but disables the ability to get a mutable reference. |
get_all |
Generates getters for all fields of the pyclass. |
mapping |
Inform PyO3 that this class is a Mapping, and so leave its implementation of sequence C-API slots empty. |
module = "module_name" |
Python code will see the class as being defined in this module. Defaults to builtins. |
name = "python_name" |
Sets the name that Python sees this class as. Defaults to the name of the Rust struct. |
rename_all = "renaming_rule" |
Applies renaming rules to every getters and setters of a struct, or every variants of an enum. Possible values are: "camelCase", "kebab-case", "lowercase", "PascalCase", "SCREAMING-KEBAB-CASE", "SCREAMING_SNAKE_CASE", "snake_case", "UPPERCASE". |
sequence |
Inform PyO3 that this class is a Sequence, and so leave its C-API mapping length slot empty. |
set_all |
Generates setters for all fields of the pyclass. |
subclass |
Allows other Python classes and #[pyclass] to inherit from this class. Enums cannot be subclassed. |
text_signature = "(arg1, arg2, ...)" |
Sets the text signature for the Python class' __new__ method. |
unsendable |
Required if your struct is not Send. Rather than using unsendable, consider implementing your struct in a threadsafe way by e.g. substituting Rc with Arc. By using unsendable, your class will panic when accessed by another thread. Also note the Python's GC is multi-threaded and while unsendable classes will not be traversed on foreign threads to avoid UB, this can lead to memory leaks. |
weakref |
Allows this class to be weakly referenceable. |
All of these parameters can either be passed directly on the #[pyclass(...)] annotation, or as one or
more accompanying #[pyo3(...)] annotations, e.g.:
// Argument supplied directly to the `#[pyclass]` annotation.
#[pyclass(name = "SomeName", subclass)]
struct MyClass {}
// Argument supplied as a separate annotation.
#[pyclass]
#[pyo3(name = "SomeName", subclass)]
struct MyClass {}