Refactor for less nesting

Author: peterjc

flake8_rst_docstrings.py

@@ -122,6 +122,23 @@ def code_mapping(
     return default
 
 
+def special_case_unescaped(docstring, variable):
+    """Can RST213 for ``*arg``, or RST210 for ``*kwarg`` be ignored."""
+    if "\nArgs:\n" in docstring and docstring.find("\nArgs:\n") < docstring.find(
+        f"    {variable}:"
+    ):
+        # Ignore special case used in Google docstring style
+        return True
+    elif "\nParameters\n----------\n" in docstring:
+        i = docstring.find("\nParameters\n----------\n")
+        if i < docstring.find(f"\n{variable}\n") or i < docstring.find(
+            f"\n{variable} :"
+        ):
+            # Ignore special case used in NumPy docstring style
+            return True
+    return False
+
+
 class reStructuredTextChecker:
     """Checker of Python docstrings as reStructuredText."""
 
@@ -256,38 +273,14 @@ def run(self):
                     code += 100 * rst_error.level
                     msg = "%s%03i %s" % (rst_prefix, code, msg)
 
-                    if code == 210:
-                        if "\nArgs:\n" in docstring and docstring.find(
-                            "\nArgs:\n"
-                        ) < docstring.find("    **kwargs:"):
-                            # Ignore special case used in Google docstring style
-                            continue
-                        if "\nParameters\n----------\n" in docstring and docstring.find(
-                            "\nParameters\n----------\n"
-                        ) < docstring.find("\n**kwargs\n"):
-                            # Ignore special case used in NumPy docstring style
-                            continue
-                        if "\nParameters\n----------\n" in docstring and docstring.find(
-                            "\nParameters\n----------\n"
-                        ) < docstring.find("\n**kwargs :"):
-                            # Ignore special case used in NumPy docstring style
-                            continue
-                    elif code == 213:
-                        if "\nArgs:\n" in docstring and docstring.find(
-                            "\nArgs:\n"
-                        ) < docstring.find("    *args:"):
-                            # Ignore special case used in Google docstring style
-                            continue
-                        if "\nParameters\n----------\n" in docstring and docstring.find(
-                            "\nParameters\n----------\n"
-                        ) < docstring.find("\n*args\n"):
-                            # Ignore special case used in NumPy docstring style
-                            continue
-                        if "\nParameters\n----------\n" in docstring and docstring.find(
-                            "\nParameters\n----------\n"
-                        ) < docstring.find("\n*args :"):
-                            # Ignore special case used in NumPy docstring style
-                            continue
+                    # Silence special case use of *args and **kwargs
+                    # (hopefully won't mask a true positive in same docstring)
+                    if code == 210 and special_case_unescaped(docstring, "**kwargs"):
+                        # Ignore special case used in Google/NumPy docstring style
+                        continue
+                    elif code == 213 and special_case_unescaped(docstring, "*args"):
+                        # Ignore special case used in Google/NumPy docstring style
+                        continue
 
                     # We don't know the column number, leaving as zero.
                     yield start + rst_error.line, 0, msg, type(self)