salt.serializers.yaml

salt.serializers.yaml

Implements YAML serializer.

Underneath, it is based on pyyaml and use the safe dumper and loader. It also use C bindings if they are available.

salt.serializers.yaml.BaseDumper

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

salt.serializers.yaml.BaseLoader

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

salt.serializers.yaml.ConstructorError

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

exception salt.serializers.yaml.DeserializationError(message, line_num=None, buf='', marker='    <======================', trace=None)

Raised when stream of string failed to be deserialized

salt.serializers.yaml.Dumper

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

class salt.serializers.yaml.EncryptedString
static yaml_constructor(loader, tag, node)
static yaml_dumper(dumper, data)
yaml_tag = '!encrypted'
salt.serializers.yaml.Loader

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

class salt.serializers.yaml.OrderedDict
salt.serializers.yaml.ScannerError

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

exception salt.serializers.yaml.SerializationError(message='')

Raised when stream of string failed to be serialized

salt.serializers.yaml.deserialize(stream_or_string, **options)

Deserialize any string of stream like object into a Python data structure.

Parameters
  • stream_or_string -- stream or string to deserialize.

  • options -- options given to lower yaml module.

salt.serializers.yaml.serialize(obj, **options)

Serialize Python data to YAML.

Parameters
  • obj -- the data structure to serialize

  • options -- options given to lower yaml module.

salt.serializers.yaml.yaml

Mock out specified imports.

This allows autodoc to do its thing without having oodles of req'd installed libs. This doesn't work with import * imports.

This Mock class can be configured to return a specific values at specific names, if required.

https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules

Docs for previous releases are available on readthedocs.org.

Latest Salt release: 3002.7

Table of Contents

Previous topic

salt.serializers.toml

Next topic

salt.serializers.yamlex