Gelatin.generator package

Module contents

Gelatin.generator.new(format)

Gelatin.generator.Builder module

class Gelatin.generator.Builder.Builder

Bases: object

Abstract base class for all generators.

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

add(path, data=None, replace=False)

Creates the given node if it does not exist. Returns the (new or existing) node.

add_attribute(path, name, value)

Creates the given attribute and sets it to the given value. Returns the (new or existing) node to which the attribute was added.

create(path, data=None)

Creates the given node, regardless of whether or not it already exists. Returns the new node.

dump()

enter(path)

Enters the given node. Creates it if it does not exist. Returns the node.

leave()

Returns to the node that was selected before the last call to enter(). The history is a stack, to the method may be called multiple times.

open(path)

Creates and enters the given node, regardless of whether it already exists. Returns the new node.

serialize(serializer)

serialize_to_file(filename)

class Gelatin.generator.Builder.Node(name, attribs=None)

Bases: object

__init__(name, attribs=None)

x.__init__(…) initializes x; see help(type(x)) for signature

add(child)

dump(indent=0)

get_child(name, attribs=None)

Returns the first child that matches the given name and attributes.

to_dict()

class Gelatin.generator.Builder.OrderedDefaultDict(default_factory=None, *a, **kw)

Bases: collections.OrderedDict

__init__(default_factory=None, *a, **kw)

Initialize an ordered dictionary. The signature is the same as regular dictionaries, but keyword arguments are not recommended because their insertion order is arbitrary.

copy() → a shallow copy of od

Gelatin.generator.Builder.nodehash(name, attribs)

Gelatin.generator.Dummy module

class Gelatin.generator.Dummy.Dummy

Bases: Gelatin.generator.Builder.Builder

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

add(path, data=None, replace=False)

Creates the given node if it does not exist. Returns the (new or existing) node.

add_attribute(path, name, value)

Creates the given attribute and sets it to the given value. Returns the (new or existing) node to which the attribute was added.

dump()

enter(path)

Enters the given node. Creates it if it does not exist. Returns the node.

leave()

Returns to the node that was selected before the last call to enter(). The history is a stack, to the method may be called multiple times.

open(path)

Creates and enters the given node, regardless of whether it already exists. Returns the new node.

serialize()

Gelatin.generator.Json module

class Gelatin.generator.Json.Json

Bases: object

serialize_doc(node)

Gelatin.generator.Xml module

class Gelatin.generator.Xml.Xml

Bases: object

serialize_doc(node)

serialize_node(node)

Gelatin.generator.Yaml module

class Gelatin.generator.Yaml.Yaml

Bases: object

serialize_doc(node)

Gelatin.generator.Yaml.represent_ordereddict(dumper, data)