Add: mypy coverage to scripts. (#452)

* Add: mypy coverage to scripts.

* Fix: Missing type annotation in tests.

* Fix: Ignore tomli for now.

Author: bjones1

pyproject.toml

@@ -79,7 +79,7 @@ script_launch_mode = "subprocess"
 # This section `must <https://mypy.readthedocs.io/en/stable/config_file.html#config-file-format>`_ be present.
 [tool.mypy]
 # See `files <https://mypy.readthedocs.io/en/stable/config_file.html#confval-files>`_.
-files = "pretext"
+files = "pretext,scripts,tests"
 exclude = "^pretext/core/pretext\\.py$"
 check_untyped_defs = true
 disallow_untyped_defs = true
@@ -93,6 +93,10 @@ module = [
     "ghp_import",
     # We're installing ``lxml-stubs``, but it doesn't have stubs for this yet.
     "lxml.ElementInclude",
+    # TODO: Currently, the ``tomli`` package doesn't support Python 3.11, so
+    # it's not installed there. For now, ignore this module. Remove the ignore
+    # when ``tomli`` provide support for Python 3.11.
+    "tomli",
 ]
 ignore_missing_imports = true
 

scripts/build_package.py

@@ -3,7 +3,7 @@
 import zip_templates
 
 
-def main():
+def main() -> None:
     import pretext
 
     print(f"Building package for version {pretext.VERSION}.")

scripts/fetch_core.py

@@ -8,7 +8,7 @@
 from remove_path import remove_path
 
 
-def main():
+def main() -> None:
     # grab copy of necessary PreTeXtBook/pretext files from specified commit
 
     print(f"Requesting core PreTeXtBook/pretext commit {CORE_COMMIT} from GitHub.")

scripts/fetch_core_commit.py

@@ -3,9 +3,10 @@
 import json
 from datetime import datetime
 import fileinput
+from typing import Any, Dict
 
 
-def commit_data(repo):
+def commit_data(repo: str) -> Dict[str, Any]:
     """
     Returns a dictionary containing the date and commit sha from the most recent commit to `repo`
     """
@@ -20,7 +21,7 @@ def commit_data(repo):
     return lastcommit
 
 
-def main():
+def main() -> None:
     last_core_commit = commit_data("pretext")
 
     # Update core commit:

scripts/prep_nightly.py

@@ -3,9 +3,10 @@
 import json
 from datetime import datetime
 import fileinput
+from typing import Any, Dict
 
 
-def commit_data(repo):
+def commit_data(repo: str) -> Dict[str, Any]:
     lastcommit = {}
     url = f"https://api.github.com/repos/pretextbook/{repo}/commits"
     response = urlopen(url)
@@ -17,7 +18,7 @@ def commit_data(repo):
     return lastcommit
 
 
-def should_release(coredate, clidate):
+def should_release(coredate: datetime, clidate: datetime) -> bool:
     if (datetime.now() - coredate).days < 1:
         print(
             f"There has been an update to core pretext in the last 24 hours, at {coredate}"
@@ -30,7 +31,7 @@ def should_release(coredate, clidate):
         return True
 
 
-def main():
+def main() -> None:
     last_core_commit = commit_data("pretext")
     last_cli_commit = commit_data("pretext-cli")
 

scripts/release_alpha.py

@@ -4,7 +4,7 @@
 import build_package
 
 
-def main():
+def main() -> None:
     repo = git.Repo()
     if repo.bare or repo.is_dirty() or len(repo.untracked_files) > 0:
         raise Exception("Must commit outstanding changes to project source.")

scripts/release_nightly.py

@@ -5,9 +5,10 @@
 from datetime import datetime
 import fileinput
 import pytest
+from typing import Any, Dict
 
 
-def commit_data(repo):
+def commit_data(repo: str) -> Dict[str, Any]:
     lastcommit = {}
     url = f"https://api.github.com/repos/pretextbook/{repo}/commits"
     response = urlopen(url)
@@ -19,7 +20,7 @@ def commit_data(repo):
     return lastcommit
 
 
-def should_release(coredate, clidate):
+def should_release(coredate: datetime, clidate: datetime) -> bool:
     if (datetime.now() - coredate).days < 1:
         print(
             f"There has been an update to core pretext in the last 24 hours, at {coredate}"
@@ -32,7 +33,7 @@ def should_release(coredate, clidate):
         return True
 
 
-def main():
+def main() -> None:
     last_core_commit = commit_data("pretext")
     last_cli_commit = commit_data("pretext-cli")
 

scripts/release_stable.py

@@ -6,7 +6,7 @@
 import build_package
 
 
-def main(level="patch"):
+def main(level: str = "patch") -> None:
     repo = git.Repo()
     if repo.bare or repo.is_dirty() or len(repo.untracked_files) > 0:
         raise Exception("Must commit outstanding changes to project source.")

scripts/remove_path.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 
 
-def remove_path(path: Path):
+def remove_path(path: Path) -> None:
     if path.is_file() or path.is_symlink():
         path.unlink()  # remove the file
     elif path.is_dir():

scripts/symlink_core.py

@@ -4,7 +4,7 @@
 import pretext.core.resources
 
 
-def main(core_path: Path = Path("../pretext")):
+def main(core_path: Path = Path("../pretext")) -> None:
     for subdir in ["xsl", "schema", "script", "css"]:
         original_path = (core_path / subdir).resolve()
         link_path = pretext.core.resources.path(subdir)