invoke.vendor.yaml

package documentation
(source)

Undocumented

Module composer Undocumented
Module constructor Undocumented
Module cyaml Undocumented
Module dumper Undocumented
Module emitter Undocumented
Module error Undocumented
Module events Undocumented
Module loader Undocumented
Module nodes Undocumented
Module parser Undocumented
Module reader Undocumented
Module representer Undocumented
Module resolver Undocumented
Module scanner Undocumented
Module serializer Undocumented
Module tokens Undocumented

From __init__.py:

Class YAMLObject An object that can dump itself to a YAML stream and load itself from a YAML stream.
Class YAMLObjectMetaclass The metaclass for YAMLObject.
Exception YAMLLoadWarning Undocumented
Function add_constructor Add a constructor for the given tag. Constructor is a function that accepts a Loader instance and a node object and produces the corresponding Python object.
Function add_implicit_resolver Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar. first is a sequence of possible initial characters or None.
Function add_multi_constructor Add a multi-constructor for the given tag prefix. Multi-constructor is called for a node if its tag starts with tag_prefix. Multi-constructor accepts a Loader instance, a tag suffix, and a node object and produces the corresponding Python object.
Function add_multi_representer Add a representer for the given type. Multi-representer is a function accepting a Dumper instance and an instance of the given data type or subtype and producing the corresponding representation node.
Function add_path_resolver Add a path based resolver for the given tag. A path is a list of keys that forms a path to a node in the representation tree. Keys can be string values, integers, or None.
Function add_representer Add a representer for the given type. Representer is a function accepting a Dumper instance and an instance of the given data type and producing the corresponding representation node.
Function compose Parse the first YAML document in a stream and produce the corresponding representation tree.
Function compose_all Parse all YAML documents in a stream and produce corresponding representation trees.
Function dump Serialize a Python object into a YAML stream. If stream is None, return the produced string instead.
Function dump_all Serialize a sequence of Python objects into a YAML stream. If stream is None, return the produced string instead.
Function emit Emit YAML parsing events into a stream. If stream is None, return the produced string instead.
Function full_load Parse the first YAML document in a stream and produce the corresponding Python object.
Function full_load_all Parse all YAML documents in a stream and produce corresponding Python objects.
Function load Parse the first YAML document in a stream and produce the corresponding Python object.
Function load_all Parse all YAML documents in a stream and produce corresponding Python objects.
Function load_warning Undocumented
Function parse Parse a YAML stream and produce parsing events.
Function safe_dump Serialize a Python object into a YAML stream. Produce only basic YAML tags. If stream is None, return the produced string instead.
Function safe_dump_all Serialize a sequence of Python objects into a YAML stream. Produce only basic YAML tags. If stream is None, return the produced string instead.
Function safe_load Parse the first YAML document in a stream and produce the corresponding Python object.
Function safe_load_all Parse all YAML documents in a stream and produce corresponding Python objects.
Function scan Scan a YAML stream and produce scanning tokens.
Function serialize Serialize a representation tree into a YAML stream. If stream is None, return the produced string instead.
Function serialize_all Serialize a sequence of representation trees into a YAML stream. If stream is None, return the produced string instead.
Function unsafe_load Parse the first YAML document in a stream and produce the corresponding Python object.
Function unsafe_load_all Parse all YAML documents in a stream and produce corresponding Python objects.
Function warnings Undocumented
Variable __version__ Undocumented
Variable __with_libyaml__ Undocumented
Variable _warnings_enabled Undocumented
__version__: str = (source)

Undocumented

__with_libyaml__: bool = (source)

Undocumented

_warnings_enabled: dict[str, bool] = (source)

Undocumented

def warnings(settings=None): (source)

Undocumented

def load_warning(method): (source)

Undocumented

def scan(stream, Loader=Loader): (source)

Scan a YAML stream and produce scanning tokens.

def parse(stream, Loader=Loader): (source)

Parse a YAML stream and produce parsing events.

def compose(stream, Loader=Loader): (source)

Parse the first YAML document in a stream and produce the corresponding representation tree.

def compose_all(stream, Loader=Loader): (source)

Parse all YAML documents in a stream and produce corresponding representation trees.

def load(stream, Loader=None): (source)

Parse the first YAML document in a stream and produce the corresponding Python object.

def load_all(stream, Loader=None): (source)

Parse all YAML documents in a stream and produce corresponding Python objects.

def full_load(stream): (source)

Parse the first YAML document in a stream and produce the corresponding Python object. Resolve all tags except those known to be unsafe on untrusted input.

def full_load_all(stream): (source)

Parse all YAML documents in a stream and produce corresponding Python objects. Resolve all tags except those known to be unsafe on untrusted input.

def safe_load(stream): (source)

Parse the first YAML document in a stream and produce the corresponding Python object. Resolve only basic YAML tags. This is known to be safe for untrusted input.

def safe_load_all(stream): (source)

Parse all YAML documents in a stream and produce corresponding Python objects. Resolve only basic YAML tags. This is known to be safe for untrusted input.

def unsafe_load(stream): (source)

Parse the first YAML document in a stream and produce the corresponding Python object. Resolve all tags, even those known to be unsafe on untrusted input.

def unsafe_load_all(stream): (source)

Parse all YAML documents in a stream and produce corresponding Python objects. Resolve all tags, even those known to be unsafe on untrusted input.

def emit(events, stream=None, Dumper=Dumper, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None): (source)

Emit YAML parsing events into a stream. If stream is None, return the produced string instead.

def serialize_all(nodes, stream=None, Dumper=Dumper, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None): (source)

Serialize a sequence of representation trees into a YAML stream. If stream is None, return the produced string instead.

def serialize(node, stream=None, Dumper=Dumper, **kwds): (source)

Serialize a representation tree into a YAML stream. If stream is None, return the produced string instead.

def dump_all(documents, stream=None, Dumper=Dumper, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True): (source)

Serialize a sequence of Python objects into a YAML stream. If stream is None, return the produced string instead.

def dump(data, stream=None, Dumper=Dumper, **kwds): (source)

Serialize a Python object into a YAML stream. If stream is None, return the produced string instead.

def safe_dump_all(documents, stream=None, **kwds): (source)

Serialize a sequence of Python objects into a YAML stream. Produce only basic YAML tags. If stream is None, return the produced string instead.

def safe_dump(data, stream=None, **kwds): (source)

Serialize a Python object into a YAML stream. Produce only basic YAML tags. If stream is None, return the produced string instead.

def add_implicit_resolver(tag, regexp, first=None, Loader=None, Dumper=Dumper): (source)

Add an implicit scalar detector. If an implicit scalar value matches the given regexp, the corresponding tag is assigned to the scalar. first is a sequence of possible initial characters or None.

def add_path_resolver(tag, path, kind=None, Loader=None, Dumper=Dumper): (source)

Add a path based resolver for the given tag. A path is a list of keys that forms a path to a node in the representation tree. Keys can be string values, integers, or None.

def add_constructor(tag, constructor, Loader=None): (source)

Add a constructor for the given tag. Constructor is a function that accepts a Loader instance and a node object and produces the corresponding Python object.

def add_multi_constructor(tag_prefix, multi_constructor, Loader=None): (source)

Add a multi-constructor for the given tag prefix. Multi-constructor is called for a node if its tag starts with tag_prefix. Multi-constructor accepts a Loader instance, a tag suffix, and a node object and produces the corresponding Python object.

def add_representer(data_type, representer, Dumper=Dumper): (source)

Add a representer for the given type. Representer is a function accepting a Dumper instance and an instance of the given data type and producing the corresponding representation node.

def add_multi_representer(data_type, multi_representer, Dumper=Dumper): (source)

Add a representer for the given type. Multi-representer is a function accepting a Dumper instance and an instance of the given data type or subtype and producing the corresponding representation node.