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.

Definition at line 221 of file __init__.py.

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.

Definition at line 201 of file __init__.py.

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.

Definition at line 229 of file __init__.py.

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.

Definition at line 247 of file __init__.py.

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.

Definition at line 211 of file __init__.py.

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.

Definition at line 238 of file __init__.py.

def yaml.compose	(	stream,
		Loader = `Loader`
	)

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

Definition at line 37 of file __init__.py.

def yaml.compose_all	(	stream,
		Loader = `Loader`
	)

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

Definition at line 46 of file __init__.py.

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.

Definition at line 177 of file __init__.py.

References dump_all().

Referenced by calculate_pairwise_RMSD(), initialize_native_pose(), main(), mg_modeler_test(), post_rebuild_bulge_assembly(), rebuild_test(), rna_build_helix_test(), rna_design_test(), and swa_rna_cluster().

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.

Definition at line 151 of file __init__.py.

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.

Definition at line 91 of file __init__.py.

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.

Definition at line 64 of file __init__.py.

Referenced by safe_load().

def yaml.load_all	(	stream,
		Loader = `Loader`
	)

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

Definition at line 55 of file __init__.py.

Referenced by safe_load_all().

def yaml.parse	(	stream,
		Loader = `Loader`
	)

Parse a YAML stream and produce parsing events.

Definition at line 29 of file __init__.py.

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.

Definition at line 192 of file __init__.py.

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.

Definition at line 184 of file __init__.py.

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.

Definition at line 81 of file __init__.py.

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.

Definition at line 73 of file __init__.py.

References load_all().

def yaml.scan	(	stream,
		Loader = `Loader`
	)

Scan a YAML stream and produce scanning tokens.

Definition at line 21 of file __init__.py.

Referenced by main().

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.

Definition at line 139 of file __init__.py.

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.

Definition at line 115 of file __init__.py.

Referenced by emit(), and serialize().

Namespaces

Classes

Functions

Function Documentation