yaml Namespace Reference

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

Classes
class	YAMLObject
class	YAMLObjectMetaclass

Functions
def	scan
def	parse
def	compose
def	compose_all
def	load_all
def	load
def	safe_load_all
def	safe_load
def	emit
def	serialize_all
def	serialize
def	dump_all
def	dump
def	safe_dump_all
def	safe_dump
def	add_implicit_resolver
def	add_path_resolver
def	add_constructor
def	add_multi_constructor
def	add_representer
def	add_multi_representer

Function Documentation

def yaml.add_constructor	(		tag,
			constructor,
			Loader = Loader
	)

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 yaml.add_implicit_resolver	(		tag,
			regexp,
			first = None,
			Loader = Loader,
			Dumper = Dumper
	)

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.

Referenced by safe_dump().

def yaml.add_multi_constructor	(		tag_prefix,
			multi_constructor,
			Loader = Loader
	)

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 yaml.add_multi_representer	(		data_type,
			multi_representer,
			Dumper = Dumper
	)

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.

def yaml.add_path_resolver	(		tag,
			path,
			kind = None,
			Loader = Loader,
			Dumper = Dumper
	)

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 yaml.add_representer	(		data_type,
			representer,
			Dumper = Dumper
	)

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 yaml.compose	(		stream,
			Loader = Loader
	)

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

def yaml.compose_all	(		stream,
			Loader = Loader
	)

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

def yaml.dump	(		data,
			stream = None,
			Dumper = Dumper,
			kwds
	)

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

References dump_all().

def yaml.dump_all	(		documents,
			stream = None,
			Dumper = Dumper,
			default_style = None,
			default_flow_style = None,
			canonical = None,
			indent = None,
			width = None,
			allow_unicode = None,
			line_break = None,
			encoding = 'utf-8',
			explicit_start = None,
			explicit_end = None,
			version = None,
			tags = None
	)

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

Referenced by dump(), safe_dump(), safe_dump_all(), and serialize().

def yaml.emit	(		events,
			stream = None,
			Dumper = Dumper,
			canonical = None,
			indent = None,
			width = None,
			allow_unicode = None,
			line_break = None
	)

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

References serialize_all().

Referenced by safe_load().

def yaml.load	(		stream,
			Loader = Loader
	)

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

Referenced by safe_load().

def yaml.load_all	(		stream,
			Loader = Loader
	)

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

Referenced by safe_load_all().

def yaml.parse	(		stream,
			Loader = Loader
	)

Parse a YAML stream and produce parsing events.

def yaml.safe_dump	(		data,
			stream = None,
			kwds
	)

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

References add_implicit_resolver(), and dump_all().

def yaml.safe_dump_all	(		documents,
			stream = None,
			kwds
	)

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

References dump_all().

def yaml.safe_load

(

stream

)

Parse the first YAML document in a stream
and produce the corresponding Python object.
Resolve only basic YAML tags.

References emit(), and load().

def yaml.safe_load_all

(

stream

)

Parse all YAML documents in a stream
and produce corresponding Python objects.
Resolve only basic YAML tags.

References load_all().

def yaml.scan	(		stream,
			Loader = Loader
	)

Scan a YAML stream and produce scanning tokens.

def yaml.serialize	(		node,
			stream = None,
			Dumper = Dumper,
			kwds
	)

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

References dump_all(), and serialize_all().

def yaml.serialize_all	(		nodes,
			stream = None,
			Dumper = Dumper,
			canonical = None,
			indent = None,
			width = None,
			allow_unicode = None,
			line_break = None,
			encoding = 'utf-8',
			explicit_start = None,
			explicit_end = None,
			version = None,
			tags = None
	)

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

Referenced by emit(), and serialize().