Implement property support #208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markbt
force-pushed
the
properties
branch
2 times, most recently
from
f2510ca
to
1870c93
Compare
|
Looks like this needs a rebase now |
Since these are just pointers or Py_ssize_t, there's not much to gain by treating them as uninitialized, and std::mem::uninitialized is now deprecated.
This allows slot implementations with a single parameter (in particular,
__compare__, __getitem__, __delitem__, and in-place operators like __iadd__),
as well as __richcmp__ to work with reference types (types that implement
RefFromPyObject) as well as full types (types that implement FromPyObject).
Additionally, optional references are included. This is an improvement over
normal methods, so this is extended to normal methods, too.
The syntax is the same as for methods, e.g.
def __contains__(&self, key: &KeyType) -> PyResult<bool>
will generate a method where the key will be borrowed from the PyObject,
rather than copied.
Similarly for optional references:
def __contains__(&self, key: Option<&KeyType>) -> PyResult<bool>
will be the same, except that the key will be `None` if the user provided
Python `None`.
The `__setitem__` method only supports reference extraction for the first
parameter (the key). The value still needs to be a fully extracted type.
Binary arithmetic operators, like __add__, are not included.
Add support for defining Python properties (attributes with getters and
optional setters) in Rust.
Properties are defined inside `py_class!` with:
@Property def property_name(&self) -> PyResult<PropertyType> { ... }
where `property_name` is the name in Python, and `PropertyType` is any type
that impls `ToPyObject`.
Property setters can optionally be defined as:
@property_name.setter def set_property_name(
&self,
value: Option<PropertyType>
) -> PyResult<()> { ... }
If the value is `None` then the caller is deleting the property
(`del obj.property_name`).
If the value is `Some(x)` then the caller is setting the property to `x`.
For setters, the `PropertyType` can be any type that impls `FromPyObject`,
or a reference or optional reference to any type that impls `RefFromPyObject`.
In the latter case, the type of `value` is `Option<Option<&PropertyType>>`,
where `None` means the value is being deleted, `Some(None)` means the property
is being set to Python `None`, and `Some(Some(x))` means the property is being
set to `x`.
Like other identifiers, strip the leading 'r#' from the Python version of the identifier name. Also make raw identifier stripping and docstring processing consistent.
|
I've rebased both PRs. It looks like @gracinet didn't spot my latest change that removed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for defining Python properties (attributes with getters and optional setters) in Rust.
Properties are defined inside
py_class!with:where
property_nameis the name in Python, andPropertyTypeis any type that implsToPyObject.Property setters can optionally be defined as:
If the value is
Nonethen the caller is deleting the property (del obj.property_name).If the value is
Some(x)then the caller is setting the property tox.For setters, the
PropertyTypecan be any type that implsFromPyObject, or a reference or optional reference to any type that implsRefFromPyObject.In the latter case, the type of
valueisOption<Option<&PropertyType>>, whereNonemeans the value is being deleted,Some(None)means the property is being set to PythonNone, andSome(Some(x))means the property is being set tox.