mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-26 00:41:25 -06:00
1b4eab0411
This patch reverts the use of pygettext for i18n string extraction. It
was originally introduced because the help documentation for commands
are in the class docstring and module docstring.
Docstrings are a Python construct whereby any string which immediately
follows a class declaration, function/method declaration or appears
first in a module is taken to be the documentation for that
object. Python automatically assigns that string to the __doc__
variable associated with the object. Explicitly assigning to the
__doc__ variable is equivalent and permitted.
We mark strings in the source for i18n translation by embedding them
in _() or ngettext(). Specialized extraction tools (e.g. xgettext)
scan the source code looking for strings with those markers and
extracts the string for inclusion in a translation catalog.
It was mistakingly assumed one could not mark for translation Python
docstrings. Since some docstrings are vital for our command help
system some method had to be devised to extract docstrings for the
translation catalog. pygettext has the ability to locate and extract
docstrings and it was introduced to acquire the documentation for our
commands located in module and class docstrings.
However pygettext was too large a hammer for this task, it lacked any
fined grained ability to extract only the docstrings we were
interested in. In practice it extracted EVERY docstring in each file
it was presented with. This caused a large number strings to be
extracted for translation which had no reason to be translated, the
string might have been internal code documentation never meant to be
seen by users. Often the superfluous docstrings were long, complex and
likely difficult to translate. This placed an unnecessary burden on
our volunteer translators.
Instead what is needed is some method to extract only those strings
intended for translation. We already have such a mechanism and it is
already widely used, namely wrapping strings intended for translation
in calls to _() or _negettext(), i.e. marking a string for i18n
translation. Thus the solution to the docstring translation problem is
to mark the docstrings exactly as we have been doing, it only requires
that instead of a bare Python docstring we instead assign the marked
string to the __doc__ variable. Using the hypothetical class foo as
an example.
class foo(Command):
'''
The foo command takes out the garbage.
'''
Would become:
class foo(Command):
__doc__ = _('The foo command takes out the garbage.')
But which docstrings need to be marked for translation? The makeapi
tool knows how to iterate over every command in our public API. It was
extended to validate every command's documentation and report if any
documentation is missing or not marked for translation. That
information was then used to identify each docstring in the code which
needed to be transformed.
In summary what this patch does is:
* Remove the use of pygettext (modification to install/po/Makefile.in)
* Replace every docstring with an explicit assignment to __doc__ where
the rhs of the assignment is an i18n marking function.
* Single line docstrings appearing in multi-line string literals
(e.g. ''' or """) were replaced with single line string literals
because the multi-line literals were introducing unnecessary
whitespace and newlines in the string extracted for translation. For
example:
'''
The foo command takes out the garbage.
'''
Would appear in the translation catalog as:
"\n
The foo command takes out the garbage.\n
"
The superfluous whitespace and newlines are confusing to translators
and requires us to strip leading and trailing whitespace from the
translation at run time.
* Import statements were moved from below the docstring to above
it. This was necessary because the i18n markers are imported
functions and must be available before the the doc is
parsed. Technically only the import of the i18n markers had to
appear before the doc but stylistically it's better to keep all the
imports together.
* It was observed during the docstring editing process that the
command documentation was inconsistent with respect to the use of
periods to terminate a sentence. Some doc had a trailing period,
others didn't. Consistency was enforced by adding a period to end of
every docstring if one was missing.
141 lines
3.9 KiB
Python
141 lines
3.9 KiB
Python
# Authors:
|
|
# Jason Gerard DeRose <jderose@redhat.com>
|
|
#
|
|
# Copyright (C) 2008 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# 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 3 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
import re
|
|
from ipalib import api, LocalOrRemote, _, ngettext
|
|
from ipalib.output import Output, summary
|
|
from ipalib import Flag
|
|
|
|
__doc__ = _("""
|
|
Misc plug-ins
|
|
""")
|
|
|
|
# FIXME: We should not let env return anything in_server
|
|
# when mode == 'production'. This would allow an attacker to see the
|
|
# configuration of the server, potentially revealing compromising
|
|
# information. However, it's damn handy for testing/debugging.
|
|
|
|
|
|
class env(LocalOrRemote):
|
|
__doc__ = _('Show environment variables.')
|
|
|
|
msg_summary = _('%(count)d variables')
|
|
|
|
takes_args = (
|
|
'variables*',
|
|
)
|
|
|
|
takes_options = LocalOrRemote.takes_options + (
|
|
Flag('all',
|
|
cli_name='all',
|
|
doc=_('retrieve and print all attributes from the server. Affects command output.'),
|
|
exclude='webui',
|
|
flags=['no_output'],
|
|
default=True,
|
|
),
|
|
)
|
|
|
|
has_output = (
|
|
Output('result',
|
|
type=dict,
|
|
doc=_('Dictionary mapping variable name to value'),
|
|
),
|
|
Output('total',
|
|
type=int,
|
|
doc=_('Total number of variables env (>= count)'),
|
|
flags=['no_display'],
|
|
),
|
|
Output('count',
|
|
type=int,
|
|
doc=_('Number of variables returned (<= total)'),
|
|
flags=['no_display'],
|
|
),
|
|
summary,
|
|
)
|
|
|
|
def __find_keys(self, variables):
|
|
keys = set()
|
|
for query in variables:
|
|
if '*' in query:
|
|
pat = re.compile(query.replace('*', '.*') + '$')
|
|
for key in self.env:
|
|
if pat.match(key):
|
|
keys.add(key)
|
|
elif query in self.env:
|
|
keys.add(query)
|
|
return keys
|
|
|
|
def execute(self, variables, **options):
|
|
if variables is None:
|
|
keys = self.env
|
|
else:
|
|
keys = self.__find_keys(variables)
|
|
ret = dict(
|
|
result=dict(
|
|
(key, self.env[key]) for key in keys
|
|
),
|
|
count=len(keys),
|
|
total=len(self.env),
|
|
)
|
|
if len(keys) > 1:
|
|
ret['summary'] = self.msg_summary % ret
|
|
else:
|
|
ret['summary'] = None
|
|
return ret
|
|
|
|
api.register(env)
|
|
|
|
|
|
class plugins(LocalOrRemote):
|
|
__doc__ = _('Show all loaded plugins.')
|
|
|
|
msg_summary = ngettext(
|
|
'%(count)d plugin loaded', '%(count)d plugins loaded', 0
|
|
)
|
|
|
|
takes_options = LocalOrRemote.takes_options + (
|
|
Flag('all',
|
|
cli_name='all',
|
|
doc=_('retrieve and print all attributes from the server. Affects command output.'),
|
|
exclude='webui',
|
|
flags=['no_output'],
|
|
default=True,
|
|
),
|
|
)
|
|
|
|
has_output = (
|
|
Output('result', dict, 'Dictionary mapping plugin names to bases'),
|
|
Output('count',
|
|
type=int,
|
|
doc=_('Number of plugins loaded'),
|
|
),
|
|
summary,
|
|
)
|
|
|
|
def execute(self, **options):
|
|
plugins = sorted(self.api.plugins, key=lambda o: o.plugin)
|
|
return dict(
|
|
result=dict(
|
|
(p.plugin, p.bases) for p in plugins
|
|
),
|
|
count=len(plugins),
|
|
)
|
|
|
|
api.register(plugins)
|