health: move to mypy

.github/workflows/pytype.yml → .github/workflows/mypy.yml

@@ -1,4 +1,4 @@
-name: Run pytype validation
+name: Run mypy validation
 
 on:
   push:
@@ -11,13 +11,13 @@ jobs:
     timeout-minutes: 20
     strategy:
       matrix:
-        python-version: ["3.9"]
+        python-version: ["3.12"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Run pytype verification
+      - name: Run mypy verification
         run: |
-          ./scripts/run_pytype.sh
+          ./scripts/run_mypy.sh

requirements/testing_without_asyncio.txt

@@ -1,4 +1,3 @@
 # pip install -r requirements/testing_without_asyncio.txt
 pytest>=6.2.5,<8.4        # https://github.com/tornadoweb/tornado/issues/3375
 pytest-cov>=3,<6
-black==22.8.0             # Until we drop Python 3.6 support, we have to stay with this version

requirements/tools.txt

@@ -0,0 +1,3 @@
+mypy==1.11.1
+flake8==6.0.0
+black==22.8.0             # Until we drop Python 3.6 support, we have to stay with this version

scripts/install_all_and_run_tests.sh

@@ -6,6 +6,10 @@
 script_dir=`dirname $0`
 cd ${script_dir}/..
 rm -rf ./slack_bolt.egg-info
+
+# Update pip to prevent warnings
+pip install -U pip
+
 # The package causes a conflict with moto
 pip uninstall python-lambda
 
@@ -32,10 +36,11 @@ else
     pip install -U -r requirements/testing.txt && \
     pip install -U -r requirements/adapter.txt && \
     pip install -U -r requirements/adapter_testing.txt && \
+    pip install -r requirements/tools.txt && \
     # To avoid errors due to the old versions of click forced by Chalice
     pip install -U pip click && \
     black slack_bolt/ tests/ && \
+    flake8 slack_bolt/ && flake8 examples/
     pytest && \
-    pip install "pytype==2022.12.15" && \
-    pytype slack_bolt/
+    mypy slack_bolt/
 fi

scripts/run_flake8.sh

@@ -3,5 +3,5 @@
 
 script_dir=$(dirname $0)
 cd ${script_dir}/.. && \
-  pip install "flake8==6.0.0" && \
+  pip install -r requirements/tools.txt && \
   flake8 slack_bolt/ && flake8 examples/

scripts/run_pytype.sh → scripts/run_mypy.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
-# ./scripts/run_pytype.sh
+# ./scripts/run_mypy.sh
 
 script_dir=$(dirname $0)
 cd ${script_dir}/.. && \
   pip install .
   pip install -r requirements/async.txt && \
   pip install -r requirements/adapter.txt && \
-  pip install "pytype==2022.12.15" && \
-  pytype slack_bolt/
+  pip install -r requirements/tools.txt && \
+  mypy slack_bolt/

scripts/run_tests.sh

@@ -14,17 +14,6 @@ then
   black slack_bolt/ tests/ && \
     pytest -vv $1
 else
-  if [ ${python_version:0:3} == "3.8" ]
-  then
-    # pytype's behavior can be different in older Python versions
-    black slack_bolt/ tests/ \
-      && pytest -vv \
-      && pip install -r requirements/adapter.txt \
-      && pip install -r requirements/adapter_testing.txt \
-      && pip install -U pip setuptools wheel \
-      && pip install -U pytype \
-      && pytype slack_bolt/
-  else
     black slack_bolt/ tests/ && pytest
   fi
 fi

slack_bolt/adapter/aiohttp/__init__.py

@@ -10,7 +10,7 @@ async def to_bolt_request(request: web.Request) -> AsyncBoltRequest:
     return AsyncBoltRequest(
         body=await request.text(),
         query=request.query_string,
-        headers=request.headers,
+        headers=request.headers,  # type: ignore[arg-type]
     )
 
 
@@ -33,7 +33,7 @@ async def to_aiohttp_response(bolt_resp: BoltResponse) -> web.Response:
                 value=c.value,
                 max_age=c.get("max-age"),
                 expires=c.get("expires"),
-                path=c.get("path"),
+                path=c.get("path"),  # type: ignore[arg-type]
                 domain=c.get("domain"),
                 secure=True,
                 httponly=True,

slack_bolt/adapter/asgi/aiohttp/__init__.py

@@ -1,5 +1,3 @@
-from slack_bolt.oauth.async_oauth_flow import AsyncOAuthFlow
-
 from slack_bolt.adapter.asgi.http_request import AsgiHttpRequest
 from slack_bolt.adapter.asgi.builtin import SlackRequestHandler
 
@@ -41,13 +39,11 @@
         )
 
     async def handle_installation(self, request: AsgiHttpRequest) -> BoltResponse:
-        oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
-        return await oauth_flow.handle_installation(
+        return await self.app.oauth_flow.handle_installation(  # type: ignore[union-attr]
             AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
         )
 
     async def handle_callback(self, request: AsgiHttpRequest) -> BoltResponse:
-        oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
-        return await oauth_flow.handle_callback(
+        return await self.app.oauth_flow.handle_callback(  # type: ignore[union-attr]
             AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
         )

slack_bolt/adapter/asgi/base_handler.py

@@ -1,4 +1,4 @@
-from typing import Callable, Dict
+from typing import Callable, Dict, Union
 
 from .http_request import AsgiHttpRequest
 from .http_response import AsgiHttpResponse
@@ -14,7 +14,7 @@
 
 
 class BaseSlackRequestHandler:
-    app: App  # type: ignore
+    app: Union[App, "AsyncApp"]  # type: ignore[name-defined]
     path: str
 
     async def dispatch(self, request: AsgiHttpRequest) -> BoltResponse:
@@ -37,13 +37,13 @@
                     return AsgiHttpResponse(
                         status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body
                     )
-                if path == self.app.oauth_flow.redirect_uri_path:
-                    bolt_response: BoltResponse = await self.handle_callback(request)
+                elif path == self.app.oauth_flow.redirect_uri_path:
+                    bolt_response = await self.handle_callback(request)
                     return AsgiHttpResponse(
                         status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body
                     )
         if method == "POST" and path == self.path:
-            bolt_response: BoltResponse = await self.dispatch(request)
+            bolt_response = await self.dispatch(request)
             return AsgiHttpResponse(status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body)
         return AsgiHttpResponse(status=404, headers={"content-type": ["text/plain;charset=utf-8"]}, body="Not Found")
 
@@ -60,12 +60,12 @@
     async def __call__(self, scope: scope_type, receive: Callable, send: Callable) -> None:
         if scope["type"] == "http":
             response: AsgiHttpResponse = await self._get_http_response(
-                scope["method"], scope["path"], AsgiHttpRequest(scope, receive)
+                method=scope["method"], path=scope["path"], request=AsgiHttpRequest(scope, receive)  # type: ignore[arg-type]
             )
             await send(response.get_response_start())
             await send(response.get_response_body())
             return
         if scope["type"] == "lifespan":
             await send(await self._handle_lifespan(receive))
             return
-        raise TypeError(f"Unsupported scope type: {scope['type']}")
+        raise TypeError(f"Unsupported scope type: {scope['type']!r}")

slack_bolt/adapter/asgi/builtin/__init__.py

@@ -1,4 +1,3 @@
-from slack_bolt.oauth.oauth_flow import OAuthFlow
 from slack_bolt.adapter.asgi.http_request import AsgiHttpRequest
 
 from slack_bolt import App
@@ -39,13 +38,11 @@
         )
 
     async def handle_installation(self, request: AsgiHttpRequest) -> BoltResponse:
-        oauth_flow: OAuthFlow = self.app.oauth_flow
-        return oauth_flow.handle_installation(
+        return self.app.oauth_flow.handle_installation(  # type: ignore[union-attr]
             BoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
         )
 
     async def handle_callback(self, request: AsgiHttpRequest) -> BoltResponse:
-        oauth_flow: OAuthFlow = self.app.oauth_flow
-        return oauth_flow.handle_callback(
+        return self.app.oauth_flow.handle_callback(  # type: ignore[union-attr]
             BoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
         )

slack_bolt/adapter/asgi/http_request.py

@@ -1,4 +1,4 @@
-from typing import Callable, Dict, Union
+from typing import Callable, Dict, Iterable, Sequence, Tuple, Union
 
 from .utils import scope_type, ENCODING
 
@@ -8,10 +8,10 @@ class AsgiHttpRequest:
 
     def __init__(self, scope: scope_type, receive: Callable):
         self.receive = receive
-        self.query_string = str(scope["query_string"], ENCODING)
-        self.raw_headers = scope["headers"]
+        self.query_string = str(scope["query_string"], ENCODING)  # type: ignore[arg-type]
+        self.raw_headers: Iterable[Tuple[bytes, bytes]] = scope["headers"]  # type: ignore[assignment]
 
-    def get_headers(self) -> Dict[str, str]:
+    def get_headers(self) -> Dict[str, Union[str, Sequence[str]]]:
         return {str(header[0], ENCODING): str(header[1], (ENCODING)) for header in self.raw_headers}
 
     async def get_raw_body(self) -> str:
@@ -22,7 +22,7 @@ async def get_raw_body(self) -> str:
             if chunk["type"] != "http.request":
                 raise Exception("Body chunks could not be received from asgi server")
 
-            chunks.extend(chunk.get("body", b""))
+            chunks.extend(chunk.get("body", b""))  # type: ignore[arg-type]
             if not chunk.get("more_body", False):
                 break
         return bytes(chunks).decode(ENCODING)

slack_bolt/adapter/aws_lambda/chalice_handler.py

@@ -2,7 +2,7 @@
 from os import getenv
 from typing import Optional
 
-from botocore.client import BaseClient
+from botocore.client import BaseClient  # type: ignore[import-untyped]
 
 from chalice.app import Request, Response, Chalice
 
@@ -29,7 +29,7 @@ def __init__(self, app: App, chalice: Chalice, lambda_client: Optional[BaseClien
                     LocalLambdaClient,
                 )
 
-                lambda_client = LocalLambdaClient(self.chalice, None)
+                lambda_client = LocalLambdaClient(self.chalice, None)  # type: ignore[arg-type]
             except ImportError:
                 logging.info("Failed to load LocalLambdaClient for CLI mode.")
                 pass
@@ -50,7 +50,7 @@ def clear_all_log_handlers(cls):
                 root.removeHandler(handler)
 
     def handle(self, request: Request):
-        body: str = request.raw_body.decode("utf-8") if request.raw_body else ""
+        body: str = request.raw_body.decode("utf-8") if request.raw_body else ""  # type: ignore[union-attr]
         self.logger.debug(f"Incoming request: {request.to_dict()}, body: {body}")
 
         method = request.method
@@ -72,7 +72,7 @@ def handle(self, request: Request):
                     bolt_resp = oauth_flow.handle_installation(bolt_req)
                     return to_chalice_response(bolt_resp)
         elif method == "POST":
-            bolt_req: BoltRequest = to_bolt_request(request, body)
+            bolt_req = to_bolt_request(request, body)
             # https://docs.aws.amazon.com/lambda/latest/dg/python-context.html
             aws_lambda_function_name = self.chalice.lambda_context.function_name
             bolt_req.context["aws_lambda_function_name"] = aws_lambda_function_name
@@ -81,7 +81,7 @@ def handle(self, request: Request):
             aws_response = to_chalice_response(bolt_resp)
             return aws_response
         elif method == "NONE":
-            bolt_req: BoltRequest = to_bolt_request(request, body)
+            bolt_req = to_bolt_request(request, body)
             bolt_resp = self.app.dispatch(bolt_req)
             aws_response = to_chalice_response(bolt_resp)
             return aws_response
@@ -92,16 +92,16 @@ def handle(self, request: Request):
 def to_bolt_request(request: Request, body: str) -> BoltRequest:
     return BoltRequest(
         body=body,
-        query=request.query_params,
-        headers=request.headers,
+        query=request.query_params,  # type: ignore[arg-type]
+        headers=request.headers,  # type: ignore[arg-type]
     )
 
 
 def to_chalice_response(resp: BoltResponse) -> Response:
     return Response(
         status_code=resp.status,
         body=resp.body,
-        headers=resp.first_headers(),
+        headers=resp.first_headers(),  # type: ignore[arg-type]
     )
 
 

slack_bolt/adapter/aws_lambda/chalice_lazy_listener_runner.py

@@ -2,8 +2,8 @@
 from logging import Logger
 from typing import Callable, Optional
 
-import boto3
-from botocore.client import BaseClient
+import boto3  # type: ignore[import-untyped]
+from botocore.client import BaseClient  # type: ignore[import-untyped]
 
 from slack_bolt import BoltRequest
 from slack_bolt.lazy_listener import LazyListenerRunner
@@ -20,7 +20,7 @@ def start(self, function: Callable[..., None], request: BoltRequest) -> None:
 
         chalice_request: dict = request.context["chalice_request"]
         request.headers["x-slack-bolt-lazy-only"] = ["1"]
-        request.headers["x-slack-bolt-lazy-function-name"] = [request.lazy_function_name]
+        request.headers["x-slack-bolt-lazy-function-name"] = [request.lazy_function_name]  # type: ignore[list-item]
         payload = {
             "method": "NONE",
             "headers": {k: v[0] for k, v in request.headers.items()},

slack_bolt/adapter/aws_lambda/handler.py

@@ -12,7 +12,7 @@
 
 
 class SlackRequestHandler:
-    def __init__(self, app: App):  # type: ignore
+    def __init__(self, app: App):
         self.app = app
         self.logger = get_bolt_app_logger(app.name, SlackRequestHandler, app.logger)
         self.app.listener_runner.lazy_listener_runner = LambdaLazyListenerRunner(self.logger)

slack_bolt/adapter/aws_lambda/lambda_s3_oauth_flow.py

@@ -3,7 +3,7 @@
 from logging import Logger
 from typing import Optional
 
-import boto3
+import boto3  # type: ignore[import-untyped]
 
 from slack_bolt.authorization.authorize import InstallationStoreAuthorize
 from slack_bolt.oauth import OAuthFlow

slack_bolt/adapter/aws_lambda/lazy_listener_runner.py

@@ -2,7 +2,7 @@
 from logging import Logger
 from typing import Callable, Optional, Any
 
-import boto3
+import boto3  # type: ignore[import-untyped]
 
 from slack_bolt import BoltRequest
 from slack_bolt.lazy_listener import LazyListenerRunner

slack_bolt/adapter/bottle/handler.py

@@ -1,4 +1,4 @@
-from bottle import Request, Response
+from bottle import Request, Response  # type: ignore[import-untyped]
 
 from slack_bolt.app import App
 from slack_bolt.oauth import OAuthFlow
@@ -25,7 +25,7 @@ def set_response(bolt_resp: BoltResponse, resp: Response) -> None:
 
 
 class SlackRequestHandler:
-    def __init__(self, app: App):  # type: ignore
+    def __init__(self, app: App):
         self.app = app
 
     def handle(self, req: Request, resp: Response) -> str:
@@ -41,7 +41,7 @@ def handle(self, req: Request, resp: Response) -> str:
                     set_response(bolt_resp, resp)
                     return bolt_resp.body or ""
         elif req.method == "POST":
-            bolt_resp: BoltResponse = self.app.dispatch(to_bolt_request(req))
+            bolt_resp = self.app.dispatch(to_bolt_request(req))
             set_response(bolt_resp, resp)
             return bolt_resp.body or ""
 

slack_bolt/adapter/cherrypy/handler.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-import cherrypy
+import cherrypy  # type: ignore[import-untyped]
 
 from slack_bolt.app import App
 from slack_bolt.oauth import OAuthFlow
@@ -55,7 +55,7 @@ def slack_processor(entity):
 
 
 class SlackRequestHandler:
-    def __init__(self, app: App):  # type: ignore
+    def __init__(self, app: App):
         self.app = app
 
     def handle(self) -> bytes:
@@ -73,7 +73,7 @@ def handle(self) -> bytes:
                     set_response_status_and_headers(bolt_resp)
                     return (bolt_resp.body or "").encode("utf-8")
         elif req.method == "POST":
-            bolt_resp: BoltResponse = self.app.dispatch(build_bolt_request())
+            bolt_resp = self.app.dispatch(build_bolt_request())
             set_response_status_and_headers(bolt_resp)
             return (bolt_resp.body or "").encode("utf-8")