( )⚙ D11719 typing: add more type hints to the errors module

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11719

typing: add more type hints to the errors module
ClosedPublic

Authored by mharbison72 on Oct 23 2021, 6:41 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG9de0823705b4: typing: add more type hints to the errors module
Summary

These were found by looking for Any types in the generated *.pyi file after
running the tests. There are some more complicated types that I'm not sure of,
and am leaving untyped. I also can't figure out how to get self.hint to be
anything other than Any in most classes.

Diff Detail

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

Event Timeline

mharbison72 created this revision.Oct 23 2021, 6:41 PM
Alphare accepted this revision.Oct 26 2021, 4:37 AM
This revision is now accepted and ready to land.Oct 26 2021, 4:37 AM
mharbison72 added a commit: rHG9de0823705b4: typing: add more type hints to the errors module.Oct 26 2021, 5:02 AM
Closed by commit rHG9de0823705b4: typing: add more type hints to the errors module (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/error.py (7 lines)

Diff 30980

mercurial/error.py

List, List,
Optional, Optional,
Sequence, Sequence,
Union, Union,
) )
def _tobytes(exc): def _tobytes(exc):
# type: (...) -> bytes
"""Byte-stringify exception in the same way as BaseException_str()""" """Byte-stringify exception in the same way as BaseException_str()"""
if not exc.args: if not exc.args:
return b'' return b''
if len(exc.args) == 1: if len(exc.args) == 1:
return pycompat.bytestr(exc.args[0]) return pycompat.bytestr(exc.args[0])
return b'(%s)' % b', '.join(b"'%s'" % pycompat.bytestr(a) for a in exc.args) return b'(%s)' % b', '.join(b"'%s'" % pycompat.bytestr(a) for a in exc.args)
class Hint(object): class Hint(object):
"""Mix-in to provide a hint of an error """Mix-in to provide a hint of an error
This should come first in the inheritance list to consume a hint and This should come first in the inheritance list to consume a hint and
pass remaining arguments to the exception class. pass remaining arguments to the exception class.
""" """
def __init__(self, *args, **kw): def __init__(self, *args, **kw):
self.hint = kw.pop('hint', None) self.hint = kw.pop('hint', None) # type: Optional[bytes]
super(Hint, self).__init__(*args, **kw) super(Hint, self).__init__(*args, **kw)
class Error(Hint, Exception): class Error(Hint, Exception):
"""Base class for Mercurial errors.""" """Base class for Mercurial errors."""
coarse_exit_code = None coarse_exit_code = None
detailed_exit_code = None detailed_exit_code = None
def __init__(self, message, hint=None): def __init__(self, message, hint=None):
# type: (bytes, Optional[bytes]) -> None # type: (bytes, Optional[bytes]) -> None
self.message = message self.message = message
self.hint = hint self.hint = hint
# 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:
def __str__(self): def __str__(self):
# type: () -> str
# the output would be unreadable if the message was translated, # the output would be unreadable if the message was translated,
# but do not replace it with encoding.strfromlocal(), which # but do not replace it with encoding.strfromlocal(), which
# may raise another exception. # may raise another exception.
return pycompat.sysstr(self.__bytes__()) return pycompat.sysstr(self.__bytes__())
def format(self): def format(self):
# type: () -> bytes # type: () -> bytes
from .i18n import _ from .i18n import _
class RevlogError(StorageError): class RevlogError(StorageError):
pass pass
class SidedataHashError(RevlogError): class SidedataHashError(RevlogError):
def __init__(self, key, expected, got): def __init__(self, key, expected, got):
# type: (int, bytes, bytes) -> None
self.hint = None self.hint = None
self.sidedatakey = key self.sidedatakey = key
self.expecteddigest = expected self.expecteddigest = expected
self.actualdigest = got self.actualdigest = got
class FilteredIndexError(IndexError): class FilteredIndexError(IndexError):
__bytes__ = _tobytes __bytes__ = _tobytes
class LookupError(RevlogError, KeyError): class LookupError(RevlogError, KeyError):
def __init__(self, name, index, message): def __init__(self, name, index, message):
# type: (bytes, bytes, bytes) -> None
self.name = name self.name = name
self.index = index self.index = index
# this can't be called 'message' because at least some installs of # this can't be called 'message' because at least some installs of
# Python 2.6+ complain about the 'message' property being deprecated # Python 2.6+ complain about the 'message' property being deprecated
self.lookupmessage = message self.lookupmessage = message
if isinstance(name, bytes) and len(name) == 20: if isinstance(name, bytes) and len(name) == 20:
from .node import hex from .node import hex
detailed_exit_code = 100 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):
# type: (Optional[bytes], Optional[bytes]) -> 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)