Add basedpyright support (#1152)

* Add basedpyright support

* Lint

* Deduplicate yarn lock

* Lower basedpyright priority to meet test assumptions

Author: krassowski

atest/_fixtures/overrides.json

@@ -4,6 +4,9 @@
   },
   "@jupyter-lsp/jupyterlab-lsp:plugin": {
     "language_servers": {
+      "basedpyright": {
+        "priority": 40
+      },
       "pylsp-with-override-json": {
         "serverSettings": {
           "pylsp.plugins.flake8.enabled": true,

atest/suites/01_Editor.robot

@@ -73,6 +73,11 @@ Python (pyright)
     Editor Shows Features for Server    pyright    Python    example.py    Diagnostics=is not defined (Pyright)
     ...    Jump to Definition=${def}
 
+Python (basedpyright)
+    ${def} =    Set Variable    lastToken:fib
+    Editor Shows Features for Server    basedpyright    Python    example.py    Diagnostics=is not defined (basedpyright)
+    ...    Jump to Definition=${def}
+
 R
     ${def} =    Set Variable    lastToken:fib
     Editor Shows Features for Language    R    example.R    Diagnostics=Put spaces around all infix operators

python_packages/jupyter_lsp/jupyter_lsp/specs/__init__.py

@@ -3,6 +3,7 @@
 
 # flake8: noqa: F401
 
+from .basedpyright import BasedPyrightLanguageServer
 from .bash_language_server import BashLanguageServer
 from .dockerfile_language_server_nodejs import DockerfileLanguageServerNodeJS
 from .javascript_typescript_langserver import JavascriptTypescriptLanguageServer
@@ -22,6 +23,7 @@
 from .vscode_json_languageserver import VSCodeJSONLanguageServer
 from .yaml_language_server import YAMLLanguageServer
 
+basedpyright = BasedPyrightLanguageServer()
 bash = BashLanguageServer()
 css = VSCodeCSSLanguageServer()
 dockerfile = DockerfileLanguageServerNodeJS()

python_packages/jupyter_lsp/jupyter_lsp/specs/basedpyright.py

@@ -0,0 +1,23 @@
+from .config import load_config_schema
+from .utils import ShellSpec
+
+
+class BasedPyrightLanguageServer(ShellSpec):
+    key = "basedpyright"
+    cmd = "basedpyright-langserver"
+    args = ["--stdio"]
+    languages = ["python"]
+    spec = dict(
+        display_name=key,
+        mime_types=["text/python", "text/x-ipython"],
+        urls=dict(
+            home="https://github.com/DetachHead/basedpyright",
+            issues="https://github.com/DetachHead/basedpyright/issues",
+        ),
+        install=dict(
+            pip="pip install basedpyright",
+            conda="conda install -c conda-forge basedpyright",
+        ),
+        config_schema=load_config_schema(key),
+        requires_documents_on_disk=False,
+    )

python_packages/jupyter_lsp/jupyter_lsp/specs/config/basedpyright.schema.json

@@ -230,7 +230,7 @@
         },
         "reportOptionalOperand": {
           "type": "string",
-          "description": "Diagnostics for an attempt to use an Optional type as an operand to a binary or unary operator (like '+', '==', 'or', 'not').",
+          "description": "Diagnostics for an attempt to use an Optional type as an operand to a binary or unary operator (like '+', '<<', '~').",
           "default": "error",
           "enum": ["none", "information", "warning", "error"]
         },
@@ -474,6 +474,12 @@
           "default": "error",
           "enum": ["none", "information", "warning", "error"]
         },
+        "reportUnhashable": {
+          "type": "string",
+          "description": "Diagnostics for the use of an unhashable object in a container that requires hashability.",
+          "default": "error",
+          "enum": ["none", "information", "warning", "error"]
+        },
         "reportUnsupportedDunderAll": {
           "type": "string",
           "description": "Diagnostics for unsupported operations performed on __all__.",
@@ -516,6 +522,12 @@
           "default": "none",
           "enum": ["none", "information", "warning", "error"]
         },
+        "reportUnreachable": {
+          "type": "string",
+          "description": "Diagnostics for code that is determined by type analysis to be unreachable.",
+          "default": "none",
+          "enum": ["none", "information", "warning", "error"]
+        },
         "reportShadowedImports": {
           "type": "string",
           "description": "Diagnostics for files that are overriding a module in the stdlib.",
@@ -538,8 +550,8 @@
     },
     "python.analysis.typeCheckingMode": {
       "type": "string",
-      "default": "basic",
-      "enum": ["off", "basic", "strict"],
+      "default": "standard",
+      "enum": ["off", "basic", "standard", "strict"],
       "description": "Defines the default rule set for type checking.",
       "scope": "resource"
     },
@@ -576,6 +588,12 @@
       "description": "Disables the “Organize Imports” command.",
       "scope": "resource"
     },
+    "pyright.disablePullDiagnostics": {
+      "type": "boolean",
+      "default": false,
+      "description": "Disables the use of pull diagnostics.",
+      "scope": "machine"
+    },
     "python.pythonPath": {
       "type": "string",
       "default": "python",

python_packages/jupyter_lsp/jupyter_lsp/specs/config/pyright.schema.json

@@ -37,6 +37,7 @@ etc/jupyter/jupyter_server_config.d = jupyter_lsp/etc/jupyter-lsp-jupyter-server
 
 [options.entry_points]
 jupyter_lsp_spec_v1 =
+    basedpyright = jupyter_lsp.specs:basedpyright
     bash-language-server = jupyter_lsp.specs:bash
     dockerfile-language-server-nodejs = jupyter_lsp.specs:dockerfile
     javascript-typescript-langserver = jupyter_lsp.specs:ts_old

python_packages/jupyter_lsp/setup.cfg

@@ -2,7 +2,7 @@
 -r ./utest.txt
 -r ./atest.txt
 packaging
-pyls-black
-pyls-isort
-pyls-mypy
+python-lsp-server
+python-lsp-black
+pylsp-mypy
 ruamel.yaml

requirements/dev.txt

@@ -13,6 +13,7 @@ dependencies:
   - nodejs {nodejs}
   # for python language server (and development)
   - python-lsp-server >=1.7.4
+  - basedpyright
   - flake8
   - autopep8
   - pyflakes