Mercurial > hg
view i18n/check-translation.py @ 20742:3681de20b0a7
parsers: fail fast if Python has wrong minor version (issue4110)
This change causes an informative ImportError to be raised when importing
the parsers extension module if the minor version of the currently-running
Python interpreter doesn't match that of the Python used when compiling
the extension module.
This change also exposes a parsers.versionerrortext constant in the
C implementation of the module. Its presence can be used to determine
whether this behavior is present in a version of the module. The value
of the constant is the leading text of the ImportError raised and is set
to "Python minor version mismatch".
Here is an example of what the new error looks like:
Traceback (most recent call last):
File "test.py", line 1, in <module>
import mercurial.parsers
ImportError: Python minor version mismatch: The Mercurial extension
modules were compiled with Python 2.7.6, but Mercurial is currently using
Python with sys.hexversion=33883888: Python 2.5.6
(r256:88840, Nov 18 2012, 05:37:10)
[GCC 4.2.1 Compatible Apple Clang 4.1 ((tags/Apple/clang-421.11.66))]
at: /opt/local/Library/Frameworks/Python.framework/Versions/2.5/Resources/
Python.app/Contents/MacOS/Python
The reason for raising an error in this scenario is that Python's C API
is known not to be compatible from minor version to minor version, even
if sys.api_version is the same. See for example this Python bug report
about incompatibilities between 2.5 and 2.6+:
http://bugs.python.org/issue8118
These incompatibilities can cause Mercurial to break in mysterious,
unforeseen ways. For example, when Mercurial compiled with Python 2.7 was
run with 2.5, the following crash occurred when running "hg status":
http://bz.selenic.com/show_bug.cgi?id=4110
After this crash was fixed, running with Python 2.5 no longer crashes, but
the following puzzling behavior still occurs:
$ hg status
...
File ".../mercurial/changelog.py", line 123, in __init__
revlog.revlog.__init__(self, opener, "00changelog.i")
File ".../mercurial/revlog.py", line 251, in __init__
d = self._io.parseindex(i, self._inline)
File ".../mercurial/revlog.py", line 158, in parseindex
index, cache = parsers.parse_index2(data, inline)
TypeError: data is not a string
which can be reproduced more simply with:
import mercurial.parsers as parsers
parsers.parse_index2("", True)
Both the crash and the TypeError occurred because the Python C API's
PyString_Check() returns the wrong value when the C header files from
Python 2.7 are run with Python 2.5. This is an example of an
incompatibility of the sort mentioned in the Python bug report above.
Failing fast with an informative error message results in a better user
experience in cases like the above. The information in the ImportError
also simplifies troubleshooting for those on Mercurial mailing lists, the
bug tracker, etc.
This patch only adds the version check to parsers.c, which is sufficient
to affect command-line commands like "hg status" and "hg summary".
An idea for a future improvement is to move the version-checking C code
to a more central location, and have it run when importing all
Mercurial extension modules and not just parsers.c.
author | Chris Jerdonek <chris.jerdonek@gmail.com> |
---|---|
date | Wed, 04 Dec 2013 20:38:27 -0800 |
parents | 6afbfb9b1af1 |
children | 35c2ea4ca26f |
line wrap: on
line source
#!/usr/bin/env python # # check-translation.py - check Mercurial specific translation problems import polib import re checkers = [] def checker(level, msgidpat): def decorator(func): if msgidpat: match = re.compile(msgidpat).search else: match = lambda msgid: True checkers.append((func, level)) func.match = match return func return decorator def match(checker, pe): """Examine whether POEntry "pe" is target of specified checker or not """ if not checker.match(pe.msgid): return # examine suppression by translator comment nochecker = 'no-%s-check' % checker.__name__ for tc in pe.tcomment.split(): if nochecker == tc: return return True #################### def fatalchecker(msgidpat=None): return checker('fatal', msgidpat) @fatalchecker(r'\$\$') def promptchoice(pe): """Check translation of the string given to "ui.promptchoice()" >>> pe = polib.POEntry( ... msgid ='prompt$$missing &sep$$missing &$$followed by &none', ... msgstr='prompt missing &sep$$missing amp$$followed by none&') >>> match(promptchoice, pe) True >>> for e in promptchoice(pe): print e number of choices differs between msgid and msgstr msgstr has invalid choice missing '&' msgstr has invalid '&' followed by none """ idchoices = [c.rstrip(' ') for c in pe.msgid.split('$$')[1:]] strchoices = [c.rstrip(' ') for c in pe.msgstr.split('$$')[1:]] if len(idchoices) != len(strchoices): yield "number of choices differs between msgid and msgstr" indices = [(c, c.find('&')) for c in strchoices] if [c for c, i in indices if i == -1]: yield "msgstr has invalid choice missing '&'" if [c for c, i in indices if len(c) == i + 1]: yield "msgstr has invalid '&' followed by none" #################### def warningchecker(msgidpat=None): return checker('warning', msgidpat) @warningchecker() def taildoublecolons(pe): """Check equality of tail '::'-ness between msgid and msgstr >>> pe = polib.POEntry( ... msgid ='ends with ::', ... msgstr='ends with ::') >>> for e in taildoublecolons(pe): print e >>> pe = polib.POEntry( ... msgid ='ends with ::', ... msgstr='ends without double-colons') >>> for e in taildoublecolons(pe): print e tail '::'-ness differs between msgid and msgstr >>> pe = polib.POEntry( ... msgid ='ends without double-colons', ... msgstr='ends with ::') >>> for e in taildoublecolons(pe): print e tail '::'-ness differs between msgid and msgstr """ if pe.msgid.endswith('::') != pe.msgstr.endswith('::'): yield "tail '::'-ness differs between msgid and msgstr" @warningchecker() def indentation(pe): """Check equality of initial indentation between msgid and msgstr This may report unexpected warning, because this doesn't aware the syntax of rst document and the context of msgstr. >>> pe = polib.POEntry( ... msgid =' indented text', ... msgstr=' narrowed indentation') >>> for e in indentation(pe): print e initial indentation width differs betweeen msgid and msgstr """ idindent = len(pe.msgid) - len(pe.msgid.lstrip()) strindent = len(pe.msgstr) - len(pe.msgstr.lstrip()) if idindent != strindent: yield "initial indentation width differs betweeen msgid and msgstr" #################### def check(pofile, fatal=True, warning=False): targetlevel = { 'fatal': fatal, 'warning': warning } targetcheckers = [(checker, level) for checker, level in checkers if targetlevel[level]] if not targetcheckers: return [] detected = [] for pe in pofile.translated_entries(): errors = [] for checker, level in targetcheckers: if match(checker, pe): errors.extend((level, checker.__name__, error) for error in checker(pe)) if errors: detected.append((pe, errors)) return detected ######################################## if __name__ == "__main__": import sys import optparse optparser = optparse.OptionParser("""%prog [options] pofile ... This checks Mercurial specific translation problems in specified '*.po' files. Each detected problems are shown in the format below:: filename:linenum:type(checker): problem detail ..... "type" is "fatal" or "warning". "checker" is the name of the function detecting corresponded error. Checking by checker "foo" on the specific msgstr can be suppressed by the "translator comment" like below. Multiple "no-xxxx-check" should be separated by whitespaces:: # no-foo-check msgid = "....." msgstr = "....." """) optparser.add_option("", "--warning", help="show also warning level problems", action="store_true") optparser.add_option("", "--doctest", help="run doctest of this tool, instead of check", action="store_true") (options, args) = optparser.parse_args() if options.doctest: import os if 'TERM' in os.environ: del os.environ['TERM'] import doctest failures, tests = doctest.testmod() sys.exit(failures and 1 or 0) # replace polib._POFileParser to show linenum of problematic msgstr class ExtPOFileParser(polib._POFileParser): def process(self, symbol, linenum): super(ExtPOFileParser, self).process(symbol, linenum) if symbol == 'MS': # msgstr self.current_entry.linenum = linenum polib._POFileParser = ExtPOFileParser detected = [] warning = options.warning for f in args: detected.extend((f, pe, errors) for pe, errors in check(polib.pofile(f), warning=warning)) if detected: for f, pe, errors in detected: for level, checker, error in errors: sys.stderr.write('%s:%d:%s(%s): %s\n' % (f, pe.linenum, level, checker, error)) sys.exit(1)