carputils.cml Namespace Reference

Namespaces
	cmlconverter
	cmlparser
	cmltree

Functions
def	load_as_dict (fp, parser=YAMLParser)
	Parse data from a text file. More...
def	loads_as_dict (string, parser=YAMLParser)
	Parse data from a string. More...
def	load_as_dict_flat (fp, parser=YAMLParser)
	Parse data from a text file. More...
def	loads_as_dict_flat (string, parser=YAMLParser)
	Parse data from a string. More...
def	load_as_object (fp, parser=YAMLParser)
	Parse data from a text file. More...
def	loads_as_object (string, parser=YAMLParser)
	Parse data from a string. More...

Variables
	YAMLParser = CMLParserYAML(emptyValue='')
	Default YAML parser. More...
def	load = load_as_dict
	Default method to parse data from a file. More...
def	loads = loads_as_dict
	Default method to parse data from a string. More...

Function Documentation

load_as_dict()

def carputils.cml.load_as_dict	(		fp,
			parser = YAMLParser
	)

Parse data from a text file.

Parameters

fp	File pointer to the text file to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A dictionary data tree

load_as_dict_flat()

def carputils.cml.load_as_dict_flat	(		fp,
			parser = YAMLParser
	)

Parse data from a text file.

Parameters

fp	File pointer to the text file to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A flattened dictionary data tree

load_as_object()

def carputils.cml.load_as_object	(		fp,
			parser = YAMLParser
	)

Parse data from a text file.

Parameters

fp	File pointer to the text file to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A cmltree.CMLNamespace object representing the root of the data tree

loads_as_dict()

def carputils.cml.loads_as_dict	(		string,
			parser = YAMLParser
	)

Parse data from a string.

Parameters

string	String to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A dictionary data tree

loads_as_dict_flat()

def carputils.cml.loads_as_dict_flat	(		string,
			parser = YAMLParser
	)

Parse data from a string.

Parameters

string	String to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A flattened dictionary data tree

loads_as_object()

def carputils.cml.loads_as_object	(		string,
			parser = YAMLParser
	)

Parse data from a string.

Parameters

string	String to be parsed
parser	Parser to use, must be an instance of cmlparser.CMLParser

Returns

A cmltree.CMLNamespace object representing the root of the data tree

Variable Documentation

load

def carputils.cml.load = load_as_dict

Default method to parse data from a file.

loads

def carputils.cml.loads = loads_as_dict

Default method to parse data from a string.

YAMLParser

carputils.cml.YAMLParser = CMLParserYAML(emptyValue='')

Default YAML parser.