Mercurial > hg
view i18n/hggettext @ 34852:d45236f3d38e
log: add obsfate by default in changeset printer
Having an obsfate by default in log will be useful for users to understand why
they have obsolete and unstable changesets. Obsfate will only be shown for
obsolete changesets, which only happens if people opt-in to experimental feature.
But when obsolete changeset are visible, it is very useful to understand where
they are. Having it in log could be sufficient for most people, so they don't
have to learn a new command (like obslog which is itself useful in case of
divergences).
For example, when pulling and working directory parent become obsolete:
$ hg pull
...
working directory parent is obsolete! (f936c1697205)
This message comes from the Evolve extension.
Obsfate would comes handy:
$ hg log -G
o changeset: 2:6f91013c5136
| tag: tip
| parent: 0:4ef7b558f3ec
| user: Boris Feld <boris.feld@octobus.net>
| date: Mon Oct 09 16:00:27 2017 +0200
| summary: A
|
| @ changeset: 1:f936c1697205
|/ user: Boris Feld <boris.feld@octobus.net>
| date: Mon Oct 09 16:00:27 2017 +0200
| obsfate: rewritten using amend as 2:6f91013c5136
| summary: -A
|
o changeset: 0:feb4dd822b8c
user: Boris Feld <boris.feld@octobus.net>
date: Tue Oct 09 16:00:00 2017 +0200
summary: ROOT
And once we update, we don't have an obsolete changeset in the log anymore so
we don't show obsfate anymore, most users won't see obsfate often if they
don't have obsolete changeset often:
@ changeset: 2:6f91013c5136
| tag: tip
| parent: 0:4ef7b558f3ec
| user: Boris Feld <boris.feld@octobus.net>
| date: Mon Oct 09 16:00:27 2017 +0200
| summary: A
|
o changeset: 0:feb4dd822b8c
user: Boris Feld <boris.feld@octobus.net>
date: Tue Oct 09 16:00:00 2017 +0200
summary: ROOT
author | Boris Feld <boris.feld@octobus.net> |
---|---|
date | Thu, 05 Oct 2017 15:25:18 +0200 |
parents | d5ef17608159 |
children | 0585337ea787 |
line wrap: on
line source
#!/usr/bin/env python # # hggettext - carefully extract docstrings for Mercurial # # Copyright 2009 Matt Mackall <mpm@selenic.com> and others # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. # The normalize function is taken from pygettext which is distributed # with Python under the Python License, which is GPL compatible. """Extract docstrings from Mercurial commands. Compared to pygettext, this script knows about the cmdtable and table dictionaries used by Mercurial, and will only extract docstrings from functions mentioned therein. Use xgettext like normal to extract strings marked as translatable and join the message cataloges to get the final catalog. """ from __future__ import absolute_import, print_function import inspect import os import re import sys def escape(s): # The order is important, the backslash must be escaped first # since the other replacements introduce new backslashes # themselves. s = s.replace('\\', '\\\\') s = s.replace('\n', '\\n') s = s.replace('\r', '\\r') s = s.replace('\t', '\\t') s = s.replace('"', '\\"') return s def normalize(s): # This converts the various Python string types into a format that # is appropriate for .po files, namely much closer to C style. lines = s.split('\n') if len(lines) == 1: s = '"' + escape(s) + '"' else: if not lines[-1]: del lines[-1] lines[-1] = lines[-1] + '\n' lines = map(escape, lines) lineterm = '\\n"\n"' s = '""\n"' + lineterm.join(lines) + '"' return s def poentry(path, lineno, s): return ('#: %s:%d\n' % (path, lineno) + 'msgid %s\n' % normalize(s) + 'msgstr ""\n') doctestre = re.compile(r'^ +>>> ', re.MULTILINE) def offset(src, doc, name, default): """Compute offset or issue a warning on stdout.""" # remove doctest part, in order to avoid backslash mismatching m = doctestre.search(doc) if m: doc = doc[:m.start()] # Backslashes in doc appear doubled in src. end = src.find(doc.replace('\\', '\\\\')) if end == -1: # This can happen if the docstring contains unnecessary escape # sequences such as \" in a triple-quoted string. The problem # is that \" is turned into " and so doc wont appear in src. sys.stderr.write("warning: unknown offset in %s, assuming %d lines\n" % (name, default)) return default else: return src.count('\n', 0, end) def importpath(path): """Import a path like foo/bar/baz.py and return the baz module.""" if path.endswith('.py'): path = path[:-3] if path.endswith('/__init__'): path = path[:-9] path = path.replace('/', '.') mod = __import__(path) for comp in path.split('.')[1:]: mod = getattr(mod, comp) return mod def docstrings(path): """Extract docstrings from path. This respects the Mercurial cmdtable/table convention and will only extract docstrings from functions mentioned in these tables. """ mod = importpath(path) if not path.startswith('mercurial/') and mod.__doc__: src = open(path).read() lineno = 1 + offset(src, mod.__doc__, path, 7) print(poentry(path, lineno, mod.__doc__)) functions = list(getattr(mod, 'i18nfunctions', [])) functions = [(f, True) for f in functions] cmdtable = getattr(mod, 'cmdtable', {}) if not cmdtable: # Maybe we are processing mercurial.commands? cmdtable = getattr(mod, 'table', {}) functions.extend((c[0], False) for c in cmdtable.itervalues()) for func, rstrip in functions: if func.__doc__: docobj = func # this might be a proxy to provide formatted doc func = getattr(func, '_origfunc', func) funcmod = inspect.getmodule(func) extra = '' if funcmod.__package__ == funcmod.__name__: extra = '/__init__' actualpath = '%s%s.py' % (funcmod.__name__.replace('.', '/'), extra) src = inspect.getsource(func) name = "%s.%s" % (actualpath, func.__name__) lineno = inspect.getsourcelines(func)[1] doc = docobj.__doc__ origdoc = getattr(docobj, '_origdoc', '') if rstrip: doc = doc.rstrip() origdoc = origdoc.rstrip() if origdoc: lineno += offset(src, origdoc, name, 1) else: lineno += offset(src, doc, name, 1) print(poentry(actualpath, lineno, doc)) def rawtext(path): src = open(path).read() print(poentry(path, 1, src)) if __name__ == "__main__": # It is very important that we import the Mercurial modules from # the source tree where hggettext is executed. Otherwise we might # accidentally import and extract strings from a Mercurial # installation mentioned in PYTHONPATH. sys.path.insert(0, os.getcwd()) from mercurial import demandimport; demandimport.enable() for path in sys.argv[1:]: if path.endswith('.txt'): rawtext(path) else: docstrings(path)