Update comments and typing

Author: DanielNoord

tests/primer/primer_clone_external.py

@@ -11,11 +11,15 @@
 def _lazy_git_clone(data: PackageToLint, target_directory: str) -> None:
     """Clones a repository while checking if it hasn't already been cloned"""
     if os.path.exists(target_directory):
+        # Get SHA1 hash of latest commit on remote branch
         remote_sha1_commit = (
             git.cmd.Git().ls_remote(data.url, data.branch).split("\t")[0]
         )
+        # Get SHA1 hash of latest commit on locally downloaded branch
         local_sha1_commit = git.Repo(target_directory).head.object.hexsha
+
         if remote_sha1_commit != local_sha1_commit:
+            # Remove directory and all its files
             shutil.rmtree(target_directory)
             git.Repo.clone_from(
                 data.url,

tests/primer/primer_external_packages.py

@@ -30,3 +30,4 @@ class PackageToLint(NamedTuple):
         "https://github.com/numpy/numpy.git", "main", None, "/numpy/numpy", "numpy"
     ),
 }
+"""Dictionary of external packages used during the primer test"""

tests/primer/test_primer_external.py

@@ -5,32 +5,36 @@
 
 import pytest
 from tests.primer.primer_clone_external import clone_primer_packages
-from tests.primer.primer_external_packages import PACKAGES_TO_LINT, PRIMER_DIRECTORY
+from tests.primer.primer_external_packages import (
+    PACKAGES_TO_LINT,
+    PRIMER_DIRECTORY,
+    PackageToLint,
+)
 
 
 class TestPrimer:
     @staticmethod
     @pytest.mark.primer
-    @pytest.mark.parametrize(("package"), PACKAGES_TO_LINT)
-    def test_primer_external_packages_no_crash(package: str) -> None:
+    @pytest.mark.parametrize(
+        ("package"), PACKAGES_TO_LINT.values(), ids=PACKAGES_TO_LINT
+    )
+    def test_primer_external_packages_no_crash(package: PackageToLint) -> None:
         """Runs pylint over external packages to check for crashes and fatal messages
 
         We only check for crashes (bit-encoded exit code 32) and
         fatal messages (bit-encoded exit code 1). We assume that these external repositories
         do not have any fatal errors in their code so that any fatal errors are pylint false
         positives
         """
-        package_data = PACKAGES_TO_LINT[package]
-
         # Clone the packages repository
-        clone_primer_packages(package_data)
+        clone_primer_packages(package)
 
         try:
             subprocess.run(
                 ["pylint"]
                 + [
-                    f"{PRIMER_DIRECTORY}{package_data.clone_directory}/{i}"
-                    for i in package_data.directories.split(" ")
+                    f"{PRIMER_DIRECTORY}{package.clone_directory}/{i}"
+                    for i in package.directories.split(" ")
                 ]
                 + ["--errors-only", "--rcfile=./pylintrc"],
                 check=True,

tests/primer/test_primer_stdlib.py

@@ -11,11 +11,11 @@
 import pylint.lint
 
 
-def is_module(filename):
+def is_module(filename: str) -> bool:
     return filename.endswith(".py")
 
 
-def is_package(filename, location):
+def is_package(filename: str, location: str) -> bool:
     return os.path.exists(os.path.join(location, filename, "__init__.py"))
 
 
@@ -42,11 +42,12 @@ def _patch_stdout(out):
 @pytest.mark.parametrize(
     ("test_module_location", "test_module_name"), MODULES_TO_CHECK, ids=MODULES_NAMES
 )
-def test_lib_module_no_crash(test_module_location, test_module_name):
+def test_lib_module_no_crash(test_module_location: str, test_module_name: str) -> None:
+    """Test that pylint does not produces any crashes on stdlib modules"""
     os.chdir(test_module_location)
+
     with _patch_stdout(io.StringIO()):
         try:
             pylint.lint.Run([test_module_name, "--enable=all", "--ignore=test"])
         except SystemExit as ex:
             assert ex.code != 32
-            return