Skip to content

openstb.simulator.config_loader.toml

Classes:

Name Description
TOMLLoader

Load simulation configuration from a TOML file.

TOMLLoader 

TOMLLoader(filename)

Bases: ConfigLoader

Load simulation configuration from a TOML file.

The file may contain an entry include giving a list of other filenames to parse and merge into its configuration. This include behaviour is nested, i.e., any included file may also specify an include list. Any relative filenames are evaluated from the directory containing the file currently being processed.

Included files may not overwrite values that have already been set. An exception is made for values from an array of tables; in this case, included tables are appended to the end of the current array.

Parameters:

Name Type Description Default
filename PathLike[str] | str

The path to the configuration file.

 required
Source code in openstb/simulator/config_loader/toml.py 
30
31
32
33
34
35
36
37
38
39
def __init__(self, filename: os.PathLike[str] | str):
    """
    Parameters
    ----------
    filename
        The path to the configuration file.

    """
    self.filename = Path(filename)
    self._who_defined: dict[str, Path] = {}