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.


SchemaPath containing only names of data nodes.

alias of str


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

alias of str


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

alias of str


JSON Pointer [RFC6901].

alias of str

yangson.typealiases.ModuleId = typing.Tuple[str, str]

Module identifier: (YangIdentifier, RevisionDate).


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

alias of str

yangson.typealiases.QualName = typing.Tuple[str, str]

Qualified name, tuple of name and module name.

yangson.typealiases.RawEntry = typing.Union[bool, int, str, typing.List[NoneType], typing.Dict[str, ForwardRef('RawValue')]]

Raw entry of a leaf-list or list.

yangson.typealiases.RawLeafList = typing.List[typing.Union[bool, int, str, typing.List[NoneType]]]

List of raw scalars.

yangson.typealiases.RawList = typing.List[typing.Dict[str, ForwardRef('RawValue')]]

List of raw objects.

yangson.typealiases.RawObject = typing.Dict[str, ForwardRef('RawValue')]

Raw object as returned by JSON parser.

yangson.typealiases.RawScalar = typing.Union[bool, int, str, typing.List[NoneType]]

Raw scalar value as produced by JSON parser.

yangson.typealiases.RawValue = typing.Union[bool, int, str, typing.List[NoneType], typing.Dict[str, ForwardRef('RawValue')], typing.List[typing.Dict[str, ForwardRef('RawValue')]], typing.List[typing.Union[bool, int, str, typing.List[NoneType]]]]

Raw value of any type.


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

alias of str


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

alias of str

yangson.typealiases.ScalarValue = typing.Union[int, decimal.Decimal, str, typing.Tuple[NoneType]]

Scalar value of an InstanceNode.


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

alias of str


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

alias of str

yangson.typealiases.SchemaRoute = typing.List[typing.Tuple[str, str]]

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


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

alias of str