Fixing a bug in GRIT where messages with substitutions would

grit/clique.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 '''Collections of messages and their translations, called cliques.  Also
 collections of cliques (uber-cliques).
 '''
 
 import types
 
 from grit import constants
 from grit import exception
+from grit import lazy_re
 from grit import pseudo
 from grit import pseudo_rtl
 from grit import tclib
 
 
 class UberClique(object):
   '''A factory (NOT a singleton factory) for making cliques.  It has several
   methods for working with the cliques created using the factory.
   '''
 
@@ skipping 250 matching lines @@
   translations together with their original message.'''
 
   # change this to the language code of Messages you add to cliques_.
   # TODO(joi) Actually change this based on the <grit> node's source language
   source_language = 'en'
 
   # A constant translation we use when asked for a translation into the
   # special language constants.CONSTANT_LANGUAGE.
   CONSTANT_TRANSLATION = tclib.Translation(text='TTTTTT')
 
+  # A pattern to match messages that are empty or whitespace only.
+  WHITESPACE_MESSAGE = lazy_re.compile(u'^( |\t|\n|\r|\xa0)*$')
+
   def __init__(self, uber_clique, message, translateable=True, custom_type=None):
     '''Create a new clique initialized with just a message.
 
+    Note that messages with a body comprised only of whitespace will implicitly
+    be marked non-translatable.
+
     Args:
       uber_clique: Our uber-clique (collection of cliques)
       message: tclib.Message()
       translateable: True | False
       custom_type: instance of clique.CustomType interface
     '''
     # Our parent
     self.uber_clique = uber_clique
     # If not translateable, we only store the original message.
     self.translateable = translateable
+
+    # We implicitly mark messages that have a whitespace-only body as
+    # non-translateable.
+    if MessageClique.WHITESPACE_MESSAGE.match(message.GetRealContent()):
+      self.translateable = False
+
     # A mapping of language identifiers to tclib.BaseMessage and its
     # subclasses (i.e. tclib.Message and tclib.Translation).
     self.clique = { MessageClique.source_language : message }
     # A list of the "shortcut groups" this clique is
     # part of.  Within any given shortcut group, no shortcut key (e.g. &J)
     # must appear more than once in each language for all cliques that
     # belong to the group.
     self.shortcut_groups = []
     # An instance of the CustomType interface, or None.  If this is set, it will
     # be used to validate the original message and translations thereof, and
@@ skipping 131 matching lines @@
     transl_msg = tclib.Translation(id=self.GetId(),
                                    text=translation.GetPresentableContent(),
                                    placeholders=original.GetPlaceholders())
 
     if self.custom_type and not self.custom_type.ValidateAndModify(language, transl_msg):
       print "WARNING: %s translation failed validation: %s" % (
         language, transl_msg.GetId())
 
     self.clique[language] = transl_msg