skbio.util.classproperty

class skbio.util.classproperty(func)

Decorator for class-level properties.

Supports read access only. The property will be read-only within an instance. However, the property can always be redefined on the class, since Python classes are mutable.

Parameters

func (function) – Method to make a class property.

Returns

Decorated method.

Return type

property

Raises

AttributeError – If the property is set on an instance.

Attributes

fdel
fget
fset

Built-ins

__delete__(instance, /)	Delete an attribute of instance.
__eq__(value, /)	Return self==value.
__ge__(value, /)	Return self>=value.
__get__(cls, owner)	Return an attribute of instance, which is of type owner.
__gt__(value, /)	Return self>value.
__hash__()	Return hash(self).
__le__(value, /)	Return self<=value.
__lt__(value, /)	Return self<value.
__ne__(value, /)	Return self!=value.
__set__(obj, value)	Set an attribute of instance to value.
__set_name__	Method to set name of a property.
__str__()	Return str(self).

Methods

deleter	Descriptor to change the deleter on a property.
getter	Descriptor to change the getter on a property.
setter	Descriptor to change the setter on a property.