Type Aliases

Type aliases for use with type hints [PEP484].

In order to keep class and method signatures readable, the documentation for other Yangson modules uses the names of type aliases unprefixed, i.e. without module names.

yangson.typealiases.DataPath

SchemaPath containing only names of data nodes.

yangson.typealiases.InstanceIdentifier

YANG instance identifier, see sec. 6.11 of [RFC7951].

yangson.typealiases.InstanceName

Object member name (simple or qualified), see sec. 4 of [RFC7951].

yangson.typealiases.JSONPointer

JSON Pointer [RFC6901].

yangson.typealiases.ModuleId

Module identifier: (YangIdentifier, RevisionDate).

alias of tuple[str, str]

yangson.typealiases.PrefName

Name with optional prefix – [YangIdentifier “:”] YangIdentifier.

yangson.typealiases.QualName

Qualified name, tuple of name and module name.

alias of tuple[str, str]

yangson.typealiases.RawEntry

Raw entry of a leaf-list or list.

alias of Union[bool, int, str, list[None], dict[str, RawValue]]

yangson.typealiases.RawLeafList

List of raw scalars.

alias of list[Union[bool, int, str, list[None]]]

yangson.typealiases.RawList

List of raw objects.

alias of list[dict[str, RawValue]]

yangson.typealiases.RawMetadataObject

Raw metadata object as returned by JSON parser.

alias of dict[str, Union[bool, int, str, list[None]]]

yangson.typealiases.RawObject

Raw object as returned by JSON parser.

alias of dict[str, RawValue]

yangson.typealiases.RawScalar

Raw scalar value as produced by JSON parser.

alias of Union[bool, int, str, list[None]]

yangson.typealiases.RawValue

Raw value of any type.

alias of Union[bool, int, str, list[None], dict[str, RawValue], list[dict[str, RawValue]], list[Union[bool, int, str, list[None]]]]

yangson.typealiases.ResourceIdentifier

RESTCONF resource identifier, see sec. 3.5.3 of [RFC8040].

yangson.typealiases.RevisionDate

RevisionDate in the format YYYY-MM-DD, or empty string.

yangson.typealiases.ScalarValue

Scalar value of an InstanceNode.

alias of Union[int, Decimal, str, tuple[None]]

yangson.typealiases.SchemaNodeId

Schema node identifier, see. sec. 6.5 in [RFC7950].

yangson.typealiases.SchemaPath

Schema path similar to instance identifier containing names of schema nodes.

yangson.typealiases.SchemaRoute

Schema route, a list of qualified names of schema nodes.

alias of list[tuple[str, str]]

yangson.typealiases.YangIdentifier

YANG identifier, see sec. 6.2 of [RFC7950].