Merge pull request #1246: Configure Pyright

docs/contribute/DEV_DOCS.md

@@ -149,9 +149,19 @@ During development you can run static type checks using [mypy][]:
     $ mypy
     # No output is good!
 
-There are also many [editor integrations for mypy][].
+and [pyright][]:
+
+    $ npx pyright
+    ...
+    Found 40 source files
+    0 errors, 0 warnings, 0 infos
+    Completed in 2sec
+
+There are also many [editor integrations for mypy][], and Pyright can be
+[configured for VS Code][].
 
 [editor integrations for mypy]: https://github.com/python/mypy#integrations
+[configured for VS Code]: https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance#settings-and-customization
 
 ### Removing features
 

pyrightconfig.json

@@ -0,0 +1,30 @@
+{
+  "pythonVersion": "3.8",
+  "include": ["augur/"],
+
+
+  // These are rules that are enabled by default and currently have violations.
+
+  // TODO: go through these exceptions and determine if they should be kept or
+  // removed and violations addressed.
+
+  // TODO: consider aligning this with the same file in nextstrain/cli:
+  // <https://github.com/nextstrain/cli/blob/-/pyrightconfig.json>
+  "reportArgumentType": false,
+  "reportAttributeAccessIssue": false,
+  "reportCallIssue": false,
+  "reportGeneralTypeIssues": false,
+  "reportIncompatibleMethodOverride": false,
+  "reportMissingImports": false,
+  "reportMissingModuleSource": false,
+  "reportOperatorIssue": false,
+  "reportOptionalIterable": false,
+  "reportOptionalMemberAccess": false,
+  "reportOptionalOperand": false,
+  "reportOptionalSubscript": false,
+  "reportPossiblyUnboundVariable": false,
+  "reportPrivateImportUsage": false,
+  "reportSelfClsParameterName": false,
+  "reportUndefinedVariable": false,
+  "reportUnusedExpression": false,
+}

tests/test_pyright.py

@@ -0,0 +1,22 @@
+import pytest
+from pathlib import Path
+from shutil import which
+from subprocess import run
+
+topdir = Path(__file__).resolve().parent.parent
+
+pyright = which("pyright")
+npx = which("npx")
+
+if pyright:
+    pyright = [pyright]
+elif npx:
+    pyright = [npx, "pyright"]
+else:
+    pyright = None
+
+@pytest.mark.skipif(not pyright, reason = "pyright is not available")
+def test_pyright():
+    # Check the exit status ourselves for nicer test output on failure
+    result = run(pyright, cwd = topdir)
+    assert result.returncode == 0, "pyright exited with errors"