Accurate generation of hg.pot
Martin Geisler
mg at lazybytes.net
Thu May 21 12:29:35 CDT 2009
Hi guys,
I've made a script for generating the hg.pot file by more careful
introspection. But I cannot figure out how to import files that contain
relative imports themselves... so the pasted script extends sys.path,
but this cannot be the right way?
#!/usr/bin/env python
#
# hggettext - carefully extract docstrings for Mercurial
#
# Copyright 2009 Matt Mackall <mpm at selenic.com> and others
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2, incorporated herein by reference.
# 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 mercurial import demandimport; demandimport.enable()
From mercurial import extensions
import os, sys, inspect
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')
def offset(src, doc, name, default):
"""Compute offset or issue a warning on stdout."""
# 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 docstrings(path):
"""Extract all docstrings in path.
This respects the Mercurial cmdtable/table convension and will
only extract docstrings from functions mentioned in these tables.
"""
mod = extensions.loadpath(path, 'hg_%s' % path)
if mod.__doc__:
src = open(path).read()
lineno = 1 + offset(src, mod.__doc__, path, 7)
print poentry(path, lineno, mod.__doc__)
cmdtable = getattr(mod, 'cmdtable', {})
if not cmdtable:
# Maybe we are processing mercurial.commands?
cmdtable = getattr(mod, 'table', {})
for entry in cmdtable.itervalues():
func = entry[0]
if func.__doc__:
src = inspect.getsource(func)
name = "%s.%s" % (path, func.__name__)
lineno = func.func_code.co_firstlineno
lineno += offset(src, func.__doc__, name, 1)
print poentry(path, lineno, func.__doc__)
if __name__ == "__main__":
# TODO: This, combined with demandimport, make the relative
# imports work. But it really shouldn't be necessary...
sys.path.extend(set(os.path.dirname(a) for a in sys.argv[1:]))
for path in sys.argv[1:]:
docstrings(path)
--
Martin Geisler
VIFF (Virtual Ideal Functionality Framework) brings easy and efficient
SMPC (Secure Multiparty Computation) to Python. See: http://viff.dk/.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 196 bytes
Desc: not available
Url : http://selenic.com/pipermail/mercurial-devel/attachments/20090521/6b9b7151/attachment.pgp
More information about the Mercurial-devel
mailing list