( )⚙ D10235 typing: mark the argument to mercurial.i18n.gettext() non-Optional

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10235

typing: mark the argument to mercurial.i18n.gettext() non-Optional
ClosedPublic

Authored by mharbison72 on Mar 19 2021, 1:58 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG2c0e35f6957a: typing: mark the argument to mercurial.i18n.gettext() non-Optional
Summary

Few if any of the callers are handling a None return, which is making pytype
complain. I tried adding @overload definitions to indicate the bytes -> bytes
and None -> None relationship, but pytype doesn't seem to apply that to _()
through the function assignment. What did work was to change _() into its own
function that called gettext(), but that has an extra function call overhead.
Even putting that function into an if pycompat.TYPE_CHECKING block and leaving
the existing assignments in the else block caused pytype to lose track of the
@overloads.

At that point, I simply gave up. PyCharm doesn't like that it can return None,
given the new type hints, but pytype doesn't complain about this nor does it
see any callers passing None. The most important thing here is to catch str
being passed anyway.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathPackages
Mmercurial/i18n.py (3 lines)

Diff 26541

mercurial/i18n.py

encoding, encoding,
pycompat, pycompat,
) )
if pycompat.TYPE_CHECKING: if pycompat.TYPE_CHECKING:
from typing import ( from typing import (
Callable, Callable,
List, List,
Optional,
) )
# modelled after templater.templatepath: # modelled after templater.templatepath:
if getattr(sys, 'frozen', None) is not None: if getattr(sys, 'frozen', None) is not None:
module = pycompat.sysexecutable module = pycompat.sysexecutable
else: else:
module = pycompat.fsencode(__file__) module = pycompat.fsencode(__file__)
except AttributeError: except AttributeError:
_ugettext = t.gettext _ugettext = t.gettext
_msgcache = {} # encoding: {message: translation} _msgcache = {} # encoding: {message: translation}
def gettext(message): def gettext(message):
# type: (Optional[bytes]) -> Optional[bytes] # type: (bytes) -> bytes
"""Translate message. """Translate message.
The message is looked up in the catalog to get a Unicode string, The message is looked up in the catalog to get a Unicode string,
which is encoded in the local encoding before being returned. which is encoded in the local encoding before being returned.
Important: message is restricted to characters in the encoding Important: message is restricted to characters in the encoding
given by sys.getdefaultencoding() which is most likely 'ascii'. given by sys.getdefaultencoding() which is most likely 'ascii'.
""" """