qa: Better typing annotation in context and commands.pr_add

pyproject.toml

@@ -14,6 +14,10 @@ skip = [
     "docs/conf.py",
 ]
 
+[tool.mypy]
+show_error_codes = true
+
+
 [tool.pylint.MASTER]
 load-plugins = [
     "pylint_strict_informational",

src/cogite/backends/__init__.py

@@ -1,2 +1,3 @@
+from .base import BaseClient
 from .github import GitHubApiClient
 from .github import GitHubOAuthDeviceFlowTokenGetter

src/cogite/commands/pr_add.py

@@ -3,6 +3,7 @@
 import typing
 
 from cogite import completion
+from cogite import context
 from cogite import errors
 from cogite import git
 from cogite import interaction
@@ -12,23 +13,23 @@
 from . import helpers
 
 
-def add_draft_pull_request(context, **kwargs):
-    return add_pull_request(context, draft=True, **kwargs)
+def add_draft_pull_request(ctx: context.Context, **kwargs):
+    return add_pull_request(ctx, draft=True, **kwargs)
 
 
-def add_pull_request(context, *, base_branch, draft=False):
-    client = context.client
-    configuration = context.configuration
+def add_pull_request(ctx: context.Context, *, base_branch: str, draft: bool=False):
+    client = ctx.client
+    configuration = ctx.configuration
     base_branch = base_branch or configuration.master_branch
 
-    helpers.assert_current_branch_is_feature_branch(context.branch, configuration.master_branch)
+    helpers.assert_current_branch_is_feature_branch(ctx.branch, configuration.master_branch)
 
-    _git_push_to_origin(context.branch)
+    _git_push_to_origin(ctx.branch)
 
     commits_text = os.linesep.join(
         itertools.chain.from_iterable(
             (commit, '', '')
-            for commit in git.get_commits_logs(base_branch, context.branch)
+            for commit in git.get_commits_logs(base_branch, ctx.branch)
         )
     )
 
@@ -64,7 +65,7 @@ def add_pull_request(context, *, base_branch, draft=False):
     ) as sp:
         try:
             pr = client.create_pull_request(
-                head=context.branch,
+                head=ctx.branch,
                 base=base_branch,
                 title=title.strip(),
                 body=body.strip(),

src/cogite/completion.py

@@ -1,5 +1,5 @@
 import re
-from typing import List
+from typing import Iterable
 
 import prompt_toolkit
 import prompt_toolkit.completion
@@ -13,7 +13,7 @@
 
 
 class UserCompleter(prompt_toolkit.completion.Completer):
-    def __init__(self, users: List[models.User]):
+    def __init__(self, users: Iterable[models.User]):
         self.users = users
 
     def get_completions(self, document, complete_event):
@@ -28,7 +28,7 @@ def get_completions(self, document, complete_event):
                 )
 
 
-def prompt_for_users(users: List[models.User]):
+def prompt_for_users(users: Iterable[models.User]):
     while True:
         completer = UserCompleter(users)
         response = prompt_toolkit.prompt(

src/cogite/context.py

@@ -2,6 +2,8 @@
 import re
 import urllib.parse
 
+from cogite import backends
+from cogite import config
 from cogite import errors
 from cogite import git
 
@@ -18,8 +20,8 @@ class Context:
     branch: str
 
     # Injected from `cli._main()`
-    client = None
-    configuration = None
+    client: backends.BaseClient
+    configuration: config.Configuration
 
     def as_dict(self):
         return dict(self.__dict__)  # copy, except for `client` and `configuration`
@@ -54,4 +56,10 @@ def get_context() -> Context:
         owner=owner,
         repository=repository,
         branch=git.get_current_branch(),
+        # `client` and `configuration` will be overriden with proper
+        # values in `cli._main()`. We provide dummy values to avoid
+        # having to set `Context.client` and `Context.configuration`
+        # as Optional, because they are not.
+        client="dummy",  # type: ignore[arg-type]
+        configuration="dummy",  # type: ignore[arg-type]
     )

tests/test_github.py

@@ -30,6 +30,8 @@ def _make_client():
         owner="dummy_owner",
         repository="dummy_repository",
         branch="dummy_branch",
+        client="dummy",
+        configuration="dummy",
     )
     return github.GitHubApiClient(configuration, ctx)