YANG Statements

This module implements the following classes:

Doctest snippets for this module use the YANG module example-5-a, see Example 5.

>>> dm = DataModel.from_file("yang-library-ex5.json")
>>> mex5a = dm.schema_data.modules[('example-5-a', '')].statement
class yangson.statement.Statement(kw: YangIdentifier, arg: Optional[str], pref: YangIdentifier = None)

An instance of this class represents a parsed YANG statement. The constructor arguments kw, arg and pref initialize instance attributes keyword, argument and prefix, respectively.

Instance Attributes


The statement’s keyword. For extension statements, this is the local part of the keyword.

>>> mex5a.keyword

Optional prefix of the statement keyword. It is None for all built-in statements, and for an extension statement it is the prefix of the module where the extension is defined.


The statement’s argument. It is the final value of the argument string in which all preliminary processing steps, i.e. substitution of escape sequences and concatenation of parts joined with +, have already been performed. For statements that have no argument, such as input, the value of this attribute is None.

>>> mex5a.argument

Parent statement, or None if there is no parent.


List of substatements.

>>> len(mex5a.substatements)

Public Methods

find1(kw: YangIdentifier, arg: str = None, pref: YangIdentifier = None, required: bool = False)

Return the first substatement of the receiver with a matching keyword and, optionally, argument. In order to match, the local part of the keyword has to be kw, and prefix has to be pref. If pref is None, only built-in statements match. The last argument, required, controls what happens if a matching substatement is not found: if required is True, then StatementNotFound is raised, otherwise None is returned. If arg is None, then the arguments of substatements are not taken into account.

>>> lfs = mex5a.find1('leaf', 'string-leaf')
>>> str(lfs)
'leaf "string-leaf" { ... }'
>>> lfs.superstmt.keyword
>>> mex5a.find1('rpc') is None
>>> mex5a.find1('rpc', required=True)
Traceback (most recent call last):
yangson.statement.StatementNotFound: `rpc' in `module "example-5-a" { ... }'
find_all(kw: YangIdentifier, pref: YangIdentifier = None) → List[Statement]

Return the list of all substatements with a matching keyword. The conditions on keyword matching are the same as for find1().

>>> len(mex5a.find_all('leaf'))
>>> mex5a.find_all('rpc')
get_definition(name: YangIdentifier, kw:
YangIdentifier) -> Statement:

Search the receiver’s parent statement and then all ancestor statements from inside out for the definition whose name is name. The second argument, kw, has to be grouping or typedef, and controls whtehr the method looks for the definition of a grouping or typedef, respectively.

This method raises DefinitionNotFound if the search is not successful.

>>> str(lfs.get_definition('my-string', 'typedef'))
'typedef "my-string" { ... }'
>>> lfs.get_definition('my-string', 'grouping') is None
class yangson.statement.ModuleParser(text: str)

This class is a subclass of Parser, and implements a recursive-descent parser for YANG modules. Source text of the YANG module is passed to the constructor in the text argument (see also the Parser.input attribute).

Public Methods

parse() → yangson.statement.Statement

Parse a complete YANG module or submodule.

mtext: Yang module text.
EndOfInput: If past the end of input. UnexpectedInput: If top-level statement isn’t (sub)module.

This method raises WrongArgument if a statement argument is invalid. It may also raise parsing exceptions defined in the parser module.

>>> with open('example-5-a.yang') as infile:
...     m5atxt = infile.read()
>>> str(ModuleParser(m5atxt).parse())
'module "example-5-a" { ... }'