health: move to mypy (#1130)

* feat: use mypy instead of pytype

* Minimal improvements

* Improve error surfacing

* Improve configuration and imports ignores

* revert optional installation_store_bot_only

* Add proper exception raising

* Revert assert statements

* Improve based on feedback

* Improve error surfacing

Author: WilliamBergamin

.github/workflows/pytype.yml .github/workflows/mypy.yml.github/workflows/pytype.yml renamed to .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

pyproject.toml

@@ -50,3 +50,8 @@ filterwarnings = [
 	"ignore:The loop argument is deprecated since Python 3.8, and scheduled for removal in Python 3.10.:DeprecationWarning",
 ]
 asyncio_mode = "auto"
+
+[tool.mypy]
+files = "slack_bolt/"
+force_union_syntax = true
+warn_unused_ignores = true

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 --config-file pyproject.toml
 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.shscripts/run_pytype.sh renamed to 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 --config-file pyproject.toml

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 dispatch(self, request: AsgiHttpRequest) -> BoltResponse:
         )
 
     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())
         )