Fixed pygls v1.0 module import error (#868)

* Fixed pygls v1.0 module import error

* Clean up msg and add entry to changelog

* Improved version compare

* Updated pyproject.toml

* Updated isort version to 5.12.0

* Fixed mypy issue

* Removed poetry_core version constraint

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
           - pep8-naming
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.4
+    rev: 5.12.0
     hooks:
       - id: isort
 

docs/changelog.rst

@@ -12,6 +12,8 @@ License
 -----
 Released: under development
 
+* Bugfix: Fixed pygls version compatibility.
+
 1.2.0
 -----
 Released: 24.01.2023

pyproject.toml

@@ -74,6 +74,9 @@ pyparsing = "^3.0.9"  # 3.0.5 error: https://github.com/pyparsing/pyparsing/issu
 pytest-benchmark = "^4.0.0"
 memray = "^1.3.1"
 
+# package version compare, in case setuptools not available
+packaging = "*"
+
 [tool.pytest.ini_options]
 asyncio_mode= "auto"
 

sphinx_needs/lsp/esbonio.py

@@ -11,15 +11,30 @@
 from esbonio.lsp.rst import CompletionContext, DefinitionContext, HoverContext
 from esbonio.lsp.sphinx import SphinxLanguageServer
 from jinja2 import BaseLoader, Environment
-from pygls.lsp.types import (
-    CompletionItem,
-    CompletionItemKind,
-    InsertTextFormat,
-    Location,
-    Position,
-    Range,
-    TextEdit,
-)
+from packaging import version
+from pygls import __version__
+
+if version.parse(__version__) < version.parse("1.0"):
+    from pygls.lsp.types import (
+        CompletionItem,
+        CompletionItemKind,
+        InsertTextFormat,
+        Location,
+        Position,
+        Range,
+        TextEdit,
+    )
+else:
+    from lsprotocol.types import (  # type: ignore[no-redef]
+        CompletionItem,
+        CompletionItemKind,
+        InsertTextFormat,
+        Location,
+        Position,
+        Range,
+        TextEdit,
+    )
+
 from sphinx.application import Sphinx
 
 from sphinx_needs.lsp.needs_store import NeedsStore

tests/test_lsp/test_lsp.py

@@ -5,7 +5,13 @@
 
 import pytest
 import pytest_lsp
-from pygls.lsp.types import MarkupContent, MarkupKind, Position, Range
+from packaging import version
+from pygls import __version__
+
+if version.parse(__version__) < version.parse("1.0"):
+    from pygls.lsp.types import MarkupContent, MarkupKind, Position, Range
+else:
+    from lsprotocol.types import MarkupContent, MarkupKind, Position, Range
 
 TEST_DOC_ROOT_URI = os.path.join("file://", os.path.abspath(os.path.dirname(__file__)), "doc_example_lsp")
 TEST_FILE_URI = os.path.join(TEST_DOC_ROOT_URI, "index.rst")
@@ -18,6 +24,9 @@ async def client():
     pass
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_need_directive_role_completion(client):
     # check needs directive completion
@@ -202,6 +211,9 @@ async def test_need_directive_role_completion(client):
     assert need_role_need.data["source_feature"] == "sphinx_needs.lsp.esbonio.NeedlsFeatures"
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_need_auto_generated_id_completion(client):
     # check needs option id snippet, auto-generated need IDs, e.g. :id: REQ_e0bafd9b
@@ -222,6 +234,9 @@ async def test_need_auto_generated_id_completion(client):
     assert needs_option_id.kind == 15  # CompletionItemKind.Snippet
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_need_directive_snippets_completion(client):
     # check need directive snippets completion
@@ -244,6 +259,9 @@ async def test_need_directive_snippets_completion(client):
     assert need_directive_snippets_req.data["source_feature"] == "sphinx_needs.lsp.esbonio.NeedlsFeatures"
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_need_id_selection_completion(client):
     # check need ID selection completion for need type, e.g. :need:`->`
@@ -275,6 +293,9 @@ async def test_need_id_selection_completion(client):
     assert id_selection_need_id.data["source_feature"] == "sphinx_needs.lsp.esbonio.NeedlsFeatures"
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_goto_definition(client):
     # check goto defintion results
@@ -292,6 +313,9 @@ async def test_goto_definition(client):
     assert defined_location.range.end.character == 0
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_hover(client):
     # check hover results

tests/test_lsp/test_lsp_custom_directive_snippets.py

@@ -5,6 +5,8 @@
 
 import pytest
 import pytest_lsp
+from packaging import version
+from pygls import __version__
 
 TEST_DOC_ROOT_URI = os.path.join(
     "file://", os.path.abspath(os.path.dirname(__file__)), "doc_lsp_custom_directive_snippets"
@@ -35,6 +37,9 @@ async def client():
     pass
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_custom_directive_snippets(client):
     # check need custom directive snippets completion

tests/test_lsp/test_lsp_custom_need_id_generate_from_title.py

@@ -5,6 +5,8 @@
 
 import pytest
 import pytest_lsp
+from packaging import version
+from pygls import __version__
 
 TEST_DOC_ROOT_URI = os.path.join(
     "file://", os.path.abspath(os.path.dirname(__file__)), "doc_lsp_custom_need_id_generate_from_title"
@@ -19,6 +21,9 @@ async def client():
     pass
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_directive_snippets_with_custom_need_id_generate_from_title(client):
     need_directive_snippets = await client.completion_request(uri=TEST_FILE_URI, line=10, character=2)
@@ -36,6 +41,9 @@ async def test_directive_snippets_with_custom_need_id_generate_from_title(client
     assert need_directive_snippets_req.insert_text.startswith(" req:: ${1:title}\n\t:id: ${2:TEST_ID_TEST")
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_id_auto_generation_with_custom_id_generate_from_title(client):
     need_req_options_result = await client.completion_request(uri=TEST_FILE_URI, line=11, character=3)

tests/test_lsp/test_lsp_custom_need_id_generate_random.py

@@ -5,6 +5,8 @@
 
 import pytest
 import pytest_lsp
+from packaging import version
+from pygls import __version__
 
 TEST_DOC_ROOT_URI = os.path.join(
     "file://", os.path.abspath(os.path.dirname(__file__)), "doc_lsp_custom_need_id_generate_random"
@@ -19,6 +21,9 @@ async def client():
     pass
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_directive_snippets_with_custom_need_id_generate_random(client):
     need_directive_snippets = await client.completion_request(uri=TEST_FILE_URI, line=10, character=2)
@@ -37,6 +42,9 @@ async def test_directive_snippets_with_custom_need_id_generate_random(client):
     assert "_Test" in need_directive_snippets_req.insert_text
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_id_auto_generation_with_custom_id_generate_random(client):
     need_req_options_result = await client.completion_request(uri=TEST_FILE_URI, line=11, character=3)

tests/test_lsp/test_lsp_support_MyST.py

@@ -5,7 +5,13 @@
 
 import pytest
 import pytest_lsp
-from pygls.lsp.types import MarkupContent, MarkupKind, Position, Range
+from packaging import version
+from pygls import __version__
+
+if version.parse(__version__) < version.parse("1.0"):
+    from pygls.lsp.types import MarkupContent, MarkupKind, Position, Range
+else:
+    from lsprotocol.types import MarkupContent, MarkupKind, Position, Range
 
 TEST_DOC_ROOT_URI = os.path.join("file://", os.path.abspath(os.path.dirname(__file__)), "doc_lsp_support_MyST")
 TEST_MD_FILE_URI = os.path.join(TEST_DOC_ROOT_URI, "myfile.md")
@@ -18,6 +24,9 @@ async def client():
     pass
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_goto_definition_support_for_myst(client):
     # Check Goto Defintion support for MySt/Markdown file, e.g. myfile.md
@@ -62,6 +71,9 @@ async def test_lsp_goto_definition_support_for_myst(client):
     assert goto_rst_location.range.end.character == 0
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_hover_support_for_myst(client):
     # Check Hover support for MyST/Markdown file
@@ -84,6 +96,9 @@ async def test_lsp_hover_support_for_myst(client):
     )
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_id_selection_completion_support_for_myst(client):
     # Check ID selection completion support for MyST/Markdown file
@@ -169,6 +184,9 @@ async def test_lsp_id_selection_completion_support_for_myst(client):
     assert need_id_md_result.data["source_feature"] == "sphinx_needs.lsp.esbonio.NeedlsFeatures"
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_need_directive_snippets_completion_for_myst(client):
     # Check need directive snippets support for MyST/Markdown
@@ -242,6 +260,9 @@ async def test_lsp_need_directive_snippets_completion_for_myst(client):
     assert needs_directive_spec_md_inside_eval_rst.data["source_feature"] == "sphinx_needs.lsp.esbonio.NeedlsFeatures"
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_needs_option_id_completion_for_myst(client):
     # Needs option id suggestion is the same for MyST/Markdown as for rst/Sphinx file, e.g. :id:
@@ -263,6 +284,9 @@ async def test_lsp_needs_option_id_completion_for_myst(client):
     assert needs_option_id.kind == 15  # CompletionItemKind.Snippet
 
 
+@pytest.mark.skipif(
+    version.parse(__version__) >= version.parse("1.0"), reason="Esbonio version >=0.16.0 using pygls >= 1.0 not tested."
+)
 @pytest.mark.asyncio
 async def test_lsp_need_role_need_completion_for_myst(client):
     # Need role need support for MyST/Markdown file