ci: add infrastructure for generating custom stubs

.pylintrc

@@ -29,7 +29,10 @@ disable=
 
 [MASTER]
 ignore=
-    conf.py
+    conf.py,
+    sympy
+ignore-patterns=
+    .*\.pyi
 
 [TYPECHECK]
 ignored-modules=

.vscode/settings.json

@@ -63,9 +63,8 @@
   "rewrap.wrappingColumn": 79,
   "search.exclude": {
     "**/tests/**/__init__.py": true,
-    "docs/tox.ini": true,
-    "reqs/3.*/*.txt": true,
-    "tests/tox.ini": true
+    "*/tox.ini": true,
+    "reqs/3.*/*.txt": true
   },
   "telemetry.enableCrashReporter": false,
   "telemetry.enableTelemetry": false,

cspell.json

@@ -42,7 +42,8 @@
         "requirements*.txt",
         "setup.cfg",
         "setup.py",
-        "tox.ini"
+        "tox.ini",
+        "typings"
     ],
     "language": "en-US",
     "words": [

pyrightconfig.json

@@ -6,6 +6,5 @@
   "reportUnusedClass": true,
   "reportUnusedFunction": true,
   "reportUnusedImport": true,
-  "reportUnusedVariable": true,
-  "stubPath": ""
+  "reportUnusedVariable": true
 }

setup.cfg

@@ -75,6 +75,8 @@ files =
 check_untyped_defs = True
 disallow_incomplete_defs = False
 disallow_untyped_defs = False
+[mypy-typings.*]
+ignore_errors = True
 
 ; https://github.com/ComPWA/tensorwaves/issues/125
 [mypy-matplotlib.*]

tox.ini

@@ -125,6 +125,7 @@ filename =
 exclude =
     __pycache__
     docs/conf.py
+    typings/**
 ignore = # more info: https://www.flake8rules.com/
     E203 # https://github.com/psf/black#slices
     E231 # allowed by black

typings/.gitignore

@@ -0,0 +1,2 @@
+*.pyi
+/*/

typings/README.md

@@ -0,0 +1,17 @@
+# Stubs for external libraries
+
+To speed up linting and code navigation, it's often useful to generate
+[stub files](https://mypy.readthedocs.io/en/stable/stubs.html) (`.pyi` files)
+for the external libraries. You can do this using
+[`stubgen`](https://mypy.readthedocs.io/en/stable/stubgen.html). For instance:
+
+```shell
+stubgen -p tensorflow -o typings
+```
+
+Alternatively, use [Pyright](https://github.com/microsoft/pyright) to generate
+stub files that contain docstrings as well:
+
+```shell
+pyright --createstub tensorflow
+```

typings/tox.ini

@@ -0,0 +1,4 @@
+; ignore all pydocstyle errors in this folder
+
+[pydocstyle]
+add_ignore = D