First steps

Author: DanielNoord

.gitignore

@@ -1,3 +1,4 @@
+.pydocstringformatter_primer_tests
 pydocstringformatter.egg-info
 dist/
 docs/_build

pydocstringformatter/testutils/primer/__init__.py

@@ -0,0 +1,6 @@
+from pathlib import Path
+
+PRIMER_DIRECTORY_PATH = (
+    Path(__file__).parent.parent.parent.parent / ".pydocstringformatter_primer_tests"
+)
+"""Directory to store anything primer related in."""

pydocstringformatter/testutils/primer/const.py

@@ -0,0 +1,71 @@
+import logging
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Dict, List, Union
+
+import git
+
+from pydocstringformatter.testutils.primer.const import PRIMER_DIRECTORY_PATH
+
+
+@dataclass
+class _PackageToCheck:
+    """Represents data about a package to be tested during primer tests."""
+
+    url: str
+    """URL of the repository to clone."""
+
+    branch: str
+    """Branch of the repository to clone."""
+
+    directories: List[str]
+    """Directories within the repository to run the program over."""
+
+    @property
+    def clone_directory(self) -> Path:
+        """Directory to clone repository into."""
+        clone_name = "/".join(self.url.split("/")[-2:]).replace(".git", "")
+        return PRIMER_DIRECTORY_PATH / clone_name
+
+    @property
+    def paths_to_lint(self) -> List[str]:
+        """The paths we need to run against."""
+        return [str(self.clone_directory / path) for path in self.directories]
+
+    def lazy_clone(self) -> None:
+        """Clone the repo, if necessary."""
+        logging.info("Lazy cloning %s", self.url)
+
+        # Clone if not yet cloned
+        if not self.clone_directory.exists():
+            options: Dict[str, Union[str, int]] = {
+                "url": self.url,
+                "to_path": str(self.clone_directory),
+                "branch": self.branch,
+                "depth": 1,
+            }
+            logging.info("Directory does not exists, cloning: %s", options)
+            git.Repo.clone_from(**options)
+            return
+
+        # Check if local clone is latest version
+        remote_sha1_commit = (
+            git.cmd.Git().ls_remote(self.url, self.branch).split("\t")[0]
+        )
+        local_sha1_commit = git.Repo(self.clone_directory).head.object.hexsha
+        if remote_sha1_commit != local_sha1_commit:
+            logging.info(
+                "Remote sha is '%s' while local sha is '%s': pulling new commits",
+                remote_sha1_commit,
+                local_sha1_commit,
+            )
+            repo = git.Repo(self.clone_directory)
+            origin = repo.remotes.origin
+            origin.pull()
+        else:
+            logging.info("Repository already up to date.")
+
+
+PACKAGES = {
+    "pylint": _PackageToCheck("https://github.com/PyCQA/pylint", "main", ["pylint"]),
+}

pydocstringformatter/testutils/primer/packages.py

@@ -3,12 +3,15 @@
 
 def _generate_diff(old: str, new: str, filename: str) -> str:
     """Generate a printable diff for two strings of sourcecode."""
-    return "\n".join(
-        difflib.unified_diff(
-            old.split("\n"),
-            new.split("\n"),
-            fromfile=filename,
-            tofile=filename,
-            lineterm="",
+    return (
+        "\n".join(
+            difflib.unified_diff(
+                old.split("\n"),
+                new.split("\n"),
+                fromfile=filename,
+                tofile=filename,
+                lineterm="",
+            )
         )
+        + "\n"
     )

pydocstringformatter/utils/file_diference.py

@@ -14,6 +14,10 @@ exclude = "tests/data.*"
 strict = true
 show_error_codes = true
 
+[[tool.mypy.overrides]]
+module = ["git.*"]
+ignore_missing_imports = true
+
 [tool.pylint.MASTER]
 load-plugins=[
     "pylint.extensions.check_elif",

pyproject.toml

@@ -4,6 +4,7 @@ coverage[toml]==6.2
 coveralls==3.3.1
 pytest==6.2.5
 pytest-cov==3.0.0
+gitpython>=3
 
 # Requirements for docs building
 -r docs/requirements-doc.txt