( )⚙ D10735 errors: let each Abort subclass define its error code

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10735

errors: let each Abort subclass define its error code
ClosedPublic

Authored by martinvonz on May 18 2021, 8:30 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG33c0c25d0b0f: errors: let each Abort subclass define its error code
Summary

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().

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

PathPackages
Mmercurial/chgserver.py (6 lines)
Mmercurial/error.py (41 lines)
Mmercurial/scmutil.py (16 lines)

Diff 28083

mercurial/chgserver.py

except error.RepoError as inst: except error.RepoError as inst:
# RepoError can be raised while trying to read shared source # RepoError can be raised while trying to read shared source
# configuration # configuration
self.ui.error(_(b"abort: %s\n") % stringutil.forcebytestr(inst)) self.ui.error(_(b"abort: %s\n") % stringutil.forcebytestr(inst))
if inst.hint: if inst.hint:
self.ui.error(_(b"(%s)\n") % inst.hint) self.ui.error(_(b"(%s)\n") % inst.hint)
errorraised = True errorraised = True
except error.Abort as inst: except error.Abort as inst:
if isinstance(inst, error.InputError): if inst.detailed_exit_code is not None:
detailed_exit_code = 10 detailed_exit_code = inst.detailed_exit_code
elif isinstance(inst, error.ConfigError):
detailed_exit_code = 30
self.ui.error(inst.format()) self.ui.error(inst.format())
errorraised = True errorraised = True
if errorraised: if errorraised:
self.ui.flush() self.ui.flush()
exit_code = 255 exit_code = 255
if self.ui.configbool(b'ui', b'detailed-exit-code'): if self.ui.configbool(b'ui', b'detailed-exit-code'):
exit_code = detailed_exit_code exit_code = detailed_exit_code

mercurial/error.py

) )
% opname, % opname,
) )
class Abort(Hint, Exception): class Abort(Hint, Exception):
"""Raised if a command needs to print an error and exit.""" """Raised if a command needs to print an error and exit."""
def __init__(self, message, hint=None): def __init__(self, message, hint=None, detailed_exit_code=None):
# type: (bytes, Optional[bytes]) -> None # type: (bytes, Optional[bytes]) -> None
self.message = message self.message = message
self.hint = hint self.hint = hint
self.detailed_exit_code = detailed_exit_code
# Pass the message into the Exception constructor to help extensions # Pass the message into the Exception constructor to help extensions
# that look for exc.args[0]. # that look for exc.args[0].
Exception.__init__(self, message) Exception.__init__(self, message)
def __bytes__(self): def __bytes__(self):
return self.message return self.message
if pycompat.ispy3: if pycompat.ispy3:
class InputError(Abort): class InputError(Abort):
"""Indicates that the user made an error in their input. """Indicates that the user made an error in their input.
Examples: Invalid command, invalid flags, invalid revision. 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): class StateError(Abort):
"""Indicates that the operation might work if retried in a different state. """Indicates that the operation might work if retried in a different state.
Examples: Unresolved merge conflicts, unfinished operations. 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): class CanceledError(Abort):
"""Indicates that the user canceled the operation. """Indicates that the user canceled the operation.
Examples: Close commit editor with error status, quit chistedit. 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): class SecurityError(Abort):
"""Indicates that some aspect of security failed. """Indicates that some aspect of security failed.
Examples: Bad server credentials, expired local credentials for network Examples: Bad server credentials, expired local credentials for network
filesystem, mismatched GPG signature, DoS protection. 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): class HookLoadError(Abort):
"""raised when loading a hook fails, aborting an operation """raised when loading a hook fails, aborting an operation
Exists to allow more specialized catching.""" Exists to allow more specialized catching."""
class HookAbort(Abort): class HookAbort(Abort):
"""raised when a validation hook fails, aborting an operation """raised when a validation hook fails, aborting an operation
Exists to allow more specialized catching.""" 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): class ConfigError(Abort):
"""Exception raised when parsing config files""" """Exception raised when parsing config files"""
def __init__(self, message, location=None, hint=None): def __init__(self, message, location=None, hint=None):
# type: (bytes, Optional[bytes], Optional[bytes]) -> None # type: (bytes, Optional[bytes], Optional[bytes]) -> None
super(ConfigError, self).__init__(message, hint=hint) super(ConfigError, self).__init__(
message, hint=hint, detailed_exit_code=30
)
self.location = location self.location = location
def format(self): def format(self):
# type: () -> bytes # type: () -> bytes
from .i18n import _ from .i18n import _
if self.location is not None: if self.location is not None:
message = _(b"config error at %s: %s\n") % ( message = _(b"config error at %s: %s\n") % (
from .i18n import _ from .i18n import _
Abort.__init__(self, _(b'response expected')) Abort.__init__(self, _(b'response expected'))
class RemoteError(Abort): class RemoteError(Abort):
"""Exception raised when interacting with a remote repo fails""" """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): class OutOfBandError(RemoteError):
"""Exception raised when a remote repo reports failure""" """Exception raised when a remote repo reports failure"""
def __init__(self, message=None, hint=None): def __init__(self, message=None, hint=None):
from .i18n import _ from .i18n import _
if message: if message:
# Abort.format() adds a trailing newline # Abort.format() adds a trailing newline
message = _(b"remote error:\n%s") % message.rstrip(b'\n') message = _(b"remote error:\n%s") % message.rstrip(b'\n')
else: else:
message = _(b"remote error") message = _(b"remote error")
super(OutOfBandError, self).__init__(message, hint=hint) super(OutOfBandError, self).__init__(message, hint=hint)
class ParseError(Abort): class ParseError(Abort):
"""Raised when parsing config files and {rev,file}sets (msg[, pos])""" """Raised when parsing config files and {rev,file}sets (msg[, pos])"""
def __init__(self, message, location=None, hint=None): def __init__(self, message, location=None, hint=None):
# type: (bytes, Optional[Union[bytes, int]], Optional[bytes]) -> None # type: (bytes, Optional[Union[bytes, int]], Optional[bytes]) -> None
super(ParseError, self).__init__(message, hint=hint) super(ParseError, self).__init__(
message, hint=hint, detailed_exit_code=10
)
self.location = location self.location = location
def format(self): def format(self):
# type: () -> bytes # type: () -> bytes
from .i18n import _ from .i18n import _
if self.location is not None: if self.location is not None:
message = _(b"hg: parse error at %s: %s\n") % ( message = _(b"hg: parse error at %s: %s\n") % (

mercurial/scmutil.py

ui.error(b"%s\n" % inst) ui.error(b"%s\n" % inst)
if inst.hint: if inst.hint:
ui.error(_(b"(%s)\n") % inst.hint) ui.error(_(b"(%s)\n") % inst.hint)
detailed_exit_code = 240 detailed_exit_code = 240
coarse_exit_code = 1 coarse_exit_code = 1
except error.WdirUnsupported: except error.WdirUnsupported:
ui.error(_(b"abort: working directory revision cannot be specified\n")) ui.error(_(b"abort: working directory revision cannot be specified\n"))
except error.Abort as inst: except error.Abort as inst:
if isinstance(inst, (error.InputError, error.ParseError)): if inst.detailed_exit_code is not None:
detailed_exit_code = 10 detailed_exit_code = inst.detailed_exit_code
elif isinstance(inst, error.StateError):
detailed_exit_code = 20
elif isinstance(inst, error.ConfigError):
detailed_exit_code = 30
elif isinstance(inst, error.HookAbort):
detailed_exit_code = 40
elif isinstance(inst, error.RemoteError):
detailed_exit_code = 100
elif isinstance(inst, error.SecurityError):
detailed_exit_code = 150
elif isinstance(inst, error.CanceledError):
detailed_exit_code = 250
ui.error(inst.format()) ui.error(inst.format())
except error.WorkerError as inst: except error.WorkerError as inst:
# Don't print a message -- the worker already should have # Don't print a message -- the worker already should have
return inst.status_code return inst.status_code
except ImportError as inst: except ImportError as inst:
ui.error(_(b"abort: %s\n") % stringutil.forcebytestr(inst)) ui.error(_(b"abort: %s\n") % stringutil.forcebytestr(inst))
m = stringutil.forcebytestr(inst).split()[-1] m = stringutil.forcebytestr(inst).split()[-1]
if m in b"mpatch bdiff".split(): if m in b"mpatch bdiff".split():