Grammalecte warnings silent examples.

May not be the best way to do it as it does not use the *warning*
instance returned by Grammalecte.
The filter_out functions may be more appropriate but they do not
access the tcomment field.
--> would be nice to refactor to get the best of the two approaches.

Author: christopheNan

padpo/checkers/baseclass.py

@@ -26,6 +26,12 @@ def check_item(self, item: PoItem):
         """Check an item in a `*.po` file."""
         return NotImplementedError
 
+    def match_silent(self, regex, item: PoItem, match: str):
+        """ Generic function to silent a warning directly raised by the checker in the *match* field """
+        list_ok = regex.findall(item.entry.tcomment)
+        return any([match in term for term in list_ok])
+
+
     def add_warning(self, level: str, item: PoItem, text: str, prefix:str=None, match:str=None, suffix:str=None):
         silent_method_names = [self.__getattribute__(name) for name in self.__dir__() if name.startswith('silent_')]
         if any([m(item, text, prefix, match, suffix) for m in silent_method_names if callable(m)]):

padpo/checkers/glossary.py

@@ -10,10 +10,10 @@ class GlossaryChecker(Checker):
     """Checker for glossary usage."""
 
     name = "Glossary"
-    silent_re = re.compile('silent-glossary:`([^`]*)`')
+    re_silent = re.compile('silent-glossary:`([^`]*)`')
 
     def silent_glossary(self, item: PoItem, text: str, prefix, match, suffix):
-        for term in self.silent_re.findall(item.entry.tcomment):
+        for term in self.re_silent.findall(item.entry.tcomment):
             if term in text[:text.find("that is not translated")]:
                 return True
 

padpo/checkers/grammalecte.py

@@ -23,6 +23,14 @@ class GrammalecteChecker(Checker):
     """Checker for grammar errors."""
 
     name = "Grammalecte"
+    capital_silent_re = re.compile('silent-capital:`([^`]*)`')
+    unknown_word_silent_re = re.compile('silent-unknown:`([^`]*)`')
+
+    def silent_capital(self, item: PoItem, text: str, prefix: str, match: str, suffix:str):
+        return self.match_silent(self.capital_silent_re, item, match)
+
+    def silent_unknown_word(self, item: PoItem, text: str, prefix: str, match: str, suffix: str):
+        return self.match_silent(self.unknown_word_silent_re, item, match)
 
     def __init__(self):
         """Initialiser."""
@@ -54,9 +62,11 @@ def manage_warnings(self, warnings: GrammalecteMessage, pofile: PoFile) -> None:
             item = pofile.content[item_index]
             start = max(0, warning.start - 40)
             end = warning.end + 10
-            item.add_warning(
-                self.name,
+            self.add_warning("warning", item,
                 f"{warning.message} => " f"###{item.msgstr_rst2txt[start:end]}###",
+                             item.msgstr_rst2txt[start:warning.start],
+                             item.msgstr_rst2txt[warning.start:warning.end],
+                             item.msgstr_rst2txt[warning.end:end]
             )
 
     def filter_out_grammar_error(self, warning: GrammalecteMessage) -> bool:

tests/po_without_warnings/silent_grammalecte.po

@@ -0,0 +1,50 @@
+# example how to silent Grammalecte warnings
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: padpo\n"
+"Language-Team: FRENCH <traductions@lists.afpy.org>\n"
+"Language: fr\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+
+# silent-capital:`alors`
+#: tutorial/classes.rst:276
+msgid ""
+"then ``MyClass.i`` and ``MyClass.f`` are valid attribute references, "
+"returning an integer and a function object, respectively. Class attributes "
+"can also be assigned to, so you can change the value of ``MyClass.i`` by "
+"assignment. :attr:`__doc__` is also a valid attribute, returning the "
+"docstring belonging to the class: ``\"A simple example class\"``."
+msgstr ""
+"alors ``MyClass.i`` et ``MyClass.f`` sont des références valides à des "
+"attributs, renvoyant respectivement un entier et un objet fonction. Les "
+"attributs de classes peuvent également être affectés, de sorte que vous "
+"pouvez modifier la valeur de ``MyClass.i`` par affectation. :attr:`__doc__` "
+"est aussi un attribut valide, renvoyant la *docstring* appartenant à la "
+"classe : ``\"A simple example class\"``."
+
+# silent-unknown:`SciPy`
+#: tutorial/floatingpoint.rst:160
+msgid ""
+"If you are a heavy user of floating point operations you should take a look "
+"at the Numerical Python package and many other packages for mathematical and "
+"statistical operations supplied by the SciPy project. See <https://scipy."
+"org>."
+msgstr ""
+"Si vous êtes un utilisateur intensif des opérations sur les nombres à "
+"virgule flottante, nous vous conseillons de considérer le paquet *Numerical "
+"Python* ainsi que les paquets pour les opérations statistiques et "
+"mathématiques fournis par le projet SciPy. Consultez <https://scipy.org>."
+
+# silent-unknown:`The Perils of Floating Point`
+#: tutorial/floatingpoint.rst:134
+msgid ""
+"See `The Perils of Floating Point <http://"
+"www.lahey.com/float.htm>`_ for a more complete account of other common "
+"surprises."
+msgstr ""
+"Voir `The Perils of "
+"Floating Point <http://www.lahey.com/float.htm>`_ pour une liste plus "
+"complète de ce genre de surprises."