Created list_branches method in __main__.py as branch checking is used multiple times; Removed check_branches from tests file as no longer needed as a result of adding list_branches.

Author: OCopping

src/dls_python3_skeleton/__main__.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 from subprocess import STDOUT, CalledProcessError, check_output
 from tempfile import TemporaryDirectory
+from typing import List
 
 from . import __version__
 
@@ -37,6 +38,10 @@ def git(*args, cwd=None) -> str:
         raise
 
 
+def list_branches(path: Path) -> List[str]:
+    return git("branch", "--format=%(refname:short)", cwd=path).split("\n")
+
+
 class GitTemporaryDirectory(TemporaryDirectory):
     def __enter__(self):
         return self
@@ -66,7 +71,7 @@ def replace_text(text: str) -> str:
         text = text.replace("[email protected]", email)
         return text
 
-    branches = [x[2:] for x in str(git("branch", "--list", cwd=path)).split("\n")]
+    branches = list_branches(path)
 
     if MERGE_BRANCH in branches:
         raise Exception(
@@ -189,7 +194,7 @@ def clean_repo(args):
 
     assert path.is_dir(), f"Expected {path} to be an existing directory"
 
-    branches = [x[2:] for x in str(git("branch", "--list")).split("\n")]
+    branches = list_branches(path)
     assert (
         f"{MERGE_BRANCH}" in branches
     ), f"Expected {MERGE_BRANCH} to be in existing repo"

tests/test_dls_python3_skeleton.py

@@ -2,7 +2,6 @@
 import sys
 from configparser import ConfigParser
 from pathlib import Path
-from typing import List
 
 import pytest
 
@@ -18,10 +17,6 @@ def check_output(*args, cwd=None) -> str:
         raise ValueError(e.output)
 
 
-def check_branches(module: str) -> List[str]:
-    return __main__.git("branch", "--format=%(refname:short)", cwd=module).split("\n")
-
-
 def test_cli_version():
     output = check_output(sys.executable, "-m", "dls_python3_skeleton", "--version")
     assert output.strip() == __version__
@@ -117,7 +112,7 @@ def test_existing_module(tmp_path: Path):
         in str(excinfo.value)
     )
 
-    branches = check_branches(str(module))
+    branches = __main__.list_branches(module)
     assert MERGE_BRANCH in branches
     output = check_output(
         sys.executable,
@@ -128,5 +123,5 @@ def test_existing_module(tmp_path: Path):
         cwd=str(module),
     )
     assert output.strip("\n") == f"{MERGE_BRANCH} deleted from existing repo"
-    branches = check_branches(str(module))
+    branches = __main__.list_branches(module)
     assert MERGE_BRANCH not in branches