✨ [+feature] Updated script to modify version var in pyproject.toml (#44)

Author: davidbrownell

src/AutoGitSemVer/scripts/UpdatePythonVersion.py

@@ -46,13 +46,13 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
 # ----------------------------------------------------------------------
 @app.command("EntryPoint", help=__doc__, no_args_is_help=True)
 def EntryPoint(
-    python_filename: Annotated[
+    filename: Annotated[
         Path,
         typer.Argument(
             dir_okay=False,
             exists=True,
             resolve_path=True,
-            help="Name of the python file that contains the __version__ variable.",
+            help="Name of the python file that contains the __version__ variable or the pyproject.toml file that contains the version variable.",
         ),
     ],
     working_dir: Annotated[
@@ -76,7 +76,7 @@ def EntryPoint(
     with DoneManager.CreateCommandLine(
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
     ) as dm:
-        working_dir = working_dir or python_filename.parent
+        working_dir = working_dir or filename.parent
 
         version = GetSemanticVersion(
             dm,
@@ -89,17 +89,31 @@ def EntryPoint(
 
         dm.WriteLine("")
 
-        with dm.Nested(f"Updating '{python_filename}'...") as update_dm:
-            with python_filename.open(encoding="utf-8") as f:
+        with dm.Nested(f"Updating '{filename}'...") as update_dm:
+            with filename.open(encoding="utf-8") as f:
                 content = f.read()
 
-            match = re.search(
-                r"^(?P<prefix>\s*__version__\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
-                content,
-                flags=re.MULTILINE,
-            )
+            if filename.suffix == ".py":
+                variable_name = "__version__"
+
+                regex = re.compile(
+                    rf"^(?P<prefix>\s*{variable_name}\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
+                    flags=re.MULTILINE,
+                )
+            elif filename.suffix == ".toml":
+                variable_name = "version"
+
+                regex = re.compile(
+                    rf"^(?P<prefix>{variable_name}\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
+                    flags=re.MULTILINE,
+                )
+            else:
+                error = f"'{filename}' is not a recognized file type."
+                raise Exception(error)
+
+            match = regex.search(content)
             if not match:
-                update_dm.WriteError("A '__version__' variable was not found.\n")
+                update_dm.WriteError(f"A '{variable_name}' variable was not found.\n")
                 return
 
             content = "".join(
@@ -114,12 +128,12 @@ def EntryPoint(
                 ],
             )
 
-            with python_filename.open("w", encoding="utf-8", newline=match.group("newline")) as f:
+            with filename.open("w", encoding="utf-8", newline=match.group("newline")) as f:
                 f.write(content)
 
 
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 if __name__ == "__main__":
-    app()
+    app()  # pragma: no cover

tests/scripts/UpdatePythonVersion_UnitTest.py

@@ -18,15 +18,14 @@
 from pathlib import Path
 from unittest.mock import MagicMock as Mock, mock_open, patch
 
-import pytest
-
+from click.testing import Result
 from typer.testing import CliRunner
 from AutoGitSemVer import GetSemanticVersionResult
 from AutoGitSemVer.scripts.UpdatePythonVersion import app
 
 
 # ----------------------------------------------------------------------
-def test_Default():
+def test_Python():
     _Execute(
         textwrap.dedent(
             """\
@@ -46,7 +45,7 @@ def test_Default():
 
 
 # ----------------------------------------------------------------------
-def test_NoVersion():
+def test_NoPythonVersion():
     _Execute(
         textwrap.dedent(
             """\
@@ -58,15 +57,63 @@ def test_NoVersion():
     )
 
 
+# ----------------------------------------------------------------------
+def test_Toml():
+    _Execute(
+        textwrap.dedent(
+            """\
+            # Line Before
+            version = ""
+            # Line After
+            """,
+        ),
+        textwrap.dedent(
+            """\
+            # Line Before
+            version = "1.2.3"
+            # Line After
+            """,
+        ),
+        file_extension=".toml",
+    )
+
+
+# ----------------------------------------------------------------------
+def test_NoTomlVersion():
+    _Execute(
+        textwrap.dedent(
+            """\
+            # No version in this file
+            """,
+        ),
+        "",
+        file_extension=".toml",
+        expected_failure=True,
+    )
+
+
+# ----------------------------------------------------------------------
+def test_UnsupportedFileType():
+    result = _Execute(
+        "",
+        "",
+        file_extension=".md",
+        expected_failure=True,
+    )
+    exception_message = str(result.exception)
+    assert "README.md' is not a recognized file type." in exception_message
+
+
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 def _Execute(
     original: str,
     expected: str,
     *,
+    file_extension: str = ".py",
     expected_failure: bool = False,
-) -> str:
+) -> Result:
     # ----------------------------------------------------------------------
     def MyWrite(value):
         assert value == expected
@@ -86,11 +133,20 @@ def MyWrite(value):
         ),
         patch.object(Path, "open", file_mock),
     ):
-        result = CliRunner().invoke(app, [__file__])
+        if file_extension == ".py":
+            placeholder_filename = Path(__file__)
+        elif file_extension == ".toml":
+            placeholder_filename = Path(__file__).parent.parent.parent / "pyproject.toml"
+        elif file_extension == ".md":
+            placeholder_filename = Path(__file__).parent.parent.parent / "README.md"
+        else:
+            assert False, file_extension
+
+        result = CliRunner().invoke(app, [str(placeholder_filename)])
 
         if expected_failure:
-            assert result.exit_code != 0
+            assert result.exit_code != 0, result.output
         else:
-            assert result.exit_code == 0
+            assert result.exit_code == 0, result.output
 
-        return result.output
+        return result