[rhel7-branch 2/2] Added a check for translatable format strings in glade.

atodorov installerbot-noreply at redhat.com
Tue Mar 3 14:12:54 UTC 2015


From: David Shea <dshea at redhat.com>

    This one might be a little confusing. Having translatable strings in
    glade works fine for the most part, but having translatable strings that
    contain format substitution information in glade is problematic. The
    format substitution is by necessity outside of glade, which causes
    two related problems. First, separating the string constant from the
    format operation looks confusing and needs information from another file
    to know the order or names of the arguments:

       # I have no idea what is going on
       label.set_text(label.get_text() % ("huh", "ok"))

    and second, the translations of the format strings can't be checked.
    Normally if a translator messes up one of our format strings, msgfmt
    will raise an error during the build. The strings in glade files,
    however, are supposed to be language-independent, so they don't get the
    c-format or python-format attributes that the strings in C and Python
    source files do, and the error happens at runtime.

    Format strings without the translatable attribute are fine, since
    they're handy to use as placeholders.
---
 tests/glade/format_string/check_format_string.py | 78 ++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100755 tests/glade/format_string/check_format_string.py

diff --git a/tests/glade/format_string/check_format_string.py b/tests/glade/format_string/check_format_string.py
new file mode 100755
index 0000000..81191e1
--- /dev/null
+++ b/tests/glade/format_string/check_format_string.py
@@ -0,0 +1,78 @@
+#!/usr/bin/python
+#
+# Copyright (C) 2014  Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: David Shea <dshea at redhat.com>
+#
+
+"""
+Python script to ensure that translatable format strings are not present
+in Glade files.
+
+Since format substitution is language-dependent, gettext is unable to check
+the validity of format string translations for strings within glade. Instead,
+the format string constant, the translation substitution, and the format
+substitution should all happen outside of glade. Untranslated placeholder
+strings are allowable within glade.
+"""
+
+import sys
+import argparse
+import re
+
+try:
+    from lxml import etree
+except ImportError:
+    print("You need to install the python-lxml package to use check_format_string.py")
+    sys.exit(1)
+
+def check_glade_file(glade_file_path):
+    global success
+
+    with open(glade_file_path) as glade_file:
+        # Parse the XML
+        glade_tree = etree.parse(glade_file)
+
+        # Check any property with translatable="yes"
+        for translatable in glade_tree.xpath(".//*[@translatable='yes']"):
+            # Look for % followed by an open parenthesis (indicating %(name)
+            # style substitution), one of the python format conversion flags
+            # (#0- +hlL), or one of the python conversion types 
+            # (diouxXeEfFgGcrs)
+            if re.search(r'%[-(#0 +hlLdiouxXeEfFgGcrs]', translatable.text):
+                print("Translatable format string found in glade at %s:%d" % \
+                        (glade_file_path, translatable.sourceline))
+                success = False
+
+if __name__ == "__main__":
+    success = True
+    parser = argparse.ArgumentParser("Check that password entries have visibility set to False")
+
+    # Ignore translation arguments
+    parser.add_argument("-t", "--translate", action='store_true',
+            help=argparse.SUPPRESS)
+    parser.add_argument("-p", "--podir", action='store', type=str,
+            metavar='PODIR', help=argparse.SUPPRESS, default='./po')
+
+    parser.add_argument("glade_files", nargs="+", metavar="GLADE-FILE",
+            help='The glade file to check')
+    args = parser.parse_args(args=sys.argv[1:])
+
+    success = True
+    for file_path in args.glade_files:
+        check_glade_file(file_path)
+
+    sys.exit(0 if success else 1)


-- 
To view this commit on github, visit https://github.com/rhinstaller/anaconda/commit/c5c866630bec6f6867a8c2ed7c6dab373dc62f11


More information about the anaconda-patches mailing list