jinjyaml.representer module#

class jinjyaml.representer.Representer(tag: str)#

Bases: object

Representer for jinja2.Template tags.

When dumping an object into YAML string, convert Data to string.

Add the representer to PyYAML Dumper as below:

representer = jinjyaml.Representer("j2")  # No "!" here !!!
yaml.add_representer(Node, representer)
Parameters:

tag (str) –

tag: str#

YAML tag name for include statement

Attention

Custom YAML tag’s name starts with "!". But we MUST NOT put a "!" at the beginning here, because yaml.add_representer() will add the symbol itself.