refactor(git): Use dataclass in some areas (#329)

- `GitRemote` and `GitStatus`: Move to https://docs.python.org/3/library/dataclasses.html
- `extract_status()`: Move to `GitStatus.from_stdout`

Author: tony

CHANGES

@@ -32,6 +32,8 @@ $ pip install --user --upgrade --pre libvcs
 - Rename `ProjectLoggingAdapter` to `CmdLoggingAdapter`
 - `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
 - `create_repo` -> `create_project`
+- `GitRemote` and `GitStatus`: Move to {func}`dataclasses.dataclass` ({issue}`#329`)
+- `extract_status()`: Move to `GitStatus.from_stdout` ({issue}`#329`)
 
 ### What's new
 

docs/conf.py

@@ -157,8 +157,8 @@ def setup(app):
 ]
 
 intersphinx_mapping = {
-    "py": ("https://docs.python.org/2", None),
-    "pip": ("http://pip.readthedocs.io/en/latest/", None),
+    "py": ("https://docs.python.org/3", None),
+    "pip": ("https://pip.pypa.io/en/latest/", None),
 }
 
 

libvcs/projects/git.py

@@ -14,10 +14,11 @@
     - [`GitProject.get_revision`](libvcs.git.GitProject.get_revision)
     - [`GitProject.get_git_version`](libvcs.git.GitProject.get_git_version)
 """  # NOQA: E501
+import dataclasses
 import logging
 import pathlib
 import re
-from typing import Dict, NamedTuple, Optional, TypedDict, Union
+from typing import Dict, Optional, TypedDict, Union
 from urllib import parse as urlparse
 
 from .. import exc
@@ -26,78 +27,101 @@
 logger = logging.getLogger(__name__)
 
 
-class GitRemote(NamedTuple):
-    """Structure containing git repo information.
+class GitRemoteDict(TypedDict):
+    """For use when hydrating GitProject via dict."""
+
+    fetch_url: str
+    push_url: str
 
-    Supports `collections.namedtuple._asdict()`
-    """
+
+@dataclasses.dataclass
+class GitRemote:
+    """Structure containing git working copy information."""
 
     name: str
     fetch_url: str
     push_url: str
 
+    def to_dict(self):
+        return dataclasses.asdict(self)
+
+    def to_tuple(self):
+        return dataclasses.astuple(self)
+
 
-class GitStatus(NamedTuple):
+GitProjectRemoteDict = Dict[str, GitRemote]
+GitFullRemoteDict = Dict[str, GitRemoteDict]
+GitRemotesArgs = Union[None, GitFullRemoteDict, Dict[str, str]]
+
+
+@dataclasses.dataclass
+class GitStatus:
     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 to_dict(self):
+        return dataclasses.asdict(self)
 
-def extract_status(value) -> GitStatus:
-    """Returns ``git status -sb --porcelain=2`` extracted to a dict
+    def to_tuple(self):
+        return dataclasses.astuple(self)
 
-    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>
-                .*
-            )
+    @classmethod
+    def from_stdout(cls, value: str):
+        """Returns ``git status -sb --porcelain=2`` extracted to a dict
 
-        )?
-        (
-            #
-            \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())
+        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 cls(**matches.groupdict())
 
 
 def convert_pip_url(pip_url: str) -> VCSLocation:
@@ -125,18 +149,6 @@ def convert_pip_url(pip_url: str) -> VCSLocation:
     return VCSLocation(url=url, rev=rev)
 
 
-class GitRemoteDict(TypedDict):
-    """For use when hydrating GitProject via dict."""
-
-    fetch_url: str
-    push_url: str
-
-
-GitProjectRemoteDict = Dict[str, GitRemote]
-GitFullRemoteDict = Dict[str, GitRemoteDict]
-GitRemotesArgs = Union[None, GitFullRemoteDict, Dict[str, str]]
-
-
 class GitProject(BaseProject):
     bin_name = "git"
     schemes = ("git", "git+http", "git+https", "git+ssh", "git+git", "git+file")
@@ -487,7 +499,7 @@ def remotes(self, flat=False) -> Dict:
 
         for remote_name in ret:
             remotes[remote_name] = (
-                self.remote(remote_name) if flat else self.remote(remote_name)._asdict()
+                self.remote(remote_name) if flat else self.remote(remote_name).to_dict()
             )
         return remotes
 
@@ -581,7 +593,7 @@ def get_git_version(self) -> str:
             version = ""
         return ".".join(version.split(".")[:3])
 
-    def status(self) -> dict:
+    def status(self):
         """Retrieve status of project in dict format.
 
         Wraps ``git status --sb --porcelain=2``. Does not include changed files, yet.
@@ -606,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
 
@@ -315,7 +315,7 @@ def test_remotes(
             expected_remote_name,
             expected_remote_url,
             expected_remote_url,
-        ) == git_repo.remote(expected_remote_name)
+        ) == git_repo.remote(expected_remote_name).to_tuple()
 
 
 @pytest.mark.parametrize(
@@ -493,7 +493,7 @@ def test_remotes_preserves_git_ssh(
     git_repo.set_remote(name=remote_name, url=remote_url)
 
     assert (
-        GitRemote(remote_name, remote_url, remote_url)._asdict()
+        GitRemote(remote_name, remote_url, remote_url).to_dict()
         in git_repo.remotes().values()
     )
 
@@ -553,9 +553,12 @@ def test_get_remotes(git_repo: GitProject):
 def test_set_remote(git_repo: GitProject, repo_name: str, new_repo_url: str):
     mynewremote = git_repo.set_remote(name=repo_name, url="file:///")
 
-    assert "file:///" in mynewremote, "set_remote returns remote"
+    assert "file:///" in mynewremote.fetch_url, "set_remote returns remote"
 
-    assert "file:///" in git_repo.remote(name=repo_name), "remote returns remote"
+    assert isinstance(
+        git_repo.remote(name=repo_name), GitRemote
+    ), "remote() returns GitRemote"
+    assert "file:///" in git_repo.remote(name=repo_name).fetch_url, "new value set"
 
     assert "myrepo" in git_repo.remotes(), ".remotes() returns new remote"
 
@@ -567,8 +570,8 @@ def test_set_remote(git_repo: GitProject, repo_name: str, new_repo_url: str):
 
     mynewremote = git_repo.set_remote(name="myrepo", url=new_repo_url, overwrite=True)
 
-    assert new_repo_url in git_repo.remote(
-        name="myrepo"
+    assert (
+        new_repo_url in git_repo.remote(name="myrepo").fetch_url
     ), "Running remove_set should overwrite previous remote"
 
 
@@ -614,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
@@ -625,7 +628,7 @@ def test_extract_status():
     assert {
         "branch_oid": "d4ccd4d6af04b53949f89fbf0cdae13719dc5a08",
         "branch_head": "fix-current-remote-name",
-    }.items() <= extract_status(FIXTURE_A)._asdict().items()
+    }.items() <= GitStatus.from_stdout(FIXTURE_A).to_dict().items()
 
 
 @pytest.mark.parametrize(
@@ -671,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))._asdict().items()
+        GitStatus.from_stdout(textwrap.dedent(fixture)).to_dict().items()
         >= expected_result.items()
     )
 
@@ -721,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))._asdict().items()
+        <= GitStatus.from_stdout(textwrap.dedent(fixture)).to_dict().items()
     )