refactor(git): extract_status -> GitStatus.from_stdout

Author: tony

libvcs/projects/git.py

@@ -69,59 +69,59 @@ def to_dict(self):
     def to_tuple(self):
         return dataclasses.astuple(self)
 
+    @classmethod
+    def from_stdout(cls, value: str):
+        """Returns ``git status -sb --porcelain=2`` extracted to a dict
 
-def extract_status(value) -> GitStatus:
-    """Returns ``git status -sb --porcelain=2`` extracted to a dict
-
-    Returns
-    -------
-    Dictionary of git repo's status
-    """
-    pattern = re.compile(
-        r"""[\n\r]?
-        (
-            #
-            \W+
-            branch.oid\W+
-            (?P<branch_oid>
-                [a-f0-9]{40}
-            )
-        )?
-        (
-            #
-            \W+
-            branch.head
-            [\W]+
-            (?P<branch_head>
-                .*
-            )
+        Returns
+        -------
+        Dictionary of git repo's status
+        """
+        pattern = re.compile(
+            r"""[\n\r]?
+            (
+                #
+                \W+
+                branch.oid\W+
+                (?P<branch_oid>
+                    [a-f0-9]{40}
+                )
+            )?
+            (
+                #
+                \W+
+                branch.head
+                [\W]+
+                (?P<branch_head>
+                    .*
+                )
 
-        )?
-        (
-            #
-            \W+
-            branch.upstream
-            [\W]+
-            (?P<branch_upstream>
-                .*
-            )
-        )?
-        (
-            #
-            \W+
-            branch.ab
-            [\W]+
-            (?P<branch_ab>
-                \+(?P<branch_ahead>\d+)
-                \W{1}
-                \-(?P<branch_behind>\d+)
-            )
-        )?
-        """,
-        re.VERBOSE | re.MULTILINE,
-    )
-    matches = pattern.search(value)
-    return GitStatus(**matches.groupdict())
+            )?
+            (
+                #
+                \W+
+                branch.upstream
+                [\W]+
+                (?P<branch_upstream>
+                    .*
+                )
+            )?
+            (
+                #
+                \W+
+                branch.ab
+                [\W]+
+                (?P<branch_ab>
+                    \+(?P<branch_ahead>\d+)
+                    \W{1}
+                    \-(?P<branch_behind>\d+)
+                )
+            )?
+            """,
+            re.VERBOSE | re.MULTILINE,
+        )
+        matches = pattern.search(value)
+        return cls(**matches.groupdict())
 
 
 def convert_pip_url(pip_url: str) -> VCSLocation:
@@ -618,7 +618,7 @@ def status(self) -> dict:
 branch_behind='0'\
 )
         """
-        return extract_status(self.run(["status", "-sb", "--porcelain=2"]))
+        return GitStatus.from_stdout(self.run(["status", "-sb", "--porcelain=2"]))
 
     def get_current_remote_name(self) -> str:
         """Retrieve name of the remote / upstream of currently checked out branch.

tests/projects/test_git.py

@@ -16,8 +16,8 @@
     GitFullRemoteDict,
     GitProject,
     GitRemote,
+    GitStatus,
     convert_pip_url as git_convert_pip_url,
-    extract_status,
 )
 from libvcs.shortcuts import create_project_from_pip_url
 
@@ -617,7 +617,7 @@ def test_get_current_remote_name(git_repo: GitProject):
     ), "Should reflect new upstream branch (different branch)"
 
 
-def test_extract_status():
+def test_GitRemote_from_stdout():
     FIXTURE_A = textwrap.dedent(
         """
         # branch.oid d4ccd4d6af04b53949f89fbf0cdae13719dc5a08
@@ -628,7 +628,7 @@ def test_extract_status():
     assert {
         "branch_oid": "d4ccd4d6af04b53949f89fbf0cdae13719dc5a08",
         "branch_head": "fix-current-remote-name",
-    }.items() <= extract_status(FIXTURE_A).to_dict().items()
+    }.items() <= GitStatus.from_stdout(FIXTURE_A).to_dict().items()
 
 
 @pytest.mark.parametrize(
@@ -674,9 +674,9 @@ def test_extract_status():
         ],
     ],
 )
-def test_extract_status_b(fixture: str, expected_result: dict):
+def test_GitRemote__from_stdout_b(fixture: str, expected_result: dict):
     assert (
-        extract_status(textwrap.dedent(fixture)).to_dict().items()
+        GitStatus.from_stdout(textwrap.dedent(fixture)).to_dict().items()
         >= expected_result.items()
     )
 
@@ -724,10 +724,10 @@ def test_extract_status_b(fixture: str, expected_result: dict):
         ],
     ],
 )
-def test_extract_status_c(fixture: str, expected_result: dict):
+def test_GitRemote__from_stdout_c(fixture: str, expected_result: dict):
     assert (
         expected_result.items()
-        <= extract_status(textwrap.dedent(fixture)).to_dict().items()
+        <= GitStatus.from_stdout(textwrap.dedent(fixture)).to_dict().items()
     )