Add argument id/str for -s/--spelling to check messages or translations

Author: flashcode

README.md

@@ -39,7 +39,8 @@ Options:
 * `-f`, `--fuzzy`: check fuzzy strings
 * `-l`, `--no-lines`: do not check number of lines
 * `-p`, `--no-punct`: do not check punctuation at end of strings
-* `-s`, `--spelling`: check spelling
+* `-s id|str`, `--spelling id|str`: check spelling (`id` = source messages,
+  `str` = translations)
 * `-d <dicts>`, `--dicts <dicts>`: comma-separated list of extra dictionaries
   to use (in addition to file language)
 * `-P <file>`, `--pwl <file>`: file with personal word list used when checking

msgcheck/msgcheck.py

@@ -26,7 +26,7 @@
   * whitespace at beginning/end of strings
   * trailing whitespace at end of lines inside strings
   * punctuation at end of strings
-  * spelling
+  * spelling (messages and translations)
 """
 
 from __future__ import print_function
@@ -69,7 +69,7 @@ def msgcheck_parser():
                         help='do not check number of lines')
     parser.add_argument('-p', '--no-punct', action='store_true',
                         help='do not check punctuation at end of strings')
-    parser.add_argument('-s', '--spelling', action='store_true',
+    parser.add_argument('-s', '--spelling', choices=['id', 'str'],
                         help='check spelling')
     parser.add_argument('-d', '--dicts',
                         help='comma-separated list of extra dictionaries '
@@ -110,18 +110,17 @@ def main():
     args = parser.parse_args(
         shlex.split(os.getenv('MSGCHECK_OPTIONS') or '') + sys.argv[1:])
 
-    # create checker and set options
+    # create checker and set boolean options
     po_check = PoCheck()
     for option in ('no_compile', 'fuzzy', 'no_lines', 'no_punct',
-                   'no_whitespace', 'no_whitespace_eol', 'spelling',
-                   'extract'):
+                   'no_whitespace', 'no_whitespace_eol', 'extract'):
         if args.__dict__[option]:
             po_check.set_check(option.lstrip('no_'),
                                not option.startswith('no_'))
 
     # check all files
     try:
-        po_check.set_spelling_options(args.dicts, args.pwl)
+        po_check.set_spelling_options(args.spelling, args.dicts, args.pwl)
         result = po_check.check_files(args.file)
     except (ImportError, IOError) as exc:
         print('FATAL:', exc, sep=' ')
@@ -136,7 +135,7 @@ def main():
             if not args.quiet:
                 if args.only_misspelled:
                     print('\n'.join([report.message for report in reports
-                                     if report.idmsg == 'spelling']))
+                                     if report.idmsg.startswith('spelling-')]))
                 else:
                     print('\n'.join([str(report) for report in reports]))
         else:

msgcheck/po.py

@@ -253,7 +253,7 @@ def check_whitespace_eol(self):
                     break
         return errors
 
-    def check_spelling(self, checkers):
+    def check_spelling(self, spelling, checkers):
         """
         Check spelling.
         Return a list with errors detected.
@@ -264,7 +264,7 @@ def check_spelling(self, checkers):
         for mid, mstr in self.messages:
             if not mid or not mstr:
                 continue
-            checkers[0].set_text(mstr)
+            checkers[0].set_text(mstr if spelling == 'str' else mid)
             misspelled = []
             for err in checkers[0]:
                 misspelled_word = True
@@ -275,8 +275,8 @@ def check_spelling(self, checkers):
                 if misspelled_word:
                     misspelled.append(err.word)
             for word in misspelled:
-                errors.append(PoReport(word, 'spelling', self.filename,
-                                       self.line, mid, mstr))
+                errors.append(PoReport(word, 'spelling-' + spelling,
+                                       self.filename, self.line, mid, mstr))
         return errors
 
 
@@ -383,11 +383,11 @@ def __init__(self):
             'punct': True,
             'whitespace': True,
             'whitespace_eol': True,
-            'spelling': False,
             'extract': False,
         }
 
         # spelling options
+        self.spelling = None
         self.dicts = None
         self.extra_checkers = []
         self.pwl = None
@@ -403,8 +403,9 @@ def set_check(self, check, state):
         if check in self.checks:
             self.checks[check] = bool(state)
 
-    def set_spelling_options(self, dicts, pwl):
+    def set_spelling_options(self, spelling, dicts, pwl):
         """Set spelling options."""
+        self.spelling = spelling
         self.dicts = dicts
         self.pwl = pwl
 
@@ -429,17 +430,19 @@ def set_spelling_options(self, dicts, pwl):
     def _get_language_checker(self, po_file, reports):
         """Get checker for PO file language."""
         checker = []
-        if self.checks['spelling']:
+        if self.spelling:
             if not ENCHANT_FOUND:
                 raise ImportError('Enchant module not found (please install '
                                   '"pyenchant")')
+            lang = po_file.props['language'] \
+                if self.spelling == 'str' else 'en'
             try:
-                _dict = DictWithPWL(po_file.props['language'], self.pwl)
+                _dict = DictWithPWL(lang, self.pwl)
                 checker.append(SpellChecker(_dict))
             except DictNotFoundError:
                 reports.append(PoReport(
                     'enchant dictionary not found for language "{0}"'
-                    ''.format(po_file.props['language']),
+                    ''.format(lang),
                     'dict', po_file.filename,
                     po_file.props['language_numline']))
                 checker = []
@@ -479,9 +482,9 @@ def check_pofile(self, po_file):
                     reports += msg.check_whitespace()
                 if self.checks['whitespace_eol']:
                     reports += msg.check_whitespace_eol()
-                if self.checks['spelling']:
+                if self.spelling:
                     reports += msg.check_spelling(
-                        checker + self.extra_checkers)
+                        self.spelling, checker + self.extra_checkers)
 
         return reports
 

tests/test_msgcheck.py

@@ -98,8 +98,7 @@ def test_checks_fuzzy(self):
     def test_spelling(self):
         """Test spelling on gettext files."""
         po_check = PoCheck()
-        po_check.set_check('spelling', True)
-        po_check.set_spelling_options(None, local_path('pwl.txt'))
+        po_check.set_spelling_options('str', None, local_path('pwl.txt'))
         result = po_check.check_files([local_path('fr_spelling.po'),
                                        local_path('fr_language.po')])
 
@@ -110,7 +109,7 @@ def test_spelling(self):
         errors = result[0][1]
         self.assertEquals(len(errors), 2)
         for i, word in enumerate(('aabbcc', 'xxyyzz')):
-            self.assertEquals(errors[i].idmsg, 'spelling')
+            self.assertEquals(errors[i].idmsg, 'spelling-str')
             self.assertEquals(errors[i].message, word)
 
         # second file has 1 error: dict/language "xyz" not found
@@ -121,15 +120,14 @@ def test_spelling(self):
     def test_spelling_bad_dict(self):
         """Test spelling with a bad dict option."""
         po_check = PoCheck()
-        po_check.set_spelling_options('xxx', None)
+        po_check.set_spelling_options('str', 'xxx', None)
         self.assertEquals(len(po_check.extra_checkers), 0)
 
     def test_spelling_bad_pwl(self):
         """Test spelling with a bad pwl option."""
         po_check = PoCheck()
-        po_check.set_check('spelling', True)
         try:
-            po_check.set_spelling_options(None,
+            po_check.set_spelling_options('str', None,
                                           local_path('pwl_does_not_exist.txt'))
         except IOError:
             pass  # this exception is expected