Move CI to a separate directory

We tidy up the root directory and move everything related to continous
integration to a separate directory.

Author: mristin

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Run checks
         run: |
-          python3 precommit.py
+          python3 continuous_integration/precommit.py
 
       - name: Upload Coverage
         run: coveralls --service=github

README.rst

@@ -100,7 +100,7 @@ Development
 
 .. code-block:: bash
 
-    python precommit.py
+    python continuous_integration/precommit.py
 
 Versioning
 ==========

continuous_integration/__init__.py

@@ -50,14 +50,14 @@ def parse_readme(lines: List[str]) -> Tuple[List[Block], List[str]]:
         mtch = HELP_STARTS_RE.match(lines[i])
         if mtch:
             command = mtch.group("command")
-            help_ends = ".. Help ends: {}".format(command)
+            help_ends = f".. Help ends: {command}"
             try:
                 end_index = lines.index(help_ends, i)
             except ValueError:
                 end_index = -1
 
             if end_index == -1:
-                return [], ["Could not find the end marker {!r}".format(help_ends)]
+                return [], [f"Could not find the end marker {help_ends!r}"]
 
             blocks.append(
                 Block(command=command, start_line_idx=i + 1, end_line_idx=end_index)
@@ -84,18 +84,18 @@ def capture_output_lines(command: str) -> List[str]:
             f"The python interpreter could not be found: {command_parts[0]}"
         )
 
-    proc = subprocess.Popen(
+    with subprocess.Popen(
         command_parts,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
         encoding="utf-8",
-    )
-    output, err = proc.communicate()
-    if err:
-        raise RuntimeError(
-            f"The command {command!r} failed with exit code {proc.returncode} and "
-            f"stderr:\n{err}"
-        )
+    ) as proc:
+        output, err = proc.communicate()
+        if err:
+            raise RuntimeError(
+                f"The command {command!r} failed with exit code {proc.returncode} and "
+                f"stderr:\n{err}"
+            )
 
     return output.splitlines()
 
@@ -126,16 +126,16 @@ def diff(got_lines: List[str], expected_lines: List[str]) -> Optional[str]:
     result.append("Expected:")
     for i, line in enumerate(expected_lines):
         if i >= len(got_lines) or line != got_lines[i]:
-            print("DIFF: {:2d}: {!r}".format(i, line))
+            print(f"DIFF: {i:2d}: {line!r}")
         else:
-            print("OK  : {:2d}: {!r}".format(i, line))
+            print(f"OK  : {i:2d}: {line!r}")
 
     result.append("Got:")
     for i, line in enumerate(got_lines):
         if i >= len(expected_lines) or line != expected_lines[i]:
-            print("DIFF: {:2d}: {!r}".format(i, line))
+            print(f"DIFF: {i:2d}: {line!r}")
         else:
-            print("OK  : {:2d}: {!r}".format(i, line))
+            print(f"OK  : {i:2d}: {line!r}")
 
     return "\n".join(result)
 
@@ -152,20 +152,22 @@ def main() -> int:
     args = parser.parse_args()
     overwrite = bool(args.overwrite)
 
-    this_dir = pathlib.Path(os.path.realpath(__file__)).parent
-    pth = this_dir / "README.rst"
+    repo_root = pathlib.Path(os.path.realpath(__file__)).parent.parent
+    pth = repo_root / "README.rst"
 
     text = pth.read_text(encoding="utf-8")
     lines = text.splitlines()
 
     blocks, errors = parse_readme(lines=lines)
     if errors:
-        print("One or more errors in {}:".format(pth), file=sys.stderr)
+        print(f"One or more errors in {pth}:", file=sys.stderr)
         for error in errors:
             print(error, file=sys.stderr)
 
         return -1
 
+    assert blocks is not None
+
     if len(blocks) == 0:
         return 0
 
@@ -185,6 +187,7 @@ def main() -> int:
             result.extend(code_block_lines)
             previous_block = block
 
+        assert previous_block is not None
         result.extend(lines[previous_block.end_line_idx :])
         result.append("")  # new line at the end of file
 
@@ -198,9 +201,11 @@ def main() -> int:
             expected_lines = lines[block.start_line_idx : block.end_line_idx]
             expected_lines = [line.rstrip() for line in expected_lines]
 
-            error = diff(got_lines=code_block_lines, expected_lines=expected_lines)
-            if error:
-                print(error, file=sys.stderr)
+            maybe_error = diff(
+                got_lines=code_block_lines, expected_lines=expected_lines
+            )
+            if maybe_error:
+                print(maybe_error, file=sys.stderr)
                 return -1
 
     return 0

check_help_in_readme.py …uous_integration/check_help_in_readme.pycheck_help_in_readme.py renamed to continuous_integration/check_help_in_readme.py check_help_in_readme.py renamed to continuous_integration/check_help_in_readme.py

@@ -7,6 +7,8 @@
 import subprocess
 import sys
 
+# pylint: disable=missing-docstring
+
 
 class Step(enum.Enum):
     BLACK = "black"
@@ -60,21 +62,20 @@ def main() -> int:
     selects = (
         [Step(value) for value in args.select]
         if args.select is not None
-        else [value for value in Step]
+        else [value for value in Step]  # pylint: disable=unnecessary-comprehension
     )
     skips = [Step(value) for value in args.skip] if args.skip is not None else []
 
-    repo_root = pathlib.Path(__file__).parent
+    repo_root = pathlib.Path(__file__).parent.parent
 
     if Step.BLACK in selects and Step.BLACK not in skips:
         print("Black'ing...")
         # fmt: off
         black_targets = [
             "abnf_to_regexp",
-            "precommit.py",
-            "check_version_consistent.py",
-            "check_help_in_readme.py",
-            "dev_scripts"
+            "continuous_integration",
+            "dev_scripts",
+            "tests"
         ]
         # fmt: on
 
@@ -93,7 +94,12 @@ def main() -> int:
     if Step.MYPY in selects and Step.MYPY not in skips:
         print("Mypy'ing...")
         # fmt: off
-        mypy_targets = ["abnf_to_regexp", "tests", "dev_scripts"]
+        mypy_targets = [
+            "abnf_to_regexp",
+            "tests",
+            "dev_scripts",
+            "continuous_integration"
+        ]
         subprocess.check_call(
             [
                 sys.executable,
@@ -108,13 +114,17 @@ def main() -> int:
     if Step.PYLINT in selects and Step.PYLINT not in skips:
         # fmt: off
         print("Pylint'ing...")
-        pylint_targets = ["abnf_to_regexp", "tests", "dev_scripts"]
+        pylint_targets = [
+            "abnf_to_regexp",
+            "tests",
+            "dev_scripts",
+            "continuous_integration"
+        ]
         subprocess.check_call(
             [
                 sys.executable,
                 "-m",
-                "pylint",
-                "--rcfile=pylint.rc"
+                "pylint"
             ] + pylint_targets, cwd=str(repo_root)
         )
         # fmt: on
@@ -166,7 +176,9 @@ def main() -> int:
             "Checking that the version is consistent between "
             "abnf_to_regexp/__init__.py and pyproject.toml ..."
         )
-        subprocess.check_call([sys.executable, "check_version_consistent.py"])
+        subprocess.check_call(
+            [sys.executable, "continuous_integration/check_version_consistent.py"]
+        )
     else:
         print(
             "Skipped checking that the versions in abnf_to_regexp/__init__.py "
@@ -175,7 +187,7 @@ def main() -> int:
 
     if Step.CHECK_HELP_IN_README in selects and Step.CHECK_HELP_IN_README not in skips:
         if sys.version_info < (3, 10):
-            cmd = [sys.executable, "check_help_in_readme.py"]
+            cmd = [sys.executable, "continuous_integration/check_help_in_readme.py"]
             if overwrite:
                 cmd.append("--overwrite")
 

check_version_consistent.py …_integration/check_version_consistent.pycheck_version_consistent.py renamed to continuous_integration/check_version_consistent.py check_version_consistent.py renamed to continuous_integration/check_version_consistent.py

@@ -54,4 +54,41 @@ packages = ["abnf_to_regexp"]
 abnf_to_regexp = ["py.typed"]
 
 [tool.setuptools.exclude-package-data]
-"*" = ["tests*"]
+"*" = ["tests*"]
+
+[tool.pylint.format]
+max-line-length = 120
+
+[tool.pylint."messages control"]
+disable = [
+    "too-few-public-methods",
+    "len-as-condition",
+    "duplicate-code",
+    "no-else-raise",
+    "no-else-return",
+    "too-many-locals",
+    "too-many-branches",
+    "too-many-nested-blocks",
+    "too-many-return-statements",
+    "unsubscriptable-object",
+    "not-an-iterable",
+    "broad-except",
+    "too-many-statements",
+    "protected-access",
+    "unnecessary-pass",
+    "use-dict-literal",
+]
+
+[tool.mypy]
+
+[[tool.mypy.overrides]]
+module = "abnf"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "regex"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "sortedcontainers"
+ignore_missing_imports = true