Mercurial > hg
view i18n/check-translation.py @ 36367:043e77f3be09
sshpeer: return framed file object when needed
Currently, wireproto.wirepeer has a default implementation of
_submitbatch() and sshv1peer has a very similar implementation.
The main difference is that sshv1peer is aware of the total amount
of bytes it can read whereas the default implementation reads the
stream until no more data is returned. The default implementation
works for HTTP, since there is a known end to HTTP responses (either
Content-Length or 0 sized chunk).
This commit teaches sshv1peer to use our just-introduced "cappedreader"
class for wrapping a file object to limit the number of bytes that
can be read. We do this by introducing an argument to specify whether
the response is framed. If set, we returned a cappedreader instance
instead of the raw pipe.
_call() always has framed responses. So we set this argument
unconditionally and then .read() the entirety of the result.
Strictly speaking, we don't need to use cappedreader in this case
and can inline frame decoding/read logic. But I like when things
are consistent. The overhead should be negligible.
_callstream() and _callcompressable() are special: whether framing
is used depends on the specific command. So, we define a set
of commands that have framed response. It currently only
contains "batch."
As a result of this change, the one-off implementation of
_submitbatch() in sshv1peer can be removed since it is now
safe to .read() the response's file object until end of stream.
cappedreader takes care of not overrunning the frame.
Differential Revision: https://phab.mercurial-scm.org/D2380
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Wed, 21 Feb 2018 08:35:48 -0800 |
parents | 078099304772 |
children | 19fc5a986669 |
line wrap: on
line source
#!/usr/bin/env python # # check-translation.py - check Mercurial specific translation problems from __future__ import absolute_import import re import polib scanners = [] checkers = [] def scanner(): def decorator(func): scanners.append(func) return func return decorator def levelchecker(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 levelchecker('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" deprecatedpe = None @scanner() def deprecatedsetup(pofile): pes = [p for p in pofile if p.msgid == '(DEPRECATED)' and p.msgstr] if len(pes): global deprecatedpe deprecatedpe = pes[0] @fatalchecker(r'\(DEPRECATED\)') def deprecated(pe): """Check for DEPRECATED >>> ped = polib.POEntry( ... msgid = '(DEPRECATED)', ... msgstr= '(DETACERPED)') >>> deprecatedsetup([ped]) >>> pe = polib.POEntry( ... msgid = 'Something (DEPRECATED)', ... msgstr= 'something (DEPRECATED)') >>> match(deprecated, pe) True >>> for e in deprecated(pe): print(e) >>> pe = polib.POEntry( ... msgid = 'Something (DEPRECATED)', ... msgstr= 'something (DETACERPED)') >>> match(deprecated, pe) True >>> for e in deprecated(pe): print(e) >>> pe = polib.POEntry( ... msgid = 'Something (DEPRECATED)', ... msgstr= 'something') >>> match(deprecated, pe) True >>> for e in deprecated(pe): print(e) msgstr inconsistently translated (DEPRECATED) >>> pe = polib.POEntry( ... msgid = 'Something (DEPRECATED, foo bar)', ... msgstr= 'something (DETACERPED, foo bar)') >>> match(deprecated, pe) """ if not ('(DEPRECATED)' in pe.msgstr or (deprecatedpe and deprecatedpe.msgstr in pe.msgstr)): yield "msgstr inconsistently translated (DEPRECATED)" #################### def warningchecker(msgidpat=None): return levelchecker('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 checker in scanners: checker(pofile) 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)