cafe.engine.models package

cafe.engine.models.base module

class cafe.engine.models.base.AutoMarshallingDictModel

Bases: dict, cafe.engine.models.base.AutoMarshallingModel

Dict-like AutoMarshallingModel used for some special cases

class cafe.engine.models.base.AutoMarshallingListModel

Bases: list, cafe.engine.models.base.AutoMarshallingModel

List-like AutoMarshallingModel used for some special cases

class cafe.engine.models.base.AutoMarshallingModel

Bases: cafe.engine.models.base.BaseModel, cafe.engine.models.base.CommonToolsMixin, cafe.engine.models.base.JSON_ToolsMixin, cafe.engine.models.base.XML_ToolsMixin

@summary: A class used as a base to build and contain the logic necessary

to automatically create serialized requests and automatically deserialize responses in a format-agnostic way.

classmethod deserialize(serialized_str, format_type)

serialize(format_type)

class cafe.engine.models.base.BaseModel

Bases: object

class cafe.engine.models.base.CommonToolsMixin

Bases: object

Methods used to make building data models easier, common to all types

class cafe.engine.models.base.JSON_ToolsMixin

Bases: object

Methods used to make building json data models easier

class cafe.engine.models.base.XML_ToolsMixin

Bases: object

Methods used to make building xml data models easier

xml_header

cafe.engine.models.behavior_response module

class cafe.engine.models.behavior_response.BehaviorResponse

Bases: object

An object to represent the result of behavior. @ivar response: Last response returned from last client call @ivar ok: Represents the success state of the behavior call @type ok:C{bool} @ivar entity: Data model created via behavior calls, if applicable

cafe.engine.models.commandline_response module

@summary: Responses directly from the command line

class cafe.engine.models.commandline_response.CommandLineResponse

Bases: cafe.engine.models.base.BaseModel

Bare bones object for any Command Line Connector response @ivar Command: The full original command string for this response @type Command: C{str} @ivar StandardOut: The Standard Out generated by this command @type StandardOut: C{list} of C{str} @ivar StandardError: The Standard Error generated by this command @type StandardError: C{list} of C{str} @ivar ReturnCode: The command’s return code @type ReturnCode: C{int}

cafe.engine.models.data_interfaces module

class cafe.engine.models.data_interfaces.BaseConfigSectionInterface(config_file_path, section_name)

Bases: object

Base class for building an interface for the data contained in a SafeConfigParser object, as loaded from the config file as defined by the engine’s config file.

get(item_name, default=None)

get_boolean(item_name, default=None)

get_json(item_name, default=None)

get_raw(item_name, default=None)

exception cafe.engine.models.data_interfaces.ConfigDataException

Bases: exceptions.Exception

exception cafe.engine.models.data_interfaces.ConfigEnvironmentVariableError

Bases: exceptions.Exception

class cafe.engine.models.data_interfaces.ConfigParserDataSource(config_file_path, section_name)

Bases: cafe.engine.models.data_interfaces.DataSource

get(item_name, default=None)

get_boolean(item_name, default=None)

get_json(item_name, default=None)

get_raw(item_name, default=None)

class cafe.engine.models.data_interfaces.ConfigSectionInterface(config_file_path=None, section_name=None)

Bases: cafe.engine.models.data_interfaces.BaseConfigSectionInterface

class cafe.engine.models.data_interfaces.DataSource

Bases: object

get(item_name, default=None)

get_boolean(item_name, default=None)

get_json(item_name, default=None)

get_raw(item_name, default=None)

class cafe.engine.models.data_interfaces.DictionaryDataSource

Bases: cafe.engine.models.data_interfaces.DataSource

get(item_name, default=None)

get_boolean(item_name, default=None)

get_json(item_name, default=None)

get_raw(item_name, default=None)

class cafe.engine.models.data_interfaces.EnvironmentVariableDataSource(section_name)

Bases: cafe.engine.models.data_interfaces.DataSource

get(item_name, default=None)

get_boolean(item_name, default=None)

get_json(item_name, default=None)

get_raw(item_name, default=None)

class cafe.engine.models.data_interfaces.JSONDataSource(config_file_path, section_name)

Bases: cafe.engine.models.data_interfaces.DictionaryDataSource

class cafe.engine.models.data_interfaces.MongoDataSource(hostname, db_name, username, password, config_name, section_name)

Bases: cafe.engine.models.data_interfaces.DictionaryDataSource

exception cafe.engine.models.data_interfaces.NonExistentConfigPathError

Bases: exceptions.Exception

cafe.engine.models.data_interfaces.expected_values(*values)