comparison mercurial/error.py @ 47289:33c0c25d0b0f

errors: let each Abort subclass define its error code

It's more flexible to have the error codes defined on the error types
themselves. That way extensions can easily set their own exit code. It
also means that we can reduce a bit of duplication betwen
`scmutil.callcatch()` and `chgserver.chgcmdserver.validate()`.

Differential Revision: https://phab.mercurial-scm.org/D10735

47288:16b48ebf656e

class Abort(Hint, Exception):
    """Raised if a command needs to print an error and exit."""

    def __init__(self, message, hint=None):
        # type: (bytes, Optional[bytes]) -> None
        self.message = message
        self.hint = hint
        # Pass the message into the Exception constructor to help extensions
        # that look for exc.args[0].
        Exception.__init__(self, message)

    def __bytes__(self):

    """Indicates that the user made an error in their input.

    Examples: Invalid command, invalid flags, invalid revision.
    """


class StateError(Abort):
    """Indicates that the operation might work if retried in a different state.

    Examples: Unresolved merge conflicts, unfinished operations.
    """


class CanceledError(Abort):
    """Indicates that the user canceled the operation.

    Examples: Close commit editor with error status, quit chistedit.
    """


class SecurityError(Abort):
    """Indicates that some aspect of security failed.

    Examples: Bad server credentials, expired local credentials for network
    filesystem, mismatched GPG signature, DoS protection.
    """


class HookLoadError(Abort):
    """raised when loading a hook fails, aborting an operation

    Exists to allow more specialized catching."""

class HookAbort(Abort):
    """raised when a validation hook fails, aborting an operation

    Exists to allow more specialized catching."""


class ConfigError(Abort):
    """Exception raised when parsing config files"""

    def __init__(self, message, location=None, hint=None):
        # type: (bytes, Optional[bytes], Optional[bytes]) -> None
        super(ConfigError, self).__init__(message, hint=hint)
        self.location = location

    def format(self):
        # type: () -> bytes
        from .i18n import _

class RemoteError(Abort):
    """Exception raised when interacting with a remote repo fails"""


class OutOfBandError(RemoteError):
    """Exception raised when a remote repo reports failure"""

    def __init__(self, message=None, hint=None):

class ParseError(Abort):
    """Raised when parsing config files and {rev,file}sets (msg[, pos])"""

    def __init__(self, message, location=None, hint=None):
        # type: (bytes, Optional[Union[bytes, int]], Optional[bytes]) -> None
        super(ParseError, self).__init__(message, hint=hint)
        self.location = location

    def format(self):
        # type: () -> bytes
        from .i18n import _

47289:33c0c25d0b0f

class Abort(Hint, Exception):
    """Raised if a command needs to print an error and exit."""

    def __init__(self, message, hint=None, detailed_exit_code=None):
        # type: (bytes, Optional[bytes]) -> None
        self.message = message
        self.hint = hint
        self.detailed_exit_code = detailed_exit_code
        # Pass the message into the Exception constructor to help extensions
        # that look for exc.args[0].
        Exception.__init__(self, message)

    def __bytes__(self):

    """Indicates that the user made an error in their input.

    Examples: Invalid command, invalid flags, invalid revision.
    """

    def __init__(self, message, hint=None):
        super(InputError, self).__init__(
            message, hint=hint, detailed_exit_code=10
        )


class StateError(Abort):
    """Indicates that the operation might work if retried in a different state.

    Examples: Unresolved merge conflicts, unfinished operations.
    """

    def __init__(self, message, hint=None):
        super(StateError, self).__init__(
            message, hint=hint, detailed_exit_code=20
        )


class CanceledError(Abort):
    """Indicates that the user canceled the operation.

    Examples: Close commit editor with error status, quit chistedit.
    """

    def __init__(self, message, hint=None):
        super(CanceledError, self).__init__(
            message, hint=hint, detailed_exit_code=250
        )


class SecurityError(Abort):
    """Indicates that some aspect of security failed.

    Examples: Bad server credentials, expired local credentials for network
    filesystem, mismatched GPG signature, DoS protection.
    """

    def __init__(self, message, hint=None):
        super(SecurityError, self).__init__(
            message, hint=hint, detailed_exit_code=150
        )


class HookLoadError(Abort):
    """raised when loading a hook fails, aborting an operation

    Exists to allow more specialized catching."""

class HookAbort(Abort):
    """raised when a validation hook fails, aborting an operation

    Exists to allow more specialized catching."""

    def __init__(self, message, hint=None):
        super(HookAbort, self).__init__(
            message, hint=hint, detailed_exit_code=40
        )


class ConfigError(Abort):
    """Exception raised when parsing config files"""

    def __init__(self, message, location=None, hint=None):
        # type: (bytes, Optional[bytes], Optional[bytes]) -> None
        super(ConfigError, self).__init__(
            message, hint=hint, detailed_exit_code=30
        )
        self.location = location

    def format(self):
        # type: () -> bytes
        from .i18n import _

class RemoteError(Abort):
    """Exception raised when interacting with a remote repo fails"""

    def __init__(self, message, hint=None):
        super(RemoteError, self).__init__(
            message, hint=hint, detailed_exit_code=100
        )


class OutOfBandError(RemoteError):
    """Exception raised when a remote repo reports failure"""

    def __init__(self, message=None, hint=None):

class ParseError(Abort):
    """Raised when parsing config files and {rev,file}sets (msg[, pos])"""

    def __init__(self, message, location=None, hint=None):
        # type: (bytes, Optional[Union[bytes, int]], Optional[bytes]) -> None
        super(ParseError, self).__init__(
            message, hint=hint, detailed_exit_code=10
        )
        self.location = location

    def format(self):
        # type: () -> bytes
        from .i18n import _