/usr/lib/python2.7/dist-packages/bzrlib/export_pot.py is in python-bzrlib 2.7.0-2ubuntu3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | # Copyright (C) 2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
# The normalize function is taken from pygettext which is distributed
# with Python under the Python License, which is GPL compatible.
"""Extract docstrings from Bazaar commands.
This module only handles bzrlib objects that use strings not directly wrapped
by a gettext() call. To generate a complete translation template file, this
output needs to be combined with that of xgettext or a similar command for
extracting those strings, as is done in the bzr Makefile. Sorting the output
is also left to that stage of the process.
"""
from __future__ import absolute_import
import inspect
import os
from bzrlib import (
commands as _mod_commands,
errors,
help_topics,
option,
plugin,
help,
)
from bzrlib.trace import (
mutter,
note,
)
from bzrlib.i18n import gettext
def _escape(s):
s = (s.replace('\\', '\\\\')
.replace('\n', '\\n')
.replace('\r', '\\r')
.replace('\t', '\\t')
.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 _parse_source(source_text):
"""Get object to lineno mappings from given source_text"""
import ast
cls_to_lineno = {}
str_to_lineno = {}
for node in ast.walk(ast.parse(source_text)):
# TODO: worry about duplicates?
if isinstance(node, ast.ClassDef):
# TODO: worry about nesting?
cls_to_lineno[node.name] = node.lineno
elif isinstance(node, ast.Str):
# Python AST gives location of string literal as the line the
# string terminates on. It's more useful to have the line the
# string begins on. Unfortunately, counting back newlines is
# only an approximation as the AST is ignorant of escaping.
str_to_lineno[node.s] = node.lineno - node.s.count('\n')
return cls_to_lineno, str_to_lineno
class _ModuleContext(object):
"""Record of the location within a source tree"""
def __init__(self, path, lineno=1, _source_info=None):
self.path = path
self.lineno = lineno
if _source_info is not None:
self._cls_to_lineno, self._str_to_lineno = _source_info
@classmethod
def from_module(cls, module):
"""Get new context from module object and parse source for linenos"""
sourcepath = inspect.getsourcefile(module)
# TODO: fix this to do the right thing rather than rely on cwd
relpath = os.path.relpath(sourcepath)
return cls(relpath,
_source_info=_parse_source("".join(inspect.findsource(module)[0])))
def from_class(self, cls):
"""Get new context with same details but lineno of class in source"""
try:
lineno = self._cls_to_lineno[cls.__name__]
except (AttributeError, KeyError):
mutter("Definition of %r not found in %r", cls, self.path)
return self
return self.__class__(self.path, lineno,
(self._cls_to_lineno, self._str_to_lineno))
def from_string(self, string):
"""Get new context with same details but lineno of string in source"""
try:
lineno = self._str_to_lineno[string]
except (AttributeError, KeyError):
mutter("String %r not found in %r", string[:20], self.path)
return self
return self.__class__(self.path, lineno,
(self._cls_to_lineno, self._str_to_lineno))
class _PotExporter(object):
"""Write message details to output stream in .pot file format"""
def __init__(self, outf, include_duplicates=False):
self.outf = outf
if include_duplicates:
self._msgids = None
else:
self._msgids = set()
self._module_contexts = {}
def poentry(self, path, lineno, s, comment=None):
if self._msgids is not None:
if s in self._msgids:
return
self._msgids.add(s)
if comment is None:
comment = ''
else:
comment = "# %s\n" % comment
mutter("Exporting msg %r at line %d in %r", s[:20], lineno, path)
self.outf.write(
"#: {path}:{lineno}\n"
"{comment}"
"msgid {msg}\n"
"msgstr \"\"\n"
"\n".format(
path=path, lineno=lineno, comment=comment, msg=_normalize(s)))
def poentry_in_context(self, context, string, comment=None):
context = context.from_string(string)
self.poentry(context.path, context.lineno, string, comment)
def poentry_per_paragraph(self, path, lineno, msgid, include=None):
# TODO: How to split long help?
paragraphs = msgid.split('\n\n')
if include is not None:
paragraphs = filter(include, paragraphs)
for p in paragraphs:
self.poentry(path, lineno, p)
lineno += p.count('\n') + 2
def get_context(self, obj):
module = inspect.getmodule(obj)
try:
context = self._module_contexts[module.__name__]
except KeyError:
context = _ModuleContext.from_module(module)
self._module_contexts[module.__name__] = context
if inspect.isclass(obj):
context = context.from_class(obj)
return context
def _write_option(exporter, context, opt, note):
if getattr(opt, 'hidden', False):
return
optname = opt.name
if getattr(opt, 'title', None):
exporter.poentry_in_context(context, opt.title,
"title of {name!r} {what}".format(name=optname, what=note))
for name, _, _, helptxt in opt.iter_switches():
if name != optname:
if opt.is_hidden(name):
continue
name = "=".join([optname, name])
if helptxt:
exporter.poentry_in_context(context, helptxt,
"help of {name!r} {what}".format(name=name, what=note))
def _standard_options(exporter):
OPTIONS = option.Option.OPTIONS
context = exporter.get_context(option)
for name in sorted(OPTIONS.keys()):
opt = OPTIONS[name]
_write_option(exporter, context.from_string(name), opt, "option")
def _command_options(exporter, context, cmd):
note = "option of {0!r} command".format(cmd.name())
for opt in cmd.takes_options:
# String values in Command option lists are for global options
if not isinstance(opt, str):
_write_option(exporter, context, opt, note)
def _write_command_help(exporter, cmd):
context = exporter.get_context(cmd.__class__)
rawdoc = cmd.__doc__
dcontext = context.from_string(rawdoc)
doc = inspect.cleandoc(rawdoc)
def exclude_usage(p):
# ':Usage:' has special meaning in help topics.
# This is usage example of command and should not be translated.
if p.splitlines()[0] != ':Usage:':
return True
exporter.poentry_per_paragraph(dcontext.path, dcontext.lineno, doc,
exclude_usage)
_command_options(exporter, context, cmd)
def _command_helps(exporter, plugin_name=None):
"""Extract docstrings from path.
This respects the Bazaar cmdtable/table convention and will
only extract docstrings from functions mentioned in these tables.
"""
from glob import glob
# builtin commands
for cmd_name in _mod_commands.builtin_command_names():
command = _mod_commands.get_cmd_object(cmd_name, False)
if command.hidden:
continue
if plugin_name is not None:
# only export builtins if we are not exporting plugin commands
continue
note(gettext("Exporting messages from builtin command: %s"), cmd_name)
_write_command_help(exporter, command)
plugin_path = plugin.get_core_plugin_path()
core_plugins = glob(plugin_path + '/*/__init__.py')
core_plugins = [os.path.basename(os.path.dirname(p))
for p in core_plugins]
# plugins
for cmd_name in _mod_commands.plugin_command_names():
command = _mod_commands.get_cmd_object(cmd_name, False)
if command.hidden:
continue
if plugin_name is not None and command.plugin_name() != plugin_name:
# if we are exporting plugin commands, skip plugins we have not specified.
continue
if plugin_name is None and command.plugin_name() not in core_plugins:
# skip non-core plugins
# TODO: Support extracting from third party plugins.
continue
note(gettext("Exporting messages from plugin command: {0} in {1}").format(
cmd_name, command.plugin_name() ))
_write_command_help(exporter, command)
def _error_messages(exporter):
"""Extract fmt string from bzrlib.errors."""
context = exporter.get_context(errors)
base_klass = errors.BzrError
for name in dir(errors):
klass = getattr(errors, name)
if not inspect.isclass(klass):
continue
if not issubclass(klass, base_klass):
continue
if klass is base_klass:
continue
if klass.internal_error:
continue
fmt = getattr(klass, "_fmt", None)
if fmt:
note(gettext("Exporting message from error: %s"), name)
exporter.poentry_in_context(context, fmt)
def _help_topics(exporter):
topic_registry = help_topics.topic_registry
for key in topic_registry.keys():
doc = topic_registry.get(key)
if isinstance(doc, str):
exporter.poentry_per_paragraph(
'dummy/help_topics/'+key+'/detail.txt',
1, doc)
elif callable(doc): # help topics from files
exporter.poentry_per_paragraph(
'en/help_topics/'+key+'.txt',
1, doc(key))
summary = topic_registry.get_summary(key)
if summary is not None:
exporter.poentry('dummy/help_topics/'+key+'/summary.txt',
1, summary)
def export_pot(outf, plugin=None, include_duplicates=False):
exporter = _PotExporter(outf, include_duplicates)
if plugin is None:
_standard_options(exporter)
_command_helps(exporter)
_error_messages(exporter)
_help_topics(exporter)
else:
_command_helps(exporter, plugin)
|