Re-add support for workspace/symbol with Project

Author: pappasam

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.6.0
+
+### Added
+
+- Re-added `workspace/symbol` support using Jedi's `Project` object. This is much simpler and faster than the previous implementation.
+
 ## 0.5.2
 
 ### Changed

README.md

@@ -13,11 +13,13 @@ A [Language Server](https://microsoft.github.io/language-server-protocol/) for t
 From your command line (bash / zsh), run:
 
 ```bash
-pip install -U jedi jedi-language-server
+pip install -U jedi-language-server
 ```
 
 `-U` ensures that you're pulling the latest version from pypi.
 
+Alternatively, consider using [pipx](https://github.com/pipxproject/pipx) to keep jedi-language-server isolated from your other Python dependencies.
+
 ## Overview
 
 jedi-language-server aims to support all of Jedi's capabilities and expose them through the Language Server Protocol. It currently supports the following Language Server requests:
@@ -28,6 +30,7 @@ jedi-language-server aims to support all of Jedi's capabilities and expose them
 - [textDocument/hover](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover)
 - [textDocument/references](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references)
 - [textDocument/rename](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rename)
+- [workspace/symbol](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_symbol)
 
 These language server requests are not currently configurable by the user, but we expect to relax this constraint in a future release.
 

jedi_language_server/server.py

@@ -6,6 +6,7 @@
     https://microsoft.github.io/language-server-protocol/specification
 """
 
+import itertools
 from typing import Dict  # pylint: disable=unused-import
 from typing import List, Optional
 
@@ -16,6 +17,7 @@
     HOVER,
     REFERENCES,
     RENAME,
+    WORKSPACE_SYMBOL,
 )
 from pygls.server import LanguageServer
 from pygls.types import (
@@ -30,11 +32,13 @@
     TextDocumentPositionParams,
     TextEdit,
     WorkspaceEdit,
+    WorkspaceSymbolParams,
 )
 
 from .server_utils import (
     get_jedi_line_column,
-    get_jedi_types,
+    get_jedi_project,
+    get_jedi_script,
     get_location_from_name,
     get_symbol_information_from_name,
 )
@@ -46,9 +50,9 @@
 @SERVER.feature(COMPLETION, triggerCharacters=["."])
 def lsp_completion(server: LanguageServer, params: CompletionParams):
     """Returns completion items"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     jedi_lines = get_jedi_line_column(params.position)
-    completions = jedi_types.script.complete(**jedi_lines)
+    completions = jedi_script.complete(**jedi_lines)
     return CompletionList(
         is_incomplete=False,
         items=[
@@ -69,9 +73,9 @@ def lsp_definition(
     server: LanguageServer, params: TextDocumentPositionParams
 ) -> List[Location]:
     """Support Goto Definition"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     jedi_lines = get_jedi_line_column(params.position)
-    names = jedi_types.script.goto(
+    names = jedi_script.goto(
         follow_imports=True, follow_builtin_imports=True, **jedi_lines,
     )
     return [get_location_from_name(name) for name in names]
@@ -82,10 +86,10 @@ def lsp_hover(
     server: LanguageServer, params: TextDocumentPositionParams
 ) -> Hover:
     """Support Hover"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     jedi_lines = get_jedi_line_column(params.position)
     try:
-        _names = jedi_types.script.help(**jedi_lines)
+        _names = jedi_script.help(**jedi_lines)
     except Exception:  # pylint: disable=broad-except
         names = []  # type: List[str]
     else:
@@ -98,10 +102,10 @@ def lsp_references(
     server: LanguageServer, params: TextDocumentPositionParams
 ) -> List[Location]:
     """Obtain all references to document"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     jedi_lines = get_jedi_line_column(params.position)
     try:
-        names = jedi_types.script.get_references(**jedi_lines)
+        names = jedi_script.get_references(**jedi_lines)
     except Exception:  # pylint: disable=broad-except
         return []
     return [get_location_from_name(name) for name in names]
@@ -112,10 +116,10 @@ def lsp_rename(
     server: LanguageServer, params: RenameParams
 ) -> Optional[WorkspaceEdit]:
     """Rename a symbol across a workspace"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     jedi_lines = get_jedi_line_column(params.position)
     try:
-        names = jedi_types.script.get_references(**jedi_lines)
+        names = jedi_script.get_references(**jedi_lines)
     except Exception:  # pylint: disable=broad-except
         return None
     locations = [get_location_from_name(name) for name in names]
@@ -136,9 +140,27 @@ def lsp_document_symbol(
     server: LanguageServer, params: DocumentSymbolParams
 ) -> List[SymbolInformation]:
     """Document Python document symbols"""
-    jedi_types = get_jedi_types(server, params.textDocument)
+    jedi_script = get_jedi_script(server, params.textDocument)
     try:
-        names = jedi_types.script.get_names()
+        names = jedi_script.get_names()
     except Exception:  # pylint: disable=broad-except
         return []
     return [get_symbol_information_from_name(name) for name in names]
+
+
+@SERVER.feature(WORKSPACE_SYMBOL)
+def lsp_workspace_symbol(
+    server: LanguageServer, params: WorkspaceSymbolParams
+) -> List[SymbolInformation]:
+    """Document Python workspace symbols"""
+    jedi_project = get_jedi_project(server)
+    if params.query.strip() == "":
+        return []
+    try:
+        names = jedi_project.search(params.query)
+    except Exception:  # pylint: disable=broad-except
+        return []
+    return [
+        get_symbol_information_from_name(name)
+        for name in itertools.islice(names, 20)
+    ]

jedi_language_server/server_utils.py

@@ -1,6 +1,6 @@
 """Utility functions used by the language server"""
 
-from typing import Dict, NamedTuple, Optional
+from typing import Dict, Optional
 
 from jedi import Project, Script
 from jedi.api.classes import Name
@@ -18,16 +18,9 @@
 from .type_map import get_lsp_symbol_type
 
 
-class JediTypes(NamedTuple):
-    """Jedi types container; return value from get_jedi_types"""
-
-    script: Script
-    project: Project
-
-
-def get_jedi_types(
+def get_jedi_script(
     server: LanguageServer, text_document_identifier: TextDocumentIdentifier
-) -> JediTypes:
+) -> Script:
     """Simplifies getting jedi Script"""
     workspace = server.workspace
     document = workspace.get_document(text_document_identifier.uri)
@@ -36,13 +29,22 @@ def get_jedi_types(
         smart_sys_path=True,
         load_unsafe_extensions=False,
     )
-    script = Script(
+    return Script(
         code=document.source,
         path=document.path,
         project=project,
         environment=get_cached_default_environment(),
     )
-    return JediTypes(script=script, project=project)
+
+
+def get_jedi_project(server: LanguageServer) -> Project:
+    """Simplifies getting jedi project"""
+    workspace = server.workspace
+    return Project(
+        path=workspace.root_path,
+        smart_sys_path=True,
+        load_unsafe_extensions=False,
+    )
 
 
 def get_location_from_name(name: Name) -> Location:

pyproject.toml

@@ -13,7 +13,7 @@ include_trailing_comma = true
 
 [tool.poetry]
 name = "jedi-language-server"
-version = "0.5.2"
+version = "0.6.0"
 description = "A language server for Jedi!"
 authors = ["Sam Roeca <samuel.roeca@gmail.com>"]
 readme = "README.md"