( )⚙ D10124 typing: add type annotations to mercurial/i18n.py

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10124

typing: add type annotations to mercurial/i18n.py
ClosedPublic

Authored by mharbison72 on Mar 6 2021, 7:45 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGb9f40b743627: typing: add type annotations to mercurial/i18n.py
Summary

I'm a little unsure of this because gettext() clearly allows for passing
unicode. But the comments seem to indicate that this is related to tests, and
this was useful for catching unicode being passed to _() in the keyring
extension. I'm also not sure why _(None) would make any sense, so maybe the
argument shouldn't be optional? I didn't add it to the lambda in plain mode
because that spilled beyond 80 characters and so black mangled it.

Black and pytype disagree on where the comment to disable a check needs to go,
so this has to disable and then enable the checking.

Diff Detail

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

Event Timeline

mharbison72 created this revision.Mar 6 2021, 7:45 PM
mharbison72 added a commit: rHGb9f40b743627: typing: add type annotations to mercurial/i18n.py.Mar 8 2021, 3:25 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGb9f40b743627: typing: add type annotations to mercurial/i18n.py (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/i18n.py (18 lines)

Diff 26121

mercurial/i18n.py

from .pycompat import getattr from .pycompat import getattr
from .utils import resourceutil from .utils import resourceutil
from . import ( from . import (
encoding, encoding,
pycompat, pycompat,
) )
if pycompat.TYPE_CHECKING:
from typing import (
Callable,
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__)
_languages = None _languages = None
if ( if (
pycompat.iswindows pycompat.iswindows
and b'LANGUAGE' not in encoding.environ and b'LANGUAGE' not in encoding.environ
and b'LC_ALL' not in encoding.environ and b'LC_ALL' not in encoding.environ
and b'LC_MESSAGES' not in encoding.environ and b'LC_MESSAGES' not in encoding.environ
and b'LANG' not in encoding.environ and b'LANG' not in encoding.environ
): ):
# Try to detect UI language by "User Interface Language Management" API # Try to detect UI language by "User Interface Language Management" API
# if no locale variables are set. Note that locale.getdefaultlocale() # if no locale variables are set. Note that locale.getdefaultlocale()
# uses GetLocaleInfo(), which may be different from UI language. # uses GetLocaleInfo(), which may be different from UI language.
# (See http://msdn.microsoft.com/en-us/library/dd374098(v=VS.85).aspx ) # (See http://msdn.microsoft.com/en-us/library/dd374098(v=VS.85).aspx )
try: try:
import ctypes import ctypes
# pytype: disable=module-attr
langid = ctypes.windll.kernel32.GetUserDefaultUILanguage() langid = ctypes.windll.kernel32.GetUserDefaultUILanguage()
# pytype: enable=module-attr
_languages = [locale.windows_locale[langid]] _languages = [locale.windows_locale[langid]]
except (ImportError, AttributeError, KeyError): except (ImportError, AttributeError, KeyError):
# ctypes not found or unknown langid # ctypes not found or unknown langid
pass pass
datapath = pycompat.fsdecode(resourceutil.datapath) datapath = pycompat.fsdecode(resourceutil.datapath)
localedir = os.path.join(datapath, 'locale') localedir = os.path.join(datapath, 'locale')
t = gettextmod.translation('hg', localedir, _languages, fallback=True) t = gettextmod.translation('hg', localedir, _languages, fallback=True)
try: try:
_ugettext = t.ugettext _ugettext = t.ugettext # pytype: disable=attribute-error
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]
"""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'.
""" """
# If message is None, t.ugettext will return u'None' as the # If message is None, t.ugettext will return u'None' as the
# translation whereas our callers expect us to return None. # translation whereas our callers expect us to return None.
if message is None or not _ugettext: if message is None or not _ugettext:
return message return message
cache = _msgcache.setdefault(encoding.encoding, {}) cache = _msgcache.setdefault(encoding.encoding, {})
if message not in cache: if message not in cache:
if type(message) is pycompat.unicode: if type(message) is pycompat.unicode:
# goofy unicode docstrings in test # goofy unicode docstrings in test
paragraphs = message.split(u'\n\n') paragraphs = message.split(u'\n\n') # type: List[pycompat.unicode]
else: else:
# should be ascii, but we have unicode docstrings in test, which # should be ascii, but we have unicode docstrings in test, which
# are converted to utf-8 bytes on Python 3. # are converted to utf-8 bytes on Python 3.
paragraphs = [p.decode("utf-8") for p in message.split(b'\n\n')] paragraphs = [p.decode("utf-8") for p in message.split(b'\n\n')]
# Be careful not to translate the empty string -- it holds the # Be careful not to translate the empty string -- it holds the
# meta data of the .po file. # meta data of the .po file.
u = u'\n\n'.join([p and _ugettext(p) or u'' for p in paragraphs]) u = u'\n\n'.join([p and _ugettext(p) or u'' for p in paragraphs])
try: try:
and b'HGPLAINEXCEPT' not in encoding.environ and b'HGPLAINEXCEPT' not in encoding.environ
): ):
return False return False
exceptions = encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',') exceptions = encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',')
return b'i18n' not in exceptions return b'i18n' not in exceptions
if _plain(): if _plain():
_ = lambda message: message _ = lambda message: message # type: Callable[[bytes], bytes]
else: else:
_ = gettext _ = gettext