Source code for cup.err

#!/usr/bin/python
# -*- coding: utf-8 -*
# Copyright: [CUP] - See LICENSE for details.
# Authors: Guannan Ma (@mythmgn),
"""
:description:
    error related module
"""
# pylint: disable=consider-using-f-string

__all__ = [
    'BaseCupException', 'DecoratorException', 'LoggerException',
    'ResException', 'NoSuchProcess', 'AccessDenied', 'NetException',
    'AsyncMsgError', 'ThreadTermException', 'LockFileError',
    'NotImplementedYet', 'ConfigError', 'NotSupportedError'
]


class BaseCupException(Exception):
    """
    base cup Exception. All other cup Exceptions will inherit this.
    """
    def __init__(self, msg):
        self._msg = 'Cup module Exception:' + str(msg)

    def __str__(self):
        return repr(self._msg)


class ConfigError(BaseCupException):
    """
    ConfigError
    """
    def __init__(self, msg=''):
        msg = 'Configuration Error: {0}'.format(msg)
        BaseCupException.__init__(self, msg)


# ## Decorator Exceptions ####
class DecoratorException(BaseCupException):
    """
    DecoratorException
    """
    def __init__(self, msg):
        msg = 'Decoration Error:{}'.format(msg)
        BaseCupException.__init__(self, msg)


class ExpectFailure(BaseCupException):
    """
    Expect failure for cup.unittest
    """
    def __init__(self, expect, got):
        msg = 'expect failure, expect {0}, got {1}'.format(expect, got)
        BaseCupException.__init__(self, msg)


# ## Log related exceptions ####
class LoggerException(BaseCupException):
    """
    Exception for logging, especially for cup.log
    """
    def __init__(self, msg):
        msg = 'LoggerException Error: {0}'.format(msg)
        BaseCupException.__init__(self, msg)


# ## Resouce related exceptions ####
class ResException(BaseCupException):
    """
    Resource releated Exception
    """
    def __init__(self, msg):
        BaseCupException.__init__(self, msg)


class AccessDenied(ResException):
    """
    Access Denied
    """
    def __init__(self, str_resouce):
        ResException.__init__(
            self, 'access denied: {}'.format(str_resouce)
        )


class NoSuchProcess(ResException):
    """
    No such Process Exception
    """
    def __init__(self, pid, str_process_name):
        ResException.__init__(
            self, 'pid %d, proc_name:%s' % (pid, str_process_name)
        )


class NotSupportedError(BaseCupException):
    """
    NotSupportedError (feature/functionality not implemented by code yet)
    """
    def __init__(self, msg=''):
        msg = 'NotSupportedError: {0}'.format(msg)
        BaseCupException.__init__(self, msg)


# ## Net related exceptions ####
class NetException(BaseCupException):
    """
    Network releated Exception
    """
    def __init__(self, msg=''):
        BaseCupException.__init__(self, msg)


class AsyncMsgError(NetException):
    """
    cup.net.async msg related Exception
    """
    def __init__(self, msg=''):
        NetException.__init__(self, msg)


# ## Shell related exceptions ####
class ShellException(BaseCupException):
    """
    Exception for cup.shell
    """
    def __init__(self, msg=''):
        BaseCupException.__init__(self, msg)


class IOException(BaseCupException):
    """
    IO related exceptions inside cup
    """
    def __init__(self, msg=''):
        BaseCupException.__init__(self, msg)


class NoSuchFileOrDir(IOException):
    """
    No such file or directory
    """
    def __init__(self, msg=''):
        IOException.__init__(self, msg)


class ThreadTermException(BaseCupException):
    """
        Thread termination error
    """
    def __init__(self, msg=''):
        BaseCupException.__init__(self, msg)


class NotInitialized(BaseCupException):
    """
    Not initialized yet
    """
    def __init__(self, msg=''):
        msg = 'Not initialized: %s' % msg
        BaseCupException.__init__(self, msg)


class LockFileError(BaseCupException):
    """
    LockFileError
    """
    def __init__(self, msg=''):
        msg = 'LockFileError: %s' % msg
        BaseCupException.__init__(self, msg)


class NotImplementedYet(BaseCupException):
    """
    Not implemented yet
    """
    def __init__(self, msg=''):
        msg = 'The functionality is not implemented yet, {0}'.format(msg)
        BaseCupException.__init__(self, msg)


# vi:set tw=0 ts=4 sw=4 nowrap fdm=indent