everest.resources.descriptors

Attribute descriptors for resource classes.

everest.resources.descriptors.attribute_alias[source]

Descriptor for declaring an alias to another attribute declared by an attribute descriptor.

everest.resources.descriptors.attribute_base[source]

Abstract base class for all attribute descriptors.

Variables:
  • attr_type – the type (or interface) of the controlled entity attribute.
  • entity_attr – the entity attribute the descriptor references. May be None.
  • cardinality – indicates the cardinality of the relationship for non-terminal attributes. This is always None for terminal attributes.
  • id (int) – unique sequential numeric ID for this attribute. Since this ID is incremented each time a new resource attribute is declared, it can be used to establish a well-defined sorting order on all attribute declarations of a resource.
  • resource_attr – the resource attribute this descriptor is mapped to. This is set after instantiation.
everest.resources.descriptors.collection_attribute[source]

Descriptor for declaring collection attributes of a resource as attributes from its underlying entity.

everest.resources.descriptors.member_attribute[source]

Descriptor for declaring member attributes of a resource as attributes from its underlying entity.

everest.resources.descriptors.terminal_attribute[source]

Descriptor for declaring terminal attributes of a resource as attributes from its underlying entity.

A terminal attribute is an attribute that the framework will not look into any further for querying or serialization.

Project Versions

Previous topic

everest.resources.base

Next topic

everest.resources.entitystores

This Page