anyconfig.backend.yaml

YAML backend.

Changed in version 0.3: Changed special keyword option ‘ac_safe’ from ‘safe’ to avoid possibility of option conflicts in the future.

• Format to support: YAML, http://yaml.org
• Requirements: PyYAML (yaml), http://pyyaml.org
• Limitations: None obvious
• Special options:
  • All keyword options of yaml.safe_load, yaml.load, yaml.safe_dump and yaml.dump should work.
  • Use ‘ac_safe’ boolean keyword option if you prefer to call yaml.safe_load and yaml.safe_dump instead of yaml.load and yaml.dump
  • See also: http://pyyaml.org/wiki/PyYAMLDocumentation

anyconfig.backend.yaml._yml_fnc(fname, *args, **kwargs)

An wrapper of yaml.safe_load, yaml.load, yaml.safe_dump and yaml.dump.

Parameters:

• fname – “load” or “dump”, not checked but it should be OK. see also _yml_load() and _yml_dump()
• args – [stream] for load or [cnf, stream] for dump
• kwargs – keyword args may contain “ac_safe” to load/dump safely

anyconfig.backend.yaml._yml_load(stream, **kwargs)

An wrapper of yaml.safe_load and yaml.load.

Parameters:stream – a file or file-like object to load YAML content

anyconfig.backend.yaml._yml_dump(cnf, stream, **kwargs)

An wrapper of yaml.safe_dump and yaml.dump.

Parameters:

• cnf – Configuration data (dict-like object) to dump
• stream – a file or file-like object to load YAML content

class anyconfig.backend.yaml.Parser

Bases: anyconfig.backend.base.FromStreamLoader, anyconfig.backend.base.ToStreamDumper

Parser for YAML files.

_type = 'yaml'

_extensions = ['yaml', 'yml']

_load_opts = ['Loader', 'ac_safe']

_dump_opts = ['stream', 'Dumper']

load_from_stream(*args, **kwargs)

An wrapper of yaml.safe_load and yaml.load.

Parameters:stream – a file or file-like object to load YAML content

dump_to_stream(*args, **kwargs)

An wrapper of yaml.safe_dump and yaml.dump.

Parameters:

• cnf – Configuration data (dict-like object) to dump
• stream – a file or file-like object to load YAML content

__module__ = 'anyconfig.backend.yaml'