yaml_include.data module¶

class yaml_include.data.Data(urlpath: str, sequence_params: ~collections.abc.Sequence[~typing.Any] = <factory>, mapping_params: ~collections.abc.Mapping[str, ~typing.Any] = <factory>)[source]¶

Bases: object

A dataclasses.dataclass() store YAML include statement

Parameters:

urlpath (str)
sequence_params (Sequence[Any])
mapping_params (Mapping[str, Any])

urlpath: str¶

url/path of the YAML include statement

urlpath can be either absolute (like /usr/src/Python-1.5/*.yml) or relative (like ../../Tools/*/*.yml), and can contain shell-style wildcards.

We support "**", "?" and "[..]". We do not support "^" for pattern negation. The maxdepth option is applied on the first "**" found in the path.

Warning

Using the "**" pattern in large directory trees or remote files may consume an inordinate amount of time.

sequence_params: Sequence[Any]¶: sequence parameters of the YAML include statement.

mapping_params: Mapping[str, Any]¶: mapping parameters of the YAML include statement