Implement workspace search

Author: niilohlin

pylsp/config/schema.json

@@ -242,21 +242,26 @@
 "default": true,
 "description": "Enable or disable the plugin."
  },
-"pylsp.plugins.jedi_symbols.enabled":{
+"pylsp.plugins.jedi_document_symbols.enabled":{
 "type": "boolean",
 "default": true,
 "description": "Enable or disable the plugin."
  },
-"pylsp.plugins.jedi_symbols.all_scopes":{
+"pylsp.plugins.jedi_document_symbols.all_scopes":{
 "type": "boolean",
 "default": true,
 "description": "If True lists the names of all scopes instead of only the module namespace."
  },
-"pylsp.plugins.jedi_symbols.include_import_symbols":{
+"pylsp.plugins.jedi_document_symbols.include_import_symbols":{
 "type": "boolean",
 "default": true,
 "description": "If True includes symbols imported from other libraries."
  },
+"pylsp.plugins.jedi_workspace_symbols.enabled":{
+"type": "boolean",
+"default": true,
+"description": "If True includes workspace symbols."
+ },
 "pylsp.plugins.mccabe.enabled":{
 "type": "boolean",
 "default": true,

pylsp/hookspecs.py

@@ -68,6 +68,11 @@ def pylsp_execute_command(config, workspace, command, arguments):
 pass
 
 
+@hookspec
+defpylsp_workspace_symbol(config, workspace, document, query):
+pass
+
+
 @hookspec
 defpylsp_experimental_capabilities(config, workspace):
 pass

pylsp/plugins/symbols.py pylsp/plugins/document_symbols.pypylsp/plugins/symbols.py renamed to pylsp/plugins/document_symbols.py

@@ -12,7 +12,7 @@
 
 @hookimpl
 defpylsp_document_symbols(config, document):
-symbols_settings=config.plugin_settings("jedi_symbols")
+symbols_settings=config.plugin_settings("jedi_document_symbols")
 all_scopes=symbols_settings.get("all_scopes", True)
 add_import_symbols=symbols_settings.get("include_import_symbols", True)
 definitions=document.jedi_names(all_scopes=all_scopes)

pylsp/plugins/workspace_symbol.py

@@ -0,0 +1,50 @@
+# Copyright 2017-2020 Palantir Technologies, Inc.
+# Copyright 2021- Python Language Server Contributors.
+
+importlogging
+frompathlibimportPath
+
+frompylspimporthookimpl
+frompylsp.lspimportSymbolKind
+
+log=logging.getLogger(__name__)
+
+
+@hookimpl
+defpylsp_workspace_symbol(config, workspace, document, query):
+ifnotqueryornotworkspace:
+return []
+
+return [_jedi_name_to_symbol(jedi_name) forjedi_nameinworkspace.search(query)]
+
+
+def_jedi_name_to_symbol(jedi_name):
+return{
+"name": jedi_name.name,
+"kind": _jedi_type_to_symbol_kind(jedi_name.type),
+"location":{
+"uri": "file://"+str(jedi_name.module_path),
+"range":{
+"start":{"line": jedi_name.line-1, "character": jedi_name.column},
+"end":{"line": jedi_name.line-1, "character": jedi_name.column},
+ },
+ },
+ }
+
+
+def_jedi_type_to_symbol_kind(jedi_type):
+ifjedi_type=="module":
+returnSymbolKind.Module
+ifjedi_type=="class":
+returnSymbolKind.Class
+ifjedi_type=="function":
+returnSymbolKind.Function
+ifjedi_type=="instance":
+returnSymbolKind.Variable
+ifjedi_type=="statement":
+returnSymbolKind.Variable
+ifjedi_type=="param":
+returnSymbolKind.Variable
+ifjedi_type=="path":
+returnSymbolKind.File
+returnSymbolKind.Variable

pylsp/python_lsp.py

@@ -298,6 +298,7 @@ def capabilities(self):
 "workspaceFolders":{"supported": True, "changeNotifications": True}
  },
 "experimental": merge(self._hook("pylsp_experimental_capabilities")),
+"workspaceSymbolProvider": True,
  }
 log.info("Server capabilities: %s", server_capabilities)
 returnserver_capabilities
@@ -433,6 +434,11 @@ def highlight(self, doc_uri, position):
 orNone
  )
 
+defworkspace_symbol(self, query):
+response=self._hook("pylsp_workspace_symbol", query=query)
+log.debug("Workspace symbol hook returned: %s", response)
+returnflatten(response)
+
 defhover(self, doc_uri, position):
 returnself._hook("pylsp_hover", doc_uri, position=position) or{"contents": ""}
 
@@ -767,6 +773,9 @@ def m_text_document__hover(self, textDocument=None, position=None, **_kwargs):
 defm_text_document__document_symbol(self, textDocument=None, **_kwargs):
 returnself.document_symbols(textDocument["uri"])
 
+defm_workspace__symbol(self, textDocument=None, **_kwargs):
+returnself.workspace_symbol(_kwargs["query"])
+
 defm_text_document__formatting(self, textDocument=None, options=None, **_kwargs):
 returnself.format_document(textDocument["uri"], options)
 

pylsp/workspace.py

@@ -100,6 +100,46 @@ def root_path(self):
 defroot_uri(self):
 returnself._root_uri
 
+defsearch(self, query):
+project=self.jedi_project()
+returnproject.complete_search(query)
+
+defjedi_project(self, use_document_path=False):
+extra_paths= []
+environment_path=None
+env_vars=None
+
+ifself._config:
+jedi_settings=self._config.plugin_settings(
+"jedi", document_path=self.root_path
+ )
+jedi.settings.auto_import_modules=jedi_settings.get(
+"auto_import_modules", DEFAULT_AUTO_IMPORT_MODULES
+ )
+environment_path=jedi_settings.get("environment")
+# Jedi itself cannot deal with homedir-relative paths.
+# On systems, where it is expected, expand the home directory.
+ifenvironment_pathandos.name!="nt":
+environment_path=os.path.expanduser(environment_path)
+
+extra_paths=jedi_settings.get("extra_paths") or []
+env_vars=jedi_settings.get("env_vars")
+
+# Drop PYTHONPATH from env_vars before creating the environment because that makes
+# Jedi throw an error.
+ifenv_varsisNone:
+env_vars=os.environ.copy()
+env_vars.pop("PYTHONPATH", None)
+
+sys_path=extra_paths# self.sys_path(environment_path, env_vars=env_vars) + extra_paths
+project_path=self.root_path
+
+# Extend sys_path with document's path if requested
+ifuse_document_path:
+sys_path+= [os.path.normpath(os.path.dirname(self.path))]
+
+returnjedi.Project(path=project_path, sys_path=sys_path)
+
 defis_local(self):
 return (self._root_uri_schemein ["", "file"]) andos.path.exists(
 self._root_path

pyproject.toml

@@ -71,7 +71,8 @@ jedi_highlight = "pylsp.plugins.highlight"
 jedi_references = "pylsp.plugins.references"
 jedi_rename = "pylsp.plugins.jedi_rename"
 jedi_signature_help = "pylsp.plugins.signature"
-jedi_symbols = "pylsp.plugins.symbols"
+jedi_document_symbols = "pylsp.plugins.document_symbols"
+jedi_workspace_symbol = "pylsp.plugins.workspace_symbol"
 mccabe = "pylsp.plugins.mccabe_lint"
 preload = "pylsp.plugins.preload_imports"
 pycodestyle = "pylsp.plugins.pycodestyle_lint"

test/plugins/test_symbols.py

@@ -8,7 +8,8 @@
 
 frompylspimporturis
 frompylsp.lspimportSymbolKind
-frompylsp.plugins.symbolsimportpylsp_document_symbols
+frompylsp.plugins.document_symbolsimportpylsp_document_symbols
+frompylsp.plugins.workspace_symbolimportpylsp_workspace_symbol
 frompylsp.workspaceimportDocument
 
 PY2=sys.version[0] =="2"