BigBrotherBot v1.9.0
System Development Information for the BigBrotherBot project.

b3::lib::yaml Namespace Reference

Namespaces

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

Classes

class  YAMLObjectMetaclass
class  YAMLObject

Functions

def scan
def parse
def compose
def compose_all
def load
def load_all
def safe_load
def safe_load_all
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

Variables

string __version__ = '3.09'
 __with_libyaml__ = True

Function Documentation

def b3::lib::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 b3::lib::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.
def b3::lib::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 b3::lib::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 b3::lib::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 b3::lib::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 b3::lib::yaml::compose (   stream,
  Loader = Loader 
)
Parse the first YAML document in a stream
and produce the corresponding representation tree.
def b3::lib::yaml::compose_all (   stream,
  Loader = Loader 
)
Parse all YAML documents in a stream
and produce corresponding representation trees.
def b3::lib::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.
def b3::lib::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.
def b3::lib::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.
def b3::lib::yaml::load (   stream,
  Loader = Loader 
)
Parse the first YAML document in a stream
and produce the corresponding Python object.
def b3::lib::yaml::load_all (   stream,
  Loader = Loader 
)
Parse all YAML documents in a stream
and produce corresponding Python objects.
def b3::lib::yaml::parse (   stream,
  Loader = Loader 
)
Parse a YAML stream and produce parsing events.
def b3::lib::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.
def b3::lib::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.
def b3::lib::yaml::safe_load (   stream)
Parse the first YAML document in a stream
and produce the corresponding Python object.
Resolve only basic YAML tags.
def b3::lib::yaml::safe_load_all (   stream)
Parse all YAML documents in a stream
and produce corresponding Python objects.
Resolve only basic YAML tags.
def b3::lib::yaml::scan (   stream,
  Loader = Loader 
)
Scan a YAML stream and produce scanning tokens.
def b3::lib::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.
def b3::lib::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.

Variable Documentation

string b3::lib::yaml::__version__ = '3.09'
 All Classes Namespaces Files Functions Variables Properties