alternative approach: explicit, optional progress reporting for each plugin

Author: syphar

pylsp/plugins/definition.py

@@ -8,24 +8,25 @@
 
 
 @hookimpl
-def pylsp_definitions(config, document, position):
-    settings = config.plugin_settings('jedi_definition')
-    code_position = _utils.position_to_jedi_linecolumn(document, position)
-    definitions = document.jedi_script(use_document_path=True).goto(
-        follow_imports=settings.get('follow_imports', True),
-        follow_builtin_imports=settings.get('follow_builtin_imports', True),
-        **code_position)
+def pylsp_definitions(config, workspace, document, position):
+    with workspace.report_progress("definitions"):
+        settings = config.plugin_settings('jedi_definition')
+        code_position = _utils.position_to_jedi_linecolumn(document, position)
+        definitions = document.jedi_script(use_document_path=True).goto(
+            follow_imports=settings.get('follow_imports', True),
+            follow_builtin_imports=settings.get('follow_builtin_imports', True),
+            **code_position)
 
-    return [
-        {
-            'uri': uris.uri_with(document.uri, path=str(d.module_path)),
-            'range': {
-                'start': {'line': d.line - 1, 'character': d.column},
-                'end': {'line': d.line - 1, 'character': d.column + len(d.name)},
+        return [
+            {
+                'uri': uris.uri_with(document.uri, path=str(d.module_path)),
+                'range': {
+                    'start': {'line': d.line - 1, 'character': d.column},
+                    'end': {'line': d.line - 1, 'character': d.column + len(d.name)},
+                }
             }
-        }
-        for d in definitions if d.is_definition() and _not_internal_definition(d)
-    ]
+            for d in definitions if d.is_definition() and _not_internal_definition(d)
+        ]
 
 
 def _not_internal_definition(definition):

pylsp/plugins/flake8_lint.py

@@ -23,56 +23,57 @@ def pylsp_settings():
 
 @hookimpl
 def pylsp_lint(workspace, document):
-    config = workspace._config
-    settings = config.plugin_settings('flake8', document_path=document.path)
-    log.debug("Got flake8 settings: %s", settings)
-
-    ignores = settings.get("ignore", [])
-    per_file_ignores = settings.get("perFileIgnores")
-
-    if per_file_ignores:
-        prev_file_pat = None
-        for path in per_file_ignores:
-            try:
-                file_pat, errors = path.split(":")
-                prev_file_pat = file_pat
-            except ValueError:
-                # It's legal to just specify another error type for the same
-                # file pattern:
-                if prev_file_pat is None:
-                    log.warning(
-                        "skipping a Per-file-ignore with no file pattern")
-                    continue
-                file_pat = prev_file_pat
-                errors = path
-            if PurePath(document.path).match(file_pat):
-                ignores.extend(errors.split(","))
-
-    opts = {
-        'config': settings.get('config'),
-        'exclude': settings.get('exclude'),
-        'filename': settings.get('filename'),
-        'hang-closing': settings.get('hangClosing'),
-        'ignore': ignores or None,
-        'max-line-length': settings.get('maxLineLength'),
-        'indent-size': settings.get('indentSize'),
-        'select': settings.get('select'),
-    }
-
-    # flake takes only absolute path to the config. So we should check and
-    # convert if necessary
-    if opts.get('config') and not os.path.isabs(opts.get('config')):
-        opts['config'] = os.path.abspath(os.path.expanduser(os.path.expandvars(
-            opts.get('config')
-        )))
-        log.debug("using flake8 with config: %s", opts['config'])
-
-    # Call the flake8 utility then parse diagnostics from stdout
-    flake8_executable = settings.get('executable', 'flake8')
-
-    args = build_args(opts)
-    output = run_flake8(flake8_executable, args, document)
-    return parse_stdout(document, output)
+    with workspace.report_progress("flake8"):
+        config = workspace._config
+        settings = config.plugin_settings('flake8', document_path=document.path)
+        log.debug("Got flake8 settings: %s", settings)
+
+        ignores = settings.get("ignore", [])
+        per_file_ignores = settings.get("perFileIgnores")
+
+        if per_file_ignores:
+            prev_file_pat = None
+            for path in per_file_ignores:
+                try:
+                    file_pat, errors = path.split(":")
+                    prev_file_pat = file_pat
+                except ValueError:
+                    # It's legal to just specify another error type for the same
+                    # file pattern:
+                    if prev_file_pat is None:
+                        log.warning(
+                            "skipping a Per-file-ignore with no file pattern")
+                        continue
+                    file_pat = prev_file_pat
+                    errors = path
+                if PurePath(document.path).match(file_pat):
+                    ignores.extend(errors.split(","))
+
+        opts = {
+            'config': settings.get('config'),
+            'exclude': settings.get('exclude'),
+            'filename': settings.get('filename'),
+            'hang-closing': settings.get('hangClosing'),
+            'ignore': ignores or None,
+            'max-line-length': settings.get('maxLineLength'),
+            'indent-size': settings.get('indentSize'),
+            'select': settings.get('select'),
+        }
+
+        # flake takes only absolute path to the config. So we should check and
+        # convert if necessary
+        if opts.get('config') and not os.path.isabs(opts.get('config')):
+            opts['config'] = os.path.abspath(os.path.expanduser(os.path.expandvars(
+                opts.get('config')
+            )))
+            log.debug("using flake8 with config: %s", opts['config'])
+
+        # Call the flake8 utility then parse diagnostics from stdout
+        flake8_executable = settings.get('executable', 'flake8')
+
+        args = build_args(opts)
+        output = run_flake8(flake8_executable, args, document)
+        return parse_stdout(document, output)
 
 
 def run_flake8(flake8_executable, args, document):

pylsp/plugins/jedi_rename.py

@@ -10,38 +10,43 @@
 
 @hookimpl
 def pylsp_rename(config, workspace, document, position, new_name):  # pylint: disable=unused-argument
-    log.debug('Executing rename of %s to %s', document.word_at_position(position), new_name)
-    kwargs = _utils.position_to_jedi_linecolumn(document, position)
-    kwargs['new_name'] = new_name
-    try:
-        refactoring = document.jedi_script().rename(**kwargs)
-    except NotImplementedError as exc:
-        raise Exception('No support for renaming in Python 2/3.5 with Jedi. '
-                        'Consider using the rope_rename plugin instead') from exc
-    log.debug('Finished rename: %s', refactoring.get_diff())
-    changes = []
-    for file_path, changed_file in refactoring.get_changed_files().items():
-        uri = uris.from_fs_path(str(file_path))
-        doc = workspace.get_maybe_document(uri)
-        changes.append({
-            'textDocument': {
-                'uri': uri,
-                'version': doc.version if doc else None
-            },
-            'edits': [
-                {
-                    'range': {
-                        'start': {'line': 0, 'character': 0},
-                        'end': {
-                            'line': _num_lines(changed_file.get_new_code()),
-                            'character': 0,
+    with workspace.report_progress("rename") as report_progress:
+        log.debug('Executing rename of %s to %s', document.word_at_position(position), new_name)
+        kwargs = _utils.position_to_jedi_linecolumn(document, position)
+        kwargs['new_name'] = new_name
+        report_progress("refactoring")
+        try:
+            refactoring = document.jedi_script().rename(**kwargs)
+        except NotImplementedError as exc:
+            raise Exception('No support for renaming in Python 2/3.5 with Jedi. '
+                            'Consider using the rope_rename plugin instead') from exc
+        log.debug('Finished rename: %s', refactoring.get_diff())
+        changes = []
+
+        changed_files = refactoring.get_changed_files()
+        for n, (file_path, changed_file) in enumerate(changed_files.items()):
+            report_progress(changed_file, percentage=n/len(changed_files)*100)
+            uri = uris.from_fs_path(str(file_path))
+            doc = workspace.get_maybe_document(uri)
+            changes.append({
+                'textDocument': {
+                    'uri': uri,
+                    'version': doc.version if doc else None
+                },
+                'edits': [
+                    {
+                        'range': {
+                            'start': {'line': 0, 'character': 0},
+                            'end': {
+                                'line': _num_lines(changed_file.get_new_code()),
+                                'character': 0,
+                            },
                         },
-                    },
-                    'newText': changed_file.get_new_code(),
-                }
-            ],
-        })
-    return {'documentChanges': changes}
+                        'newText': changed_file.get_new_code(),
+                    }
+                ],
+            })
+        return {'documentChanges': changes}
 
 
 def _num_lines(file_contents):

pylsp/plugins/references.py

@@ -8,19 +8,20 @@
 
 
 @hookimpl
-def pylsp_references(document, position, exclude_declaration=False):
-    code_position = _utils.position_to_jedi_linecolumn(document, position)
-    usages = document.jedi_script().get_references(**code_position)
+def pylsp_references(document, workspace, position, exclude_declaration=False):
+    with workspace.report_progress("references"):
+        code_position = _utils.position_to_jedi_linecolumn(document, position)
+        usages = document.jedi_script().get_references(**code_position)
 
-    if exclude_declaration:
-        # Filter out if the usage is the actual declaration of the thing
-        usages = [d for d in usages if not d.is_definition()]
+        if exclude_declaration:
+            # Filter out if the usage is the actual declaration of the thing
+            usages = [d for d in usages if not d.is_definition()]
 
-    # Filter out builtin modules
-    return [{
-        'uri': uris.uri_with(document.uri, path=str(d.module_path)) if d.module_path else document.uri,
-        'range': {
-            'start': {'line': d.line - 1, 'character': d.column},
-            'end': {'line': d.line - 1, 'character': d.column + len(d.name)}
-        }
-    } for d in usages if not d.in_builtin_module()]
+        # Filter out builtin modules
+        return [{
+            'uri': uris.uri_with(document.uri, path=str(d.module_path)) if d.module_path else document.uri,
+            'range': {
+                'start': {'line': d.line - 1, 'character': d.column},
+                'end': {'line': d.line - 1, 'character': d.column + len(d.name)}
+            }
+        } for d in usages if not d.in_builtin_module()]

pylsp/python_lsp.py

@@ -228,14 +228,10 @@ 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)
-        result = hook_handlers(config=self.config, workspace=workspace, document=doc, **kwargs)
-
-        self.workspace.progress_end(progress_token)
-        return result
+        return hook_handlers(config=self.config, workspace=workspace, document=doc, **kwargs)
 
     def capabilities(self):
         server_capabilities = {

pylsp/workspace.py

@@ -3,11 +3,12 @@
 
 import io
 import logging
+from contextlib import contextmanager
 import os
 import re
 import uuid
 import functools
-from typing import Optional
+from typing import Optional, Generator
 from threading import RLock
 
 import jedi
@@ -112,7 +113,19 @@ 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:
+    @contextmanager 
+    def report_progress(self, title: str, message: Optional[str]=None, percentage: Optional[int] = None):
+        token = self._progress_begin(title, message, percentage)
+
+        def progress_message(message: str, percentage: Optional[int]=None):
+            self._progress_report(token, message, percentage)
+
+        try: 
+            yield progress_message
+        finally: 
+            self._progress_end(token)
+
+    def _progress_begin(self, title: str, message: Optional[str]=None, percentage: Optional[int]=None) -> str:
         token = str(uuid.uuid4())
         value = {
             'kind': 'begin',
@@ -132,7 +145,7 @@ def progress_begin(self, title: str, message: Optional[str]=None, percentage: Op
         )
         return token
 
-    def progress_report(self, token: str, message: Optional[str]=None, percentage: Optional[int]=None) -> None:
+    def _progress_report(self, token: str, message: Optional[str]=None, percentage: Optional[int]=None) -> None:
         value = {
             'kind': 'report',
         }
@@ -149,7 +162,7 @@ def progress_report(self, token: str, message: Optional[str]=None, percentage: O
             }
         )
 
-    def progress_end(self, token: str, message: Optional[str]=None) -> None:
+    def _progress_end(self, token: str, message: Optional[str]=None) -> None:
         value = {
             'kind': 'end',
         }