add mypy support

Author: blink1073

.github/workflows/connect.py

@@ -13,7 +13,7 @@
         found = True
         break
     except URLError as e:
-        if e.reason.errno == errno.ECONNREFUSED:
+        if e.reason.errno == errno.ECONNREFUSED:  # type:ignore
             time.sleep(1)
             continue
         raise

.mypy.ini

@@ -0,0 +1,35 @@
+[mypy]
+check_untyped_defs = true
+disallow_incomplete_defs = true
+no_implicit_optional = true
+pretty = true
+show_error_context = true
+show_error_codes = true
+strict_equality = true
+strict_optional = true
+warn_no_return = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[mypy-black]
+ignore_missing_imports = True
+
+[mypy-jwt]
+ignore_missing_imports = True
+
+[mypy-git]
+ignore_missing_imports = True
+
+[mypy-keen]
+ignore_missing_imports = True
+
+[mypy-pytest]
+ignore_missing_imports = True
+
+[mypy-there]
+ignore_missing_imports = True
+
+[mypy-yieldbreaker]
+ignore_missing_imports = True

.pre-commit-config.yaml

@@ -36,6 +36,14 @@ repos:
     ]
     stages: [manual]
 
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: "v0.942"
+  hooks:
+  - id: mypy
+    args: ["--config-file", ".mypy.ini"]
+    additional_dependencies: [types-requests, types-PyYAML, types-mock, tornado]
+    stages: [manual]
+
 - repo: https://github.com/sirosen/check-jsonschema
   rev: 0.14.2
   hooks:

meeseeksdev/__init__.py

@@ -39,7 +39,7 @@
     "scikit-image",
 ]
 
-usr_denylist = []
+usr_denylist: list = []
 
 usr_allowlist = [
     "Carreau",
@@ -91,12 +91,12 @@ def load_config_from_env():
     """
     Load the configuration, for now stored in the environment
     """
-    config = {}
+    config: dict = {}
 
-    integration_id = os.environ.get("GITHUB_INTEGRATION_ID")
+    integration_id_str = os.environ.get("GITHUB_INTEGRATION_ID")
     botname = os.environ.get("GITHUB_BOT_NAME", None)
 
-    if not integration_id:
+    if not integration_id_str:
         raise ValueError("Please set GITHUB_INTEGRATION_ID")
 
     if not botname:
@@ -106,7 +106,7 @@ def load_config_from_env():
 
     botname = botname.replace("@", "")
     at_botname = "@" + botname
-    integration_id = int(integration_id)
+    integration_id = int(integration_id_str)
 
     if "B64KEY" in os.environ:
         config["key"] = base64.b64decode(bytes(os.environ["B64KEY"], "ASCII"))

meeseeksdev/commands.py

@@ -3,6 +3,7 @@
 """
 
 from textwrap import dedent
+from typing import Generator, Optional
 
 from .meeseeksbox.commands import tag, untag
 from .meeseeksbox.scopes import everyone, pr_author, write
@@ -49,7 +50,9 @@ def open(*, session, payload, arguments, local_config=None):
 
 
 @write
-def migrate_issue_request(*, session: Session, payload: dict, arguments: str, local_config=None):
+def migrate_issue_request(
+    *, session: Session, payload: dict, arguments: str, local_config: Optional[dict] = None
+) -> Generator:
     """[to] {org}/{repo}
 
     Need to be admin on target repo. Replicate all comments on target repo and close current on.

meeseeksdev/meeseeksbox/commands.py

@@ -11,6 +11,7 @@
 import traceback
 from pathlib import Path
 from textwrap import dedent
+from typing import Generator, Optional
 
 import git
 import mock
@@ -117,12 +118,12 @@ def _compute_pwd_changes(allowlist):
     print("== pwd", os.getcwd())
     print("== listdir", os.listdir())
 
-    for p in glob.glob("**/*.py", recursive=True):
-        print("=== scanning", p, p in allowlist)
-        if p not in allowlist:
+    for path in glob.glob("**/*.py", recursive=True):
+        print("=== scanning", path, path in allowlist)
+        if path not in allowlist:
             # we don't touch files not in this PR.
             continue
-        p = Path(p)
+        p = Path(path)
         old = p.read_text()
         new = black.format_str(old, mode=black.FileMode())
         if new != old:
@@ -309,7 +310,9 @@ def black_suggest(*, session, payload, arguments, local_config=None):
         print("== Done cleaning ")
 
 
-def prep_for_command(name, session, payload, arguments, local_config=None):
+def prep_for_command(
+    name: str, session: Session, payload: dict, arguments: str, local_config: Optional[dict] = None
+) -> Generator:
     """Prepare to run a command against a local checkout of a repo."""
     print(f"===== running command {name} =====")
     print("===== ============ =====")
@@ -335,8 +338,11 @@ def prep_for_command(name, session, payload, arguments, local_config=None):
     repo_name = pr_data["head"]["repo"]["name"]
     maintainer_can_modify = pr_data["maintainer_can_modify"]
 
+    print(f"Got author login {author_login}")
+
     # Check to see if we can successfully push changees to the PR.
     target_session = yield "{}/{}".format(author_login, repo_name)
+
     if target_session:
         print("installed on target repository")
         atk = target_session.token()
@@ -429,7 +435,9 @@ def push_the_work(session, payload, arguments, local_config=None):
 
 
 @admin
-def precommit(*, session, payload, arguments, local_config=None):
+def precommit(
+    *, session: Session, payload: dict, arguments: str, local_config: Optional[dict] = None
+) -> Generator:
     comment_url = payload["issue"]["comments_url"]
 
     """Run pre-commit against a PR and push the changes."""
@@ -602,12 +610,13 @@ def safe_backport(session, payload, arguments, local_config=None):
 
     print = lambda *args, **kwargs: builtins.print("    [backport]", *args, **kwargs)
 
-    s_clone_time = 0
+    s_clone_time = 0.0
     s_success = False
     s_reason = "unknown"
-    s_fork_time = 0
-    s_clean_time = 0
-    s_ff_time = 0
+    s_fork_time = 0.0
+    s_clean_time = 0.0
+    s_ff_time = 0.0
+    s_slug = ""
 
     def keen_stats():
         nonlocal s_slug
@@ -816,7 +825,7 @@ def keen_stats():
         print("== All has been fetched correctly")
 
         print("Cherry-picking %s" % merge_sha)
-        args = ("-x", "-m", "1", merge_sha)
+        args: tuple = ("-x", "-m", "1", merge_sha)
 
         msg = "Backport PR #%i: %s" % (prnumber, prtitle)
         remote_submit_branch = f"auto-backport-of-pr-{prnumber}-on-{target_branch}"
@@ -925,7 +934,10 @@ def keen_stats():
             session.post_comment(
                 comment_url, "Hum, I actually crashed, that should not have happened."
             )
-            print("\n" + e.stderr.decode("utf8", "replace"), file=sys.stderr)
+            if hasattr(e, "stderr"):
+                print(
+                    "\n" + e.stderr.decode("utf8", "replace"), file=sys.stderr
+                )  # type:ignore[attr-defined]
             print("\n" + repo.git.status(), file=sys.stderr)
             add_event("error", {"git_crash": 1})
             s_reason = "Unknown error line 501"
@@ -1133,7 +1145,9 @@ def untag(session, payload, arguments, local_config=None):
 
 
 @write
-def migrate_issue_request(*, session: Session, payload: dict, arguments: str, local_config=None):
+def migrate_issue_request(
+    *, session: Session, payload: dict, arguments: str, local_config: Optional[dict] = None
+) -> Generator:
     """Todo:
 
     - Works through pagination of comments

meeseeksdev/meeseeksbox/core.py

@@ -4,7 +4,9 @@
 import json
 import re
 import time
+from asyncio import Future
 from concurrent.futures import ThreadPoolExecutor as Pool
+from typing import Optional
 
 import tornado.httpserver
 import tornado.ioloop
@@ -26,7 +28,7 @@
 
 class Config:
     botname = None
-    integration_id = None
+    integration_id = -1
     key = None
     botname = None
     at_botname = None
@@ -79,7 +81,7 @@ def _strip_extras(c):
     return c
 
 
-def process_mentionning_comment(body, bot_re):
+def process_mentioning_comment(body: str, bot_re: re.Pattern) -> list:
     """
     Given a comment body and a bot name parse this into a tuple of (command, arguments)
     """
@@ -233,7 +235,7 @@ def mention_bot_re(self):
         botname = self.config.botname
         return re.compile("@?" + re.escape(botname) + r"(?:\[bot\])?", re.IGNORECASE)
 
-    def dispatch_action(self, type_, payload):
+    def dispatch_action(self, type_: str, payload: dict) -> Future:
         botname = self.config.botname
         repo = payload.get("repository", {}).get("full_name", red + "<unknown repo>" + normal)
         # new issue/PR opened
@@ -349,13 +351,13 @@ def dispatch_action(self, type_, payload):
                         milestone = is_pr.get("milestone", {})
                         if milestone:
                             description.append(milestone.get("description", "") or "")
-                        description = "\n".join(description)
+                        description_str = "\n".join(description)
                         if "on-merge:" in description and is_pr["base"]["ref"] in (
                             "master",
                             "main",
                         ):
                             did_backport = False
-                            for description_line in description.splitlines():
+                            for description_line in description_str.splitlines():
                                 line = description_line.strip()
                                 if line.startswith("on-merge:"):
                                     todo = line[len("on-merge:") :].strip()
@@ -381,6 +383,7 @@ def dispatch_action(self, type_, payload):
             else:
                 pass
                 # print(f"({repo}) can't deal with `{type_}` yet")
+        return self.finish()
 
     # def _action_allowed(args):
     #     """
@@ -393,7 +396,7 @@ def dispatch_action(self, type_, payload):
     #       - If pull-request, the requester is the author.
     #     """
 
-    def dispatch_on_mention(self, body, payload, user):
+    def dispatch_on_mention(self, body: str, payload: dict, user: str) -> None:
         """
         Core of the logic that let people require actions from the bot.
 
@@ -445,7 +448,7 @@ def dispatch_on_mention(self, body, payload, user):
             print(user, "is legitimate author of this PR, letting commands go through")
 
         permission_level = session._get_permission(org, repo, user)
-        command_args = process_mentionning_comment(body, self.mention_bot_re)
+        command_args = process_mentioning_comment(body, self.mention_bot_re)
         for (command, arguments) in command_args:
             print("    :: treating", command, arguments)
             add_event(