first progress reporting

Author: syphar

pylsp/python_lsp.py

@@ -228,9 +228,14 @@ def _match_uri_to_workspace(self, uri):
     def _hook(self, hook_name, doc_uri=None, **kwargs):
         """Calls hook_name and returns a list of results from all registered handlers"""
         workspace = self._match_uri_to_workspace(doc_uri)
+        progress_token = self.workspace.progress_begin(hook_name.removeprefix("pylsp_"))
+
         doc = workspace.get_document(doc_uri) if doc_uri else None
         hook_handlers = self.config.plugin_manager.subset_hook_caller(hook_name, self.config.disabled_plugins)
-        return hook_handlers(config=self.config, workspace=workspace, document=doc, **kwargs)
+        result = hook_handlers(config=self.config, workspace=workspace, document=doc, **kwargs)
+
+        self.workspace.progress_end(progress_token)
+        return result
 
     def capabilities(self):
         server_capabilities = {

pylsp/workspace.py

@@ -5,7 +5,9 @@
 import logging
 import os
 import re
+import uuid
 import functools
+from typing import Optional
 from threading import RLock
 
 import jedi
@@ -31,6 +33,7 @@ def wrapper(self, *args, **kwargs):
 class Workspace:
 
     M_PUBLISH_DIAGNOSTICS = 'textDocument/publishDiagnostics'
+    M_PROGRESS = '$/progress'
     M_APPLY_EDIT = 'workspace/applyEdit'
     M_SHOW_MESSAGE = 'window/showMessage'
 
@@ -109,6 +112,58 @@ def apply_edit(self, edit):
     def publish_diagnostics(self, doc_uri, diagnostics):
         self._endpoint.notify(self.M_PUBLISH_DIAGNOSTICS, params={'uri': doc_uri, 'diagnostics': diagnostics})
 
+    def progress_begin(self, title: str, message: Optional[str]=None, percentage: Optional[int]=None) -> str:
+        token = str(uuid.uuid4())
+        value = {
+            'kind': 'begin',
+            'title': title,
+        }
+        if message:
+            value['message'] = message
+        if percentage:
+            value['percentage'] = percentage
+
+        self._endpoint.notify(
+            self.M_PROGRESS,
+            params={
+                'token': token,
+                'value': value,
+            }
+        )
+        return token
+
+    def progress_report(self, token: str, message: Optional[str]=None, percentage: Optional[int]=None) -> None:
+        value = {
+            'kind': 'report',
+        }
+        if message:
+            value['message'] = message
+        if percentage:
+            value['percentage'] = percentage
+
+        self._endpoint.notify(
+            self.M_PROGRESS,
+            params={
+                'token': token,
+                'value': value,
+            }
+        )
+
+    def progress_end(self, token: str, message: Optional[str]=None) -> None:
+        value = {
+            'kind': 'end',
+        }
+        if message:
+            value['message'] = message
+
+        self._endpoint.notify(
+            self.M_PROGRESS,
+            params={
+                'token': token,
+                'value': value,
+            }
+        )
+
     def show_message(self, message, msg_type=lsp.MessageType.Info):
         self._endpoint.notify(self.M_SHOW_MESSAGE, params={'type': msg_type, 'message': message})