Module cvtool.ESGF.ESGConfigParser.custom_exceptions

:platform: Unix :synopsis: Custom exceptions.

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
    :platform: Unix
    :synopsis: Custom exceptions.

"""


class NoConfigFile(Exception):
    """
    Raised when no configuration file found.

    """

    def __init__(self, config_file):
        self.msg = "File not found"
        self.msg += "\n<file: '{}'>".format(config_file)
        super(self.__class__, self).__init__(self.msg)


class ConfigException(Exception):
    """
    Basic exception for configuration parsing errors.

    """
    # Constants initialized with configuration instantiation
    # Configuration files to read
    FILE = None
    # Section to parse
    SECTION = None

    def __init__(self, msg):
        self.config_file = ConfigException.FILE
        self.section = ConfigException.SECTION
        self.msg = msg
        if self.section:
            self.msg += "\n<section: '{}'>".format(self.section)
        if self.config_file:
            self.msg += "\n<file: '{}'>".format(self.config_file)
        super(ConfigException, self).__init__(self.msg)


class EmptyConfigFile(ConfigException):
    """
    Raised when configuration file is empty.

    """

    def __init__(self):
        self.msg = "Empty configuration file"
        super(self.__class__, self).__init__(self.msg)


class NoConfigSection(ConfigException):
    """
    Raised when no corresponding section found in configuration file.

    """

    def __init__(self):
        self.msg = "Section not found"
        super(self.__class__, self).__init__(self.msg)


class NoConfigOption(ConfigException):
    """
    Raised when no corresponding option found in a section of the configuration file.

    """

    def __init__(self, option):
        self.msg = "Option not found"
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class NoConfigOptions(ConfigException):
    """
    Raised when no corresponding options type found in a section of the configuration file.

    """

    def __init__(self, option):
        self.msg = "No options found"
        self.msg += "\n<options: '{}_{{options|map|pattern}}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class NoConfigValue(ConfigException):
    """
    Raised when no corresponding value found in option of a section from the configuration file.

    """

    def __init__(self, value, option):
        self.msg = "Value not found".format(value)
        self.msg += "\n<value: '{}'>".format(value)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class NoConfigKey(ConfigException):
    """
    Raised when no corresponding key found in option of a section from the configuration file.

    """

    def __init__(self, key, option):
        self.msg = "Key not found"
        self.msg += "\n<key: '{}'>".format(key)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class NoConfigVariable(ConfigException):
    """
    Raised when a ``%(facet)s`` pattern is missing into ``directory_format`` regex.

    """

    def __init__(self, option, pattern):
        self.msg = "Pattern not found in regular expression (try to add a maptable)"
        self.msg += "\n<pattern: '%({})s'>".format(option)
        self.msg += "\n<format: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)


class MisdeclaredOption(ConfigException):
    """
    Raised when a option is misdeclared of a section from the configuration file.

    """

    def __init__(self, option, details="Wrong syntax"):
        self.msg = "Misdiclared option. {}".format(details)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class InvalidMapHeader(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, pattern, header):
        self.msg = "Invalid map header"
        self.msg += "\n<header: '{}'>".format(header)
        self.msg += "\n<expected pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)


class InvalidMapEntry(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, record, header, option):
        self.msg = "Map entry not match header"
        self.msg += "\n<entry: '{}'>".format(record)
        self.msg += "\n<header: '{}'>".format(header)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class DuplicatedMapEntry(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, record, option):
        self.msg = "Duplicated entry"
        self.msg += "\n<entry: '{}'>".format(record)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)


class MissingPatternKey(ConfigException):
    """
    Raised when facet cannot be deduce to rebuild the submitted pattern.

    """

    def __init__(self, keys, pattern):
        self.msg = 'Missing facet key(s) for pattern resolution'
        self.msg += "\n<found keys: '{}'>".format(keys)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)


class ExpressionNotMatch(ConfigException):
    """
    Raised when a regular expression resolution failed.

    """

    def __init__(self, string, pattern):
        self.msg = "Pattern resolution failed"
        self.msg += "\n<value: '{}'>".format(string)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)


class InterpolationDepthError(ConfigException):
    """
    Raised when an string interpolation failed.

    """

    def __init__(self, pattern):
        self.msg = "String interpolation failed because of value interpolation too deeply recursive"
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)


class BadInterpolation(ConfigException):
    """
    Raised when an string interpolation failed.

    """

    def __init__(self, string, pattern):
        self.msg = "String interpolation failed because of bad value substitution"
        self.msg += "\n<value: '{}'>".format(string)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Classes

class BadInterpolation (string, pattern)

Raised when an string interpolation failed.

Expand source code

class BadInterpolation(ConfigException):
    """
    Raised when an string interpolation failed.

    """

    def __init__(self, string, pattern):
        self.msg = "String interpolation failed because of bad value substitution"
        self.msg += "\n<value: '{}'>".format(string)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class ConfigException (msg)

Basic exception for configuration parsing errors.

Expand source code

class ConfigException(Exception):
    """
    Basic exception for configuration parsing errors.

    """
    # Constants initialized with configuration instantiation
    # Configuration files to read
    FILE = None
    # Section to parse
    SECTION = None

    def __init__(self, msg):
        self.config_file = ConfigException.FILE
        self.section = ConfigException.SECTION
        self.msg = msg
        if self.section:
            self.msg += "\n<section: '{}'>".format(self.section)
        if self.config_file:
            self.msg += "\n<file: '{}'>".format(self.config_file)
        super(ConfigException, self).__init__(self.msg)

Ancestors

• builtins.Exception
• builtins.BaseException

Subclasses

• BadInterpolation
• DuplicatedMapEntry
• EmptyConfigFile
• ExpressionNotMatch
• InterpolationDepthError
• InvalidMapEntry
• InvalidMapHeader
• MisdeclaredOption
• MissingPatternKey
• NoConfigKey
• NoConfigOption
• NoConfigOptions
• NoConfigSection
• NoConfigValue
• NoConfigVariable

Class variables

var FILE

var SECTION

class DuplicatedMapEntry (record, option)

Raised when invalid map header.

Expand source code

class DuplicatedMapEntry(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, record, option):
        self.msg = "Duplicated entry"
        self.msg += "\n<entry: '{}'>".format(record)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class EmptyConfigFile

Raised when configuration file is empty.

Expand source code

class EmptyConfigFile(ConfigException):
    """
    Raised when configuration file is empty.

    """

    def __init__(self):
        self.msg = "Empty configuration file"
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class ExpressionNotMatch (string, pattern)

Raised when a regular expression resolution failed.

Expand source code

class ExpressionNotMatch(ConfigException):
    """
    Raised when a regular expression resolution failed.

    """

    def __init__(self, string, pattern):
        self.msg = "Pattern resolution failed"
        self.msg += "\n<value: '{}'>".format(string)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class InterpolationDepthError (pattern)

Raised when an string interpolation failed.

Expand source code

class InterpolationDepthError(ConfigException):
    """
    Raised when an string interpolation failed.

    """

    def __init__(self, pattern):
        self.msg = "String interpolation failed because of value interpolation too deeply recursive"
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class InvalidMapEntry (record, header, option)

Raised when invalid map header.

Expand source code

class InvalidMapEntry(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, record, header, option):
        self.msg = "Map entry not match header"
        self.msg += "\n<entry: '{}'>".format(record)
        self.msg += "\n<header: '{}'>".format(header)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class InvalidMapHeader (pattern, header)

Raised when invalid map header.

Expand source code

class InvalidMapHeader(ConfigException):
    """
    Raised when invalid map header.

    """

    def __init__(self, pattern, header):
        self.msg = "Invalid map header"
        self.msg += "\n<header: '{}'>".format(header)
        self.msg += "\n<expected pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class MisdeclaredOption (option, details='Wrong syntax')

Raised when a option is misdeclared of a section from the configuration file.

Expand source code

class MisdeclaredOption(ConfigException):
    """
    Raised when a option is misdeclared of a section from the configuration file.

    """

    def __init__(self, option, details="Wrong syntax"):
        self.msg = "Misdiclared option. {}".format(details)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class MissingPatternKey (keys, pattern)

Raised when facet cannot be deduce to rebuild the submitted pattern.

Expand source code

class MissingPatternKey(ConfigException):
    """
    Raised when facet cannot be deduce to rebuild the submitted pattern.

    """

    def __init__(self, keys, pattern):
        self.msg = 'Missing facet key(s) for pattern resolution'
        self.msg += "\n<found keys: '{}'>".format(keys)
        self.msg += "\n<pattern: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigFile (config_file)

Raised when no configuration file found.

Expand source code

class NoConfigFile(Exception):
    """
    Raised when no configuration file found.

    """

    def __init__(self, config_file):
        self.msg = "File not found"
        self.msg += "\n<file: '{}'>".format(config_file)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• builtins.Exception
• builtins.BaseException

class NoConfigKey (key, option)

Raised when no corresponding key found in option of a section from the configuration file.

Expand source code

class NoConfigKey(ConfigException):
    """
    Raised when no corresponding key found in option of a section from the configuration file.

    """

    def __init__(self, key, option):
        self.msg = "Key not found"
        self.msg += "\n<key: '{}'>".format(key)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigOption (option)

Raised when no corresponding option found in a section of the configuration file.

Expand source code

class NoConfigOption(ConfigException):
    """
    Raised when no corresponding option found in a section of the configuration file.

    """

    def __init__(self, option):
        self.msg = "Option not found"
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigOptions (option)

Raised when no corresponding options type found in a section of the configuration file.

Expand source code

class NoConfigOptions(ConfigException):
    """
    Raised when no corresponding options type found in a section of the configuration file.

    """

    def __init__(self, option):
        self.msg = "No options found"
        self.msg += "\n<options: '{}_{{options|map|pattern}}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigSection

Raised when no corresponding section found in configuration file.

Expand source code

class NoConfigSection(ConfigException):
    """
    Raised when no corresponding section found in configuration file.

    """

    def __init__(self):
        self.msg = "Section not found"
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigValue (value, option)

Raised when no corresponding value found in option of a section from the configuration file.

Expand source code

class NoConfigValue(ConfigException):
    """
    Raised when no corresponding value found in option of a section from the configuration file.

    """

    def __init__(self, value, option):
        self.msg = "Value not found".format(value)
        self.msg += "\n<value: '{}'>".format(value)
        self.msg += "\n<option: '{}'>".format(option)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException

class NoConfigVariable (option, pattern)

Raised when a %(facet)s pattern is missing into directory_format regex.

Expand source code

class NoConfigVariable(ConfigException):
    """
    Raised when a ``%(facet)s`` pattern is missing into ``directory_format`` regex.

    """

    def __init__(self, option, pattern):
        self.msg = "Pattern not found in regular expression (try to add a maptable)"
        self.msg += "\n<pattern: '%({})s'>".format(option)
        self.msg += "\n<format: '{}'>".format(pattern)
        super(self.__class__, self).__init__(self.msg)

Ancestors

• ConfigException
• builtins.Exception
• builtins.BaseException