API: AdvancedProperty

class advanced_descriptors.AdvancedProperty(property)[source]

Advanced property main entry point.

New in version 2.1.0: Inherit property

__init__(fget=None, fset=None, fdel=None, fcget=None)[source]
Parameters:
  • fget (Callable[[_OwnerClassT], _ReturnT] | None) – normal getter.

  • fset (Callable[[_OwnerClassT, _ReturnT], None] | None) – normal setter.

  • fdel (Callable[[_OwnerClassT], None] | None) – normal deleter.

  • fcget (Callable[[type[_OwnerClassT]], _ClassReturnT] | None) – class getter. Used as normal, if normal is None.

Note

doc argument is not supported due to class wide getter usage.

getter(fget)

Descriptor to change the getter on a property.

Parameters:

fget (Callable[[_OwnerClassT], _ReturnT] | None) – new normal getter.

Return type:

AdvancedProperty

setter(fset)

Descriptor to change the setter on a property.

Parameters:

fset (Callable[[_OwnerClassT, _ReturnT], None] | None) – new setter.

Return type:

AdvancedProperty

deleter(fdel)

Descriptor to change the deleter on a property.

Parameters:

fdel (Callable[[_OwnerClassT], None] | None) – New deleter.

Return type:

AdvancedProperty

cgetter(fcget)[source]

Descriptor to change the class wide getter on a property.

Parameters:

fcget (Callable[[type[_OwnerClassT]], _ClassReturnT] | None) – new class-wide getter.

Return type:

AdvancedProperty

fget

Callable[[_OwnerClassT], _ReturnT] | None Getter instance.

fset

Callable[[_OwnerClassT, _ReturnT], None] | None Setter instance.

fdel

Callable[[_OwnerClassT], None] | None Deleter instance.

fcget

Callable[[type[_OwnerClassT]], _ClassReturnT] | None Class wide getter instance.