Make mypy tests pass (#190)

Author: torcolvin

.github/workflows/verify_python.sh

@@ -1,19 +1,34 @@
-#!/bin/bash -e
+#!/bin/bash
+set -eu -o pipefail
 
-python3 -m venv venv
-source ./venv/bin/activate
-pip install --upgrade pip
-pip install mypy
-pip install pytest pytest-asyncio
-pip install types-requests types-Deprecated types-tqdm types-paramiko types-netifaces types-psutil click
-pip install ./client
-echo "Checking tests files..."
-python -m mypy tests --exclude=venv
+VENV_DIR=".venv-typing"
+
+function create_venv() {
+    uv venv ${VENV_DIR}
+    source ./${VENV_DIR}/bin/activate
+}
+
+function cleanup_venv() {
+    deactivate
+    rm -rf ${VENV_DIR}
+}
+
+create_venv
+uv pip install "./client[dev]"
 echo "Checking client files (including smoke tests)..."
-python -m mypy client --exclude=venv
+${VENV_DIR}/bin/python -m mypy client
+echo "Checking tests files..."
+python -m mypy tests
+cleanup_venv
+
+create_venv
+uv pip install -r ./environment/aws/requirements.txt
 echo "Checking environment setup..."
-python -m mypy environment --exclude=venv --explicit-package-bases --check-untyped-defs
+python -m mypy environment --explicit-package-bases
+cleanup_venv
+
+create_venv
+uv pip install -r jenkins/pipelines/requirements.txt
 echo "Checking Jenkins pipelines..."
-python -m mypy jenkins --exclude=venv --explicit-package-bases
-deactivate
-rm -rf venv
+python -m mypy jenkins --explicit-package-bases
+cleanup_venv

.gitignore

@@ -4,6 +4,7 @@
 # python
 __pycache__
 venv
+.venv*
 .mypy_cache
 .pytest_cache
 

client/pyproject.toml

@@ -63,6 +63,10 @@ dependencies = [
     "yarl==1.18.3",
     "zipp==3.21.0",
 ]
+[project.optional-dependencies]
+dev = [
+    "mypy==1.15.0",
+]
 
 [project.urls]
 "Homepage" = "https://github.com/couchbaselabs/couchbase-lite-tests"

client/requirements.txt

@@ -1,3 +1,4 @@
+PyNaCl==1.5.0
 bcrypt==4.2.1
 certifi==2024.12.14
 cffi==1.17.1
@@ -6,12 +7,16 @@ click==8.1.8
 colorama==0.4.6
 cryptography==44.0.0
 idna==3.10
+mypy==1.15.0
 netifaces==0.11.0
 paramiko==3.5.0
 psutil==7.0.0
 pycparser==2.22
-PyNaCl==1.5.0
 requests==2.32.3
 tdqm==0.0.1
 tqdm==4.67.1
+types-netifaces==0.11.0.20241025
+types-paramiko==3.5.0.20250516
+types-psutil==7.0.0.20250516
+types-tqdm==4.67.0.20250516
 urllib3==2.3.0

environment/aws/requirements.txt

@@ -0,0 +1,7 @@
+click==8.2.0
+mypy==1.5.0
+requests==2.32.3
+types-paramiko==3.5.0.20250516
+tqdm==4.67.1
+types-requests==2.32.0.20250515
+types-tqdm==4.67.0.20250516

jenkins/pipelines/requirements.txt

@@ -2,6 +2,10 @@
 lint.extend-select = ["I"]
 lint.ignore = ["E402"]
 
+[tool.mypy]
+check_untyped_defs = true
+exclude = "conftest.py" # Exclude conftest.py, since these are duplicated across several test files
+
 [[tool.mypy.overrides]]
-module = ["couchbase.*", "opentelemetry.exporter.*", "opentelemetry.sdk.*"]
+module = "couchbase.*"
 ignore_missing_imports = true