honeycomb package

Subpackages

Submodules

honeycomb.cli module

Honeycomb Command Line Interface.

class honeycomb.cli.MyLogger(name, level=0)[source]

Bases: logging.Logger

Custom Logger.

makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)[source]

Override default logger to allow overriding of internal attributes.

honeycomb.cli.setup_logging(home, verbose)[source]

Configure logging for honeycomb.

honeycomb.defs module

Honeycomb defs and constants.

class honeycomb.defs.BaseCollection[source]

Bases: object

Abstract type collection mixin, should hold BaseNameLabel attributes.

class honeycomb.defs.BaseNameLabel(name, label)[source]

Bases: object

Generic name/label class.

honeycomb.defs.CONFIG_FILE_NAME = 'config.json'

Parameters constants.

class honeycomb.defs.ConfigField(validator_func, get_error_message)[source]

Bases: object

Config Validator.

error_message is also a function to calculate the error when we ran the validator_func

honeycomb.defs.GITHUB_RAW_URL = 'https://raw.githubusercontent.com/Cymmetria/honeycomb_plugins/master/{plugin_type}/{plugin}/{filename}'

Config constants.

class honeycomb.defs.IBaseType[source]

Bases: object

Abstract type interface, provides BaseNameLabel collection methods.

classmethod all_labels()[source]

Return list of all property labels.

classmethod all_names()[source]

Return list of all property names.

honeycomb.error_messages module

Honeycomb generic error messages.

honeycomb.exceptions module

Honeycomb Exceptions.

exception honeycomb.exceptions.BaseHoneycombException(*args, **kwargs)[source]

Bases: click.exceptions.ClickException

Base Exception.

msg_format = None
exception honeycomb.exceptions.ConfigFieldMissing(*args, **kwargs)[source]

Bases: honeycomb.exceptions.ConfigValidationError

Field is missing from config file.

msg_format = 'field {} is missing from config file'
exception honeycomb.exceptions.ConfigFieldTypeMismatch(*args, **kwargs)[source]

Bases: honeycomb.exceptions.ConfigValidationError

Config field does not match specified type.

msg_format = 'Parameters: Bad value for {}={} (must be {})'
exception honeycomb.exceptions.ConfigFieldValidationError(*args, **kwargs)[source]

Bases: honeycomb.exceptions.ConfigValidationError

Error validating config field.

msg_format = 'Failed to import config. error in field {} with value {}: {}'
exception honeycomb.exceptions.ConfigFileNotFound(*args, **kwargs)[source]

Bases: honeycomb.exceptions.PluginError

Config file not found.

msg_format = 'Missing file {}'
exception honeycomb.exceptions.ConfigValidationError(*args, **kwargs)[source]

Bases: honeycomb.exceptions.BaseHoneycombException

Base config validation error.

exception honeycomb.exceptions.ParametersFieldError(*args, **kwargs)[source]

Bases: honeycomb.exceptions.ConfigValidationError

Error validating parameter.

msg_format = "Parameters: '{}' is not a valid {}"
exception honeycomb.exceptions.PathNotFound(*args, **kwargs)[source]

Bases: honeycomb.exceptions.BaseHoneycombException

Specified path was not found.

msg_format = 'Cannot find path {}'
exception honeycomb.exceptions.PluginAlreadyInstalled(*args, **kwargs)[source]

Bases: honeycomb.exceptions.PluginError

Plugin already installed.

msg_format = '{} is already installed'
exception honeycomb.exceptions.PluginError(*args, **kwargs)[source]

Bases: honeycomb.exceptions.BaseHoneycombException

Base Plugin Exception.

exception honeycomb.exceptions.PluginNotFoundInOnlineRepo(*args, **kwargs)[source]

Bases: honeycomb.exceptions.PluginError

Plugin not found in online repo.

msg_format = 'Cannot find {} in online repository'
exception honeycomb.exceptions.PluginRepoConnectionError(*args, **kwargs)[source]

Bases: honeycomb.exceptions.PluginError

Connection error when trying to connect to plugin repo.

msg_format = 'Unable to access online repository (check debug logs for detailed info)'
exception honeycomb.exceptions.RequiredFieldMissing(*args, **kwargs)[source]

Bases: honeycomb.exceptions.PluginError

Required parameter is missing.

msg_format = "Parameters: '{}' is missing (use --args to see all parameters)"