summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2021-10-06 20:26:34 +0100
committerDavid Robertson <davidr@element.io>2021-10-06 20:26:34 +0100
commite4a27c1524542ae75b0697dc5815c987e7de3a47 (patch)
tree510361409a603b90a21d9217c716e23eb02fed40
parentPillow has type stubs (diff)
downloadsynapse-e4a27c1524542ae75b0697dc5815c987e7de3a47.tar.xz
Comment about the possibility of stubs existing
-rw-r--r--mypy.ini7
1 files changed, 7 insertions, 0 deletions
diff --git a/mypy.ini b/mypy.ini
index 0ae2b894a9..76b29205f9 100644
--- a/mypy.ini
+++ b/mypy.ini
@@ -192,6 +192,13 @@ disallow_untyped_defs = True
 [mypy-tests.storage.test_user_directory]
 disallow_untyped_defs = True
 
+;; Dependencies without annotations
+;; Before ignoring a module, check to see if type stubs are available.
+;; The `typeshed` project maintains stubs here:
+;;     https://github.com/python/typeshed/tree/master/stubs
+;; and for each pacakge `foo` there's a corresponding `types-foo` package on PyPI,
+;; which we can pull in as a dev dependency by adding to `setup.py`'s
+;; `CONDITIONAL_REQUIREMENTS["mypy"]` list.
 
 [mypy-authlib.*]
 ignore_missing_imports = True