Merge branch 'master' into fix-autoinvoke-on-dot

Author: krassowski

CHANGELOG.md

@@ -1,5 +1,13 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 2.1.2` (2020-12-XX)
+
+- bug fixes
+  - improved performance of completion and highlights by minimising the number of highlight requests and GUI redraws (token checking, debouncing, acting on a single response only) ([#433])
+  - highlights now update after cell focus/blur events even if those do not trigger cursor movement ([#433])
+
+[#433]: https://github.com/krassowski/jupyterlab-lsp/issues/433
+
 ### `@krassowski/jupyterlab-lsp 2.1.1` (2020-12-15)
 
 - bug fixes

atest/05_Features/Highlights.robot

@@ -0,0 +1,61 @@
+*** Settings ***
+Suite Setup       Setup Suite For Screenshots    highlights
+Test Setup        Setup Highlights Test
+Test Teardown     Clean Up After Working With File    Highlights.ipynb
+Force Tags        feature:highlights
+Resource          ../Keywords.robot
+
+*** Test Cases ***
+# cursor is symbolized by pipe (|), for example when
+# it is at the end of line, after `1` in `test = 1`
+# it is presented as: `test = 1|`
+Highlights work at the start of a token
+    Enter Cell Editor    1    line=1
+    Press Keys    None    END    # cursor to the end of first line (`test = 1|`)
+    Should Not Highlight Any Tokens
+    Press Keys    None    HOME    # cursor before the token (`|test = 1`)
+    Should Highlight Token    test
+    Should Not Highlight Token    gist
+
+Highlights work at the end of a token
+    Enter Cell Editor    1    line=1
+    Press Keys    None    END    # cursor to the end of first line (`test = 1|`)
+    Press Keys    None    DOWN    # cursor to the end of the token in second line (`test`)
+    Should Highlight Token    test
+    Should Not Highlight Token    gist
+
+Highlights are changed when moving cursor between cells
+    [Documentation]    GH431
+    Enter Cell Editor    1    line=2
+    Press Keys    None    END    # cursor after the token in second line (`test|`)
+    Should Highlight Token    test
+    Should Not Highlight Token    gist
+    Press Keys    None    DOWN    # cursor to next cell, which is empty
+    Should Not Highlight Any Tokens
+    Press Keys    None    DOWN    # cursor to third cell (`|gist = 1`)
+    Should Highlight Token    gist
+    Press Keys    None    DOWN    # cursor to third cell, second line (`|test `)
+    Should Highlight Token    test
+
+Highlights are added after typing
+    Enter Cell Editor    1    line=2
+    Should Highlight Token    test
+    Press Keys    None    a
+    Should Highlight Token    testa
+
+*** Keywords ***
+Should Not Highlight Any Tokens
+    Page Should Not Contain    css:.cm-lsp-highlight
+
+Should Highlight Token
+    [Arguments]    ${token}    ${timeout}=10s
+    ${token_element}    Set Variable    xpath://span[contains(@class, 'cm-lsp-highlight')][contains(text(), '${token}')]
+    Wait Until Page Contains Element    ${token_element}    timeout=${timeout}
+
+Should Not Highlight Token
+    [Arguments]    ${token}    ${timeout}=10s
+    ${token_element}    Set Variable    xpath://span[contains(@class, 'cm-lsp-highlight')][contains(text(), '${token}')]
+    Wait Until Page Does Not Contain Element    ${token_element}    timeout=${timeout}
+
+Setup Highlights Test
+    Setup Notebook    Python    Highlights.ipynb

atest/Keywords.robot

@@ -52,7 +52,7 @@ Create Notebok Server Config
 
 Read Page Config
     ${script} =    Get Element Attribute    id:jupyter-config-data    innerHTML
-    ${config} =    Evaluate    __import__("json").loads("""${script}""")
+    ${config} =    Evaluate    __import__("json").loads(r"""${script}""")
     Set Global Variable    ${PAGE CONFIG}    ${config}
     Set Global Variable    ${LAB VERSION}    ${config["appVersion"]}
 

atest/examples/Highlights.ipynb

@@ -0,0 +1,54 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "test = 1\n",
+    "test"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "gist = 1\n",
+    "test\n",
+    "gist\n",
+    "test"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

binder/environment.yml

@@ -2,7 +2,7 @@ name: jupyterlab-lsp
 
 channels:
   - conda-forge
-  - defaults
+  - nodefaults
 
 dependencies:
   # runtime dependencies
@@ -12,21 +12,14 @@ dependencies:
   # build dependencies
   - nodejs >=10.12,<15
   # for python language server (and development)
-  - black
   - flake8 >=3.5
-  # isort 5.0 has breaking API changes which affect (among others) pylint and nblint;
-  # the pin should be removed once https://github.com/PyCQA/pylint/pull/3725 is merged
-  # see https://github.com/krassowski/jupyterlab-lsp/pull/291
-  - isort <5
-  - mypy
   - pip
   - pylint
+  - pyls-black
+  - pyls-isort
+  - pyls-mypy
   - python-language-server
   - ruamel_yaml
-  - pip: # not-yet-appearing-in-conda-forge
-      - pyls-black
-      - pyls-isort
-      - pyls-mypy
   # for R language server and kernel
   - r
   - r-irkernel
@@ -36,3 +29,5 @@ dependencies:
   - tectonic
   - texlab
   - chktex
+  # TODO: remove when jedi vs IPython is resolved
+  - jedi <0.18

docs/Configuring.ipynb

@@ -175,17 +175,18 @@
    ]
   },
   {
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "#### virtual_documents_dir\n",
     "\n",
     "> default: os.getenv(\"JP_LSP_VIRTUAL_DIR\", \".virtual_documents\")\n",
     "\n",
     "Path to virtual documents relative to the content manager root directory.\n",
     "\n",
-    "Its default value can be set with `JP_LSP_VIRTUAL_DIR` environment variable and fallback to `.virtual_documents`."
-   ],
-   "cell_type": "markdown",
-   "metadata": {}
+    "Its default value can be set with `JP_LSP_VIRTUAL_DIR` environment variable and\n",
+    "fallback to `.virtual_documents`."
+   ]
   },
   {
    "cell_type": "markdown",
@@ -224,4 +225,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

packages/jupyterlab-lsp/package.json

@@ -29,13 +29,14 @@
   },
   "scripts": {
     "build": "jlpm build:schema && tsc -b",
-    "build:schema": "jlpm build:schema-backend && jlpm build:schema-completion && jlpm build:schema-hover && jlpm build:schema-diagnostics && jlpm build:schema-syntax_highlighting && jlpm build:schema-jump_to",
+    "build:schema": "jlpm build:schema-backend && jlpm build:schema-completion && jlpm build:schema-hover && jlpm build:schema-diagnostics && jlpm build:schema-syntax_highlighting && jlpm build:schema-jump_to && jlpm build:schema-highlights",
     "build:schema-backend": "json2ts ../../py_src/jupyter_lsp/schema/schema.json --unreachableDefinitions | prettier --stdin-filepath _schema.d.ts > src/_schema.d.ts",
     "build:schema-completion": "json2ts schema/completion.json | prettier --stdin-filepath _completion.d.ts > src/_completion.d.ts",
     "build:schema-hover": "json2ts schema/hover.json | prettier --stdin-filepath _hover.d.ts > src/_hover.d.ts",
     "build:schema-jump_to": "json2ts schema/jump_to.json | prettier --stdin-filepath _jump_to.d.ts > src/_jump_to.d.ts",
     "build:schema-diagnostics": "json2ts schema/diagnostics.json | prettier --stdin-filepath _diagnostics.d.ts > src/_diagnostics.d.ts",
     "build:schema-syntax_highlighting": "json2ts schema/syntax_highlighting.json | prettier --stdin-filepath _syntax_highlighting.d.ts > src/_syntax_highlighting.d.ts",
+    "build:schema-highlights": "json2ts schema/highlights.json | prettier --stdin-filepath _highlights.d.ts > src/_highlights.d.ts",
     "bundle": "npm pack .",
     "clean": "rimraf lib",
     "lab:link": "jupyter labextension link . --no-build",

packages/jupyterlab-lsp/schema/highlights.json

@@ -0,0 +1,16 @@
+{
+  "jupyter.lab.setting-icon": "lsp:highlight",
+  "jupyter.lab.setting-icon-label": "Language integration",
+  "title": "Code Highlights",
+  "description": "LSP highlights of the variable under the cursor settings.",
+  "type": "object",
+  "properties": {
+    "debouncerDelay": {
+      "title": "Debouncer delay",
+      "type": "number",
+      "default": 250,
+      "description": "Number of milliseconds to delay sending out the highlights request to the language server; you can get better responsiveness adjusting this value, but setting it to zero can actually slow it down as the server might get overwhelmed when moving the cursor."
+    }
+  },
+  "jupyter.lab.shortcuts": []
+}

packages/jupyterlab-lsp/schema/hover.json

@@ -16,7 +16,7 @@
       "title": "Throttler delay",
       "type": "number",
       "default": 50,
-      "description": "Number of milliseconds to delay sending out the request hover request to the language server; you can get better responsiveness adjusting this value, but setting it to zero can actually slow it down as the server might get overwhelmed when moving the mose over the code."
+      "description": "Number of milliseconds to delay sending out the hover request to the language server; you can get better responsiveness adjusting this value, but setting it to zero can actually slow it down as the server might get overwhelmed when moving the mouse over the code."
     },
     "cacheSize": {
       "title": "Cache size",