feat(typing): add more type annotations

.github/workflows/reviewdog.yml

@@ -18,6 +18,11 @@ jobs:
         pip install .
         pip install mypy
         pip install pylint
+        pip install sqlalchemy[mypy]
+        pip install types-Jinja2
+        pip install types-PyYAML
+        pip install types-six
+        pip install types-setuptools
 
     - name: Setup reviewdog
       run: |

benchbuild/cli/bootstrap.py

@@ -30,5 +30,6 @@ def main(self, *args: str) -> int:
         if self.store_config:
             config_path = ".benchbuild.yml"
             CFG.store(config_path)
-            print("Storing config in {0}".format(os.path.abspath(config_path)))
+            store_path = os.path.abspath(config_path)
+            print(f'Storing config in {store_path}')
         return 0

benchbuild/cli/config.py

@@ -31,4 +31,5 @@ class BBConfigWrite(cli.Application):
     def main(self):
         config_path = ".benchbuild.yml"
         settings.CFG.store(config_path)
-        print("Storing config in {0}".format(os.path.abspath(config_path)))
+        store_path = os.path.abspath(config_path)
+        print(f'Storing config in {store_path}')

benchbuild/cli/log.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """ Analyze the BB database. """
+import typing as tp
 
 from plumbum import cli
 
@@ -13,9 +14,9 @@ def print_runs(query):
         return
 
     for tup in query:
-        print(("{0} @ {1} - {2} id: {3} group: {4}".format(
-            tup.end, tup.experiment_name, tup.project_name,
-            tup.experiment_group, tup.run_group)))
+        print(
+            f'{tup.end} @ {tup.experiment_name} - {tup.project_name} id: {tup.experiment_group} group: {tup.run_group}'
+        )
 
 
 def print_logs(query, types=None):
@@ -24,10 +25,10 @@ def print_logs(query, types=None):
         return
 
     for run, log in query:
-        print(("{0} @ {1} - {2} id: {3} group: {4} status: {5}".format(
-            run.end, run.experiment_name, run.project_name,
-            run.experiment_group, run.run_group, log.status)))
-        print(("command: {0}".format(run.command)))
+        print(
+            f'{run.end} @ {run.experiment_name} - {run.project_name} id: {run.experiment_group} group: {run.run_group} status: {log.status}'
+        )
+        print(f'command: {run.command}')
         if "stderr" in types:
             print("StdErr:")
             print((log.stderr))
@@ -73,10 +74,10 @@ def log_type(self, types):
         """ Set the output types to print. """
         self._types = types
 
-    _experiments = None
-    _experiment_ids = None
-    _project_ids = None
-    _types = None
+    _experiments: tp.Optional[tp.List[str]] = None
+    _experiment_ids: tp.Optional[tp.List[str]] = None
+    _project_ids: tp.Optional[tp.List[str]] = None
+    _types: tp.Optional[tp.List[str]] = None
 
     def main(self, *projects):
         """ Run the log command. """

benchbuild/cli/main.py

@@ -44,7 +44,7 @@ def main(self, *args: str) -> int:
             init_functions(Session())
 
         if args:
-            print("Unknown command {0!r}".format(args[0]))
+            print(f'Unknown command {args[0]!r}')
             return 1
         if not self.nested_command:
             self.help()

benchbuild/cli/project.py

@@ -74,7 +74,7 @@ def print_project(project: tp.Type[Project], limit: int) -> None:
     print(f'domain: {project.DOMAIN}')
     print('source:')
     for source in project.SOURCE:
-        num_versions = len(source.versions())
+        num_versions = len(list(source.versions()))
 
         print(' -', f'{source.remote}')
         print('  ', 'default:', source.default)
@@ -113,9 +113,7 @@ def print_projects(projects: ProjectIndex) -> None:
         if prj.GROUP not in grouped_by:
             grouped_by[prj.GROUP] = []
 
-        grouped_by[prj.GROUP].append(
-            "{name}/{group}".format(name=prj.NAME, group=prj.GROUP)
-        )
+        grouped_by[prj.GROUP].append(f'{prj.NAME}/{prj.GROUP}')
 
     project_column_width = max([
         len(f'{p.NAME}/{p.GROUP}') for p in projects.values()

benchbuild/cli/run.py

@@ -116,13 +116,11 @@ def print_summary(num_actions, failed, duration):
     """
     num_failed = len(failed)
     print(
-        """
+        f'''
 Summary:
-{num_total} actions were in the queue.
+{num_actions} actions were in the queue.
 {num_failed} actions failed to execute.
 
-This run took: {elapsed_time:8.3f} seconds.
-    """.format(
-            num_total=num_actions, num_failed=num_failed, elapsed_time=duration
-        )
+This run took: {duration:8.3f} seconds.
+    '''
     )

benchbuild/cli/slurm.py

@@ -51,7 +51,7 @@ def experiment_tag(self, description):
                 list=True,
                 requires=["--experiment"],
                 help="Run a group of projects under the given experiments")
-    def group(self, groups: tp.List[str]) -> None:  # type: ignore
+    def group(self, groups: tp.List[str]) -> None:
         """Run a group of projects under the given experiments"""
         self.group_args = groups