From 6a3a9959124c185b9e881ad5cd79fdc6c93dfc29 Mon Sep 17 00:00:00 2001
From: Ivaylo Bratoev <ivaylo.bratoev@gmail.com>
Date: Mon, 6 May 2024 23:58:33 +0300
Subject: [PATCH] Rewrite mypy precommit hook

The existing `pre-commit/mirrors-mypy` works by checking individual files and ignoring imports. This is against the whole idea of mypy and limits its benefits. Reimplement the hook to run mypy on all the files in an isolated environment. More on the topic:
* https://github.com/python/mypy/issues/13916
* https://jaredkhan.com/blog/mypy-pre-commit

Additionally:
* Move all the mypy config to pyproject.toml.
* Lock the version of mypy.
* Add types-PyYAML to dev requirements.
* Ignore all `.venv*` folders to support using multiple venvs for different python versions.
* Run pre-commit mypy during PR lint CI and ignore errors as fixes are in progress.
* Disable the mypy pre-commit hook until it is fixed.
* Add __init__.py to the examples/chat_with_your_documents folder to make it a package for mypy.
---
 .github/workflows/pr.yml                      |  3 ++
 .gitignore                                    |  2 +-
 .pre-commit-config.yaml                       | 37 ++++++++-----------
 bin/run-mypy.sh                               |  7 ++++
 examples/chat_with_your_documents/__init__.py |  0
 pyproject.toml                                |  5 +++
 requirements_dev.txt                          |  2 +
 7 files changed, 33 insertions(+), 23 deletions(-)
 create mode 100755 bin/run-mypy.sh
 create mode 100644 examples/chat_with_your_documents/__init__.py

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
index 3e3d52ec4ca..37c934583bf 100644
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -99,3 +99,6 @@ jobs:
           pre-commit run --all-files flake8
           pre-commit run --all-files prettier
           pre-commit run --all-files check-yaml
+
+          # mypy issues fixes are in progress so, for now, ignore errors
+          pre-commit run --all-files mypy || true
diff --git a/.gitignore b/.gitignore
index 77624de8434..27c336caa16 100644
--- a/.gitignore
+++ b/.gitignore
@@ -24,7 +24,7 @@ server.htpasswd
 server.authz
 server.authn
 
-.venv
+.venv*
 venv
 .env
 .chroma
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 84acf2f471b..4660ad69f74 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -31,30 +31,23 @@ repos:
           - "--extend-ignore=E203,E501,E503"
           - "--max-line-length=88"
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.2.0"
+  - repo: local
     hooks:
       - id: mypy
-        args:
-          [
-            --strict,
-            --ignore-missing-imports,
-            --follow-imports=silent,
-            --disable-error-code=type-abstract,
-            --config-file=./pyproject.toml,
-          ]
-        additional_dependencies:
-          [
-            "types-requests",
-            "pydantic",
-            "overrides",
-            "hypothesis",
-            "pytest",
-            "pypika",
-            "numpy",
-            "types-protobuf",
-            "kubernetes",
-          ]
+        name: mypy
+        entry: "./bin/run-mypy.sh"
+        language: python
+        stages: [manual] # run manually for all issues are fixed
+        pass_filenames: false
+        # use your preferred Python version
+        language_version: python3.12
+        # trigger for commits changing Python files
+        types_or: [python, toml]
+        # use require_serial so that script
+        # is only called once per commit
+        require_serial: true
+        # print the number of files as a sanity-check
+        verbose: true
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.1.0"
diff --git a/bin/run-mypy.sh b/bin/run-mypy.sh
new file mode 100755
index 00000000000..d3c2533ebda
--- /dev/null
+++ b/bin/run-mypy.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+pip install -r requirements.txt -r requirements_dev.txt --no-input --quiet
+
+mypy .
diff --git a/examples/chat_with_your_documents/__init__.py b/examples/chat_with_your_documents/__init__.py
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/pyproject.toml b/pyproject.toml
index 8e5c29527e2..2477ec41d2e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -55,6 +55,11 @@ pythonpath = ["."]
 
 [tool.mypy]
 ignore_errors = false
+disable_error_code = "type-abstract"
+ignore_missing_imports = false
+strict = false # disable strict mypy checks until we can fix all the errors
+exclude = "bin/.*"
+plugins = "numpy.typing.mypy_plugin"
 
 [[tool.mypy.overrides]]
 module = ["chromadb.proto.*"]
diff --git a/requirements_dev.txt b/requirements_dev.txt
index 4df73fb8c56..f32f3999a5f 100644
--- a/requirements_dev.txt
+++ b/requirements_dev.txt
@@ -4,10 +4,12 @@ grpcio-tools
 httpx
 hypothesis<=6.98.9 # > Than this version has API changes we don't currently support
 hypothesis[numpy]<=6.98.9
+mypy==1.10.0
 mypy-protobuf
 pre-commit
 pytest
 pytest-asyncio
 setuptools_scm
 types-protobuf
+types-PyYAML
 types-requests==2.30.0.0