Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Explain in docs why AttributePropety.at_get/set are not called if accessing attribute from AttributeHandler. Resolve #3034.

Browse source
This commit is contained in:
Griatch 2023-02-25 20:23:29 +01:00
parent a6df975624
commit a0133e4286
2 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
evennia/typeclasses/attributes.py
View file

@ -162,7 +162,9 @@ class AttributeProperty:
Attribute property descriptor. Allows for specifying Attributes as Django-like 'fields'
on the class level. Note that while one can set a lock on the Attribute,
there is no way to *check* said lock when accessing via the property - use
the full AttributeHandler if you need to do access checks.
the full `AttributeHandler` if you need to do access checks. Note however that if you use the
full `AttributeHandler` to access this Attribute, the `at_get/at_set` methods on this class will
_not_ fire (because you are bypassing the `AttributeProperty` entirely in that case).
Example:
::
@ -288,6 +290,11 @@ class AttributeProperty:
Raises:
AttributeError: If the value is invalid to store.
Notes:
This is will only fire if you actually set the Attribute via this `AttributeProperty`.
That is, if you instead set it via the `AttributeHandler` (or via `.db`), you are
bypassing this `AttributeProperty` entirely and this method is never reached.
"""
return value
@ -303,6 +310,11 @@ class AttributeProperty:
Returns:
any: The value to return to the caller.
Notes:
This is will only fire if you actually get the Attribute via this `AttributeProperty`.
That is, if you instead get it via the `AttributeHandler` (or via `.db`), you are
bypassing this `AttributeProperty` entirely and this method is never reached.
"""
return value