acmecse.etc.Types.AttributePolicy

class documentation

class AttributePolicy: (source)

View In Hierarchy

Attribute policy for a single resource attribute.

Method select Return the n-th attributes in the dataclass.
Class Variable announcement Whether the attribute is announced.
Class Variable cardinality Cardinality of the attribute.
Class Variable choice Whether this attribute is part of a choice.
Class Variable ctype Definition name for a complex type attribute.
Class Variable etype Name of the enum type (if the attribute is of type enum).
Class Variable evalues Dict of enum values and interpretations.
Class Variable fname Name of the definition file.
Class Variable lname Long name of the attribute.
Class Variable lSize Mandatory size of a list.
Class Variable ltype Sub-type of a list as writen in the definition.
Class Variable lTypeName Sub-type of a list as writen in the definition.
Class Variable namespace Namespace of the attribute.
Class Variable optionalCreate Optionality of the attribute for create requests.
Class Variable optionalDiscovery Optionality of the attribute for discovery requests.
Class Variable optionalUpdate Optionality of the attribute for update requests.
Class Variable ptype Implementation type of the enum values.
Class Variable releases Tuple of releases that this attribute is valid for. If this attribute is None, then it is valid for all releases. If only one release is specified, then it is valid from that release onwards. If two releases are specified, then it is valid from the first release until the second release.
Class Variable rtypes List of resource types that this attribute is valid for.
Class Variable sname Short name of the attribute.
Class Variable type Type of the attribute.
Class Variable typeName The type as written in the definition.
Class Variable typeShortname Type name of the attribute.
def select(self, index: int) -> Any | None: (source)

Return the n-th attributes in the dataclass.

Parameters
index:intAttribute index
Returns
Any | Nonen-th attribute from the dataclass, or None in case of an error.
announcement: Announced = (source)

Whether the attribute is announced.

cardinality: Cardinality = (source)

Cardinality of the attribute.

choice: bool = (source)

Whether this attribute is part of a choice.

ctype: str = (source)

Definition name for a complex type attribute.

etype: str = (source)

Name of the enum type (if the attribute is of type enum).

evalues: dict[int, str] = (source)

Dict of enum values and interpretations.

fname: str = (source)

Name of the definition file.

lname: str = (source)

Long name of the attribute.

lSize: int = (source)

Mandatory size of a list.

ltype: BasicType = (source)

Sub-type of a list as writen in the definition.

lTypeName: str = (source)

Sub-type of a list as writen in the definition.

namespace: str = (source)

Namespace of the attribute.

optionalCreate: RequestOptionality = (source)

Optionality of the attribute for create requests.

optionalDiscovery: RequestOptionality = (source)

Optionality of the attribute for discovery requests.

optionalUpdate: RequestOptionality = (source)

Optionality of the attribute for update requests.

ptype: type = (source)

Implementation type of the enum values.

releases: tuple[str, str | None] = (source)

Tuple of releases that this attribute is valid for. If this attribute is None, then it is valid for all releases. If only one release is specified, then it is valid from that release onwards. If two releases are specified, then it is valid from the first release until the second release.

rtypes: set[ResourceTypes] = (source)

List of resource types that this attribute is valid for.

sname: str = (source)

Short name of the attribute.

type: BasicType = (source)

Type of the attribute.

typeName: str = (source)

The type as written in the definition.

typeShortname: str = (source)

Type name of the attribute.