Switch from re.finditer to re.sub

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

Author: s0undt3ch

src/saltrewrite/salt/fix_docstrings.py

@@ -108,27 +108,34 @@ def autofix_docstring(docstring, filename):
 )
 
 
-def _convert_version_names_to_numbers(docstring, filename):
+def _handle_convert_version_names_to_numbers_match(match):
     """
-    Convert Salt version names to their version numbers counterpart
+    Convert every match with a properly formatted version.
     """
-    for match in CONVERT_VERSION_NAMES_TO_NUMBERS_RE.finditer(docstring):
-        vtype = match.group("vtype")
-        version = match.group("version")
-        versions = [vs.strip() for vs in version.split(",")]
-        parsed_versions = []
-        for version in versions:
+    vtype = match.group("vtype")
+    version = match.group("version")
+    versions = [vs.strip() for vs in version.split(",")]
+    parsed_versions = []
+    for version in versions:
+        try:
+            version = SaltStackVersion.from_name(version).string
+        except ValueError:
             try:
-                version = SaltStackVersion.from_name(version).string
+                version = SaltStackVersion.parse(version).string
             except ValueError:
-                try:
-                    version = SaltStackVersion.parse(version).string
-                except ValueError:
-                    pass
-            parsed_versions.append(version)
-        replace_contents = ".. {}:: {}".format(vtype, ",".join(parsed_versions))
-        docstring = docstring.replace(match.group(0), replace_contents.rstrip())
-    return docstring
+                pass
+        parsed_versions.append(version)
+    replace_contents = ".. {}:: {}".format(vtype, ",".join(parsed_versions))
+    return replace_contents
+
+
+def _convert_version_names_to_numbers(docstring, filename):
+    """
+    Convert Salt version names to their version numbers counterpart
+    """
+    return CONVERT_VERSION_NAMES_TO_NUMBERS_RE.sub(
+        _handle_convert_version_names_to_numbers_match, docstring
+    )
 
 
 CLI_EXAMPLE_CASE_AND_SPACING_RE = re.compile(
@@ -157,21 +164,22 @@ def _fix_simple_cli_example_spacing_issues(docstring, filename):
 )
 
 
+def _handle_fix_directives_formatting_match(match):
+    return (
+        "\n{}.. {}:: {}".format(
+            match.group("spc1") or "",
+            match.group("directive"),
+            match.group("remaining") or "",
+        ).rstrip()
+        + "\n"
+    )
+
+
 def _fix_directives_formatting(docstring, filename):
     """
     Fix directive definition spacing
     """
-    for match in DIRECTIVES_FORMATTING_RE.finditer(docstring):
-        replacement = (
-            "\n{}.. {}:: {}".format(
-                match.group("spc1") or "",
-                match.group("directive"),
-                match.group("remaining") or "",
-            ).rstrip()
-            + "\n"
-        )
-        docstring = docstring.replace(match.group(0), replacement)
-    return docstring
+    return DIRECTIVES_FORMATTING_RE.sub(_handle_fix_directives_formatting_match, docstring)
 
 
 FIX_CODE_BLOCKS_RE = re.compile(

tests/salt/test_docstrings.py

@@ -243,12 +243,14 @@ def test_fix_versionadded_module_docstring_dot_zero_suffix(tempfiles, vtype):
     '''
     New module blah
 
-    ..{}:3006
+    ..{0}:3006
     '''
 
     def one():
         '''
         One function
+
+        ..{0}::3006.0
         '''
         print("one")
     """.format(
@@ -261,12 +263,75 @@ def one():
     '''
     New module blah
 
-    .. {}:: 3006.0
+    .. {0}:: 3006.0
     '''
 
     def one():
         '''
         One function
+
+        .. {0}:: 3006.0
+        '''
+        print("one")
+    """.format(
+            vtype
+        )
+    )
+    fpath = tempfiles.makepyfile(code, prefix="test_")
+    fix_docstrings.rewrite(fpath)
+    with open(fpath) as rfh:
+        new_code = rfh.read()
+    assert new_code == expected_code
+
+
+@pytest.mark.parametrize("vtype", ["versionadded", "versionchanged", "deprecated"])
+def test_fix_version_repeated_in_same_docstring(tempfiles, vtype):
+    code = textwrap.dedent(
+        """
+    # -*- coding: utf-8 -*-
+    '''
+    New module blah
+
+    ..{0}:3006
+    '''
+
+    def one(two, three):
+        '''
+        One function
+
+        ..{0}::3006.0
+
+        Args:
+            two: Two
+            .. {0}::3006
+            three: Three
+            .. {0}:: 3006
+        '''
+        print("one")
+    """.format(
+            vtype
+        )
+    )
+    expected_code = textwrap.dedent(
+        """
+    # -*- coding: utf-8 -*-
+    '''
+    New module blah
+
+    .. {0}:: 3006.0
+    '''
+
+    def one(two, three):
+        '''
+        One function
+
+        .. {0}:: 3006.0
+
+        Args:
+            two: Two
+            .. {0}:: 3006.0
+            three: Three
+            .. {0}:: 3006.0
         '''
         print("one")
     """.format(