refactor: Turn GitStatus into a NamedTuple

Author: tony

libvcs/git.py

@@ -18,7 +18,7 @@
 import logging
 import os
 import re
-from typing import NamedTuple
+from typing import NamedTuple, Optional
 
 from . import exc
 from ._compat import urlparse
@@ -38,7 +38,16 @@ class GitRemote(NamedTuple):
     push_url: str
 
 
-def extract_status(value):
+class GitStatus(NamedTuple):
+    branch_oid: Optional[str]
+    branch_head: Optional[str]
+    branch_upstream: Optional[str]
+    branch_ab: Optional[str]
+    branch_ahead: Optional[str]
+    branch_behind: Optional[str]
+
+
+def extract_status(value) -> GitStatus:
     """Returns ``git status -sb --porcelain=2`` extracted to a dict
 
     Returns
@@ -90,7 +99,7 @@ def extract_status(value):
         re.VERBOSE | re.MULTILINE,
     )
     matches = pattern.search(value)
-    return matches.groupdict()
+    return GitStatus(**matches.groupdict())
 
 
 class GitRepo(BaseRepo):
@@ -474,6 +483,6 @@ def get_current_remote_name(self):
         """
         match = self.status()
 
-        if match['branch_upstream'] is None:  # no upstream set
-            return match['branch_head']
-        return match['branch_upstream'].replace('/' + match['branch_head'], '')
+        if match.branch_upstream is None:  # no upstream set
+            return match.branch_head
+        return match.branch_upstream.replace('/' + match.branch_head, '')

tests/test_git.py

@@ -264,7 +264,7 @@ def test_extract_status():
     assert {
         "branch_oid": 'd4ccd4d6af04b53949f89fbf0cdae13719dc5a08',
         "branch_head": 'fix-current-remote-name',
-    }.items() <= extract_status(FIXTURE_A).items()
+    }.items() <= extract_status(FIXTURE_A)._asdict().items()
 
 
 @pytest.mark.parametrize(
@@ -313,11 +313,13 @@ def test_extract_status():
 def test_extract_status_b(fixture, expected_result):
     if PY2:
         assert (
-            extract_status(textwrap.dedent(fixture)).items() <= expected_result.items()
+            extract_status(textwrap.dedent(fixture))._asdict().items()
+            <= expected_result.items()
         )
     else:
         assert (
-            extract_status(textwrap.dedent(fixture)).items() >= expected_result.items()
+            extract_status(textwrap.dedent(fixture))._asdict().items()
+            >= expected_result.items()
         )
 
 
@@ -365,4 +367,7 @@ def test_extract_status_b(fixture, expected_result):
     ],
 )
 def test_extract_status_c(fixture, expected_result):
-    assert expected_result.items() <= extract_status(textwrap.dedent(fixture)).items()
+    assert (
+        expected_result.items()
+        <= extract_status(textwrap.dedent(fixture))._asdict().items()
+    )