robotcode-language-server 2.6.2__py3-none-any.whl → 2.8.0.dev548__py3-none-any.whl

robotcode/language_server/__version__.py

@@ -1 +1 @@
-__version__ = "2.6.2"
+__version__ = "2.8.0-dev.548"

robotcode/language_server/common/parts/diagnostics.py

@@ -8,7 +8,7 @@ from contextlib import contextmanager
 from dataclasses import dataclass, field
 from enum import Enum
 from threading import Event, Timer
-from typing import TYPE_CHECKING, Any, Dict, Final, Iterator, List, Optional, Union, cast
+from typing import TYPE_CHECKING, Any, Dict, Final, Iterator, List, Optional, Tuple, Union, cast
 
 from robotcode.core.concurrent import Lock, RLock, Task, check_current_task_canceled, run_as_task
 from robotcode.core.event import event
@@ -75,6 +75,8 @@ class DiagnosticsData:
     force: bool = False
     single: bool = False
     skipped_entries: bool = False
+    # counts every mark, also one that finds `force` already set
+    marks: int = 0
 
 
 class DiagnosticsCollectType(Enum):
@@ -85,6 +87,12 @@ class DiagnosticsCollectType(Enum):
 class DiagnosticsProtocolPart(LanguageServerProtocolPart):
     _logger: Final = LoggingDescriptor()
 
+    # Seconds of the delays that gather changes before the analysis reacts to them.
+    _break_diagnostics_loop_delay: float = 1
+    _diagnostics_loop_idle_interval: float = 1
+    _document_diagnostics_debounce: float = 0.75
+    _refresh_delay: float = 1
+
     def __init__(self, protocol: "LanguageServerProtocol") -> None:
         super().__init__(protocol)
 
@@ -103,8 +111,8 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
         self.parent.documents.on_document_cache_invalidated.add(self._on_document_cache_invalidated)
         self.parent.documents.did_close.add(self.on_did_close)
 
-        self.in_get_workspace_diagnostics_event = Event()
-        self.workspace_diagnostics_started_event = Event()
+        # set while no document needs an update; the loop clears it again when a pass finds work
+        self.workspace_analyzed_event = Event()
 
         self.client_supports_pull = False
 
@@ -238,6 +246,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                 needs_break = needs_break or doc.opened_in_editor
                 doc.set_data(DiagnosticsProtocolPart, None)
                 with self.get_diagnostics_data(doc) as data:
+                    data.marks += 1
                     if data.force:
                         continue
                     needs_break = True
@@ -264,12 +273,14 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
         for doc in self.parent.documents.documents:
             with self.get_diagnostics_data(doc) as data:
                 data.force = True
+                data.marks += 1
 
         if refresh:
             self.refresh()
 
     def force_refresh_document(self, document: TextDocument, refresh: bool = True, single: bool = False) -> None:
         with self.get_diagnostics_data(document) as data:
+            data.marks += 1
             if data.force:
                 return
             data.force = True
@@ -308,7 +319,9 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                 self.break_diagnostics_timer = None
 
             if not now:
-                self.break_diagnostics_timer = Timer(1, self._break_workspace_diagnostics_loop)
+                self.break_diagnostics_timer = Timer(
+                    self._break_diagnostics_loop_delay, self._break_workspace_diagnostics_loop
+                )
                 self.break_diagnostics_timer.start()
                 return
 
@@ -320,7 +333,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
             if self._current_diagnostics_task is not None and not self._current_diagnostics_task.done():
                 self._current_diagnostics_task.cancel()
 
-    def _analyse_document(self, document: TextDocument) -> List[Union[DiagnosticsResult, None, BaseException]]:
+    def _analyse_document(self, document: TextDocument) -> List[Union[DiagnosticsResult, BaseException, None]]:
         return self.analyze(
             self,
             document,
@@ -332,6 +345,10 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
         with self.get_diagnostics_data(document) as data:
             return data.force or document.version != data.version or data.skipped_entries
 
+    def _is_current_document(self, document: TextDocument) -> bool:
+        """Whether the documents manager still holds `document` for its URI; a document closed for good is gone."""
+        return self.parent.documents.get(document.uri) is document
+
     @_logger.call
     def run_workspace_diagnostics(self) -> None:
         self._logger.debug("start workspace diagnostics loop")
@@ -341,8 +358,6 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
             check_current_task_canceled()
 
             self.on_workspace_diagnostics_start(self)
-            self.in_get_workspace_diagnostics_event.clear()
-            self.workspace_diagnostics_started_event.set()
             done_something = False
 
             try:
@@ -352,11 +367,15 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                     [doc for doc in self.parent.documents.documents if self._doc_need_update(doc)],
                     key=lambda d: not d.opened_in_editor,
                 )
+                noted_marks: Dict[TextDocument, Tuple[DiagnosticsData, int]] = {}
 
                 if len(documents) == 0:
-                    check_current_task_canceled(1)
+                    self.workspace_analyzed_event.set()
+                    check_current_task_canceled(self._diagnostics_loop_idle_interval)
                     continue
 
+                self.workspace_analyzed_event.clear()
+
                 with self._logger.measure_time(
                     lambda: f"analyzing workspace for {len(documents)} documents",
                     context_name="workspace_diagnostics",
@@ -387,6 +406,9 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                                 self.on_workspace_diagnostics_break(self)
                                 break
 
+                            if not self._is_current_document(document):
+                                continue
+
                             done_something = True
 
                             analysis_mode = self.get_analysis_progress_mode(document.uri)
@@ -403,6 +425,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                                 progress.report(f"Analyze {i + 1}/{len(documents)}", current=i + 1)
 
                             try:
+                                noted_marks[document] = self._note_marks(document)
                                 with self._current_diagnostics_task_lock:
                                     self._current_diagnostics_task = run_as_task(self._analyse_document, document)
                                 self._current_diagnostics_task.result(self._diagnostics_task_timeout)
@@ -453,7 +476,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                             self.on_workspace_diagnostics_break(self)
                             break
 
-                        self.reset_document_diagnostics_data(document)
+                        self.reset_document_diagnostics_data(document, noted_marks.get(document))
 
                     with self.parent.window.progress(
                         "Collect Diagnostics",
@@ -472,9 +495,12 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                                 self.on_workspace_diagnostics_break(self)
                                 break
 
+                            if not self._is_current_document(document):
+                                continue
+
                             mode = self.get_diagnostics_mode(document.uri)
                             if mode == DiagnosticsMode.OFF:
-                                self.reset_document_diagnostics_data(document)
+                                self.reset_document_diagnostics_data(document, noted_marks.get(document))
                                 continue
 
                             done_something = True
@@ -527,16 +553,23 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
             except BaseException as e:
                 self._logger.exception(e)
             finally:
-                self.workspace_diagnostics_started_event.clear()
-                self.in_get_workspace_diagnostics_event.set()
                 self.on_workspace_diagnostics_end(self)
 
                 if not done_something:
-                    check_current_task_canceled(1)
+                    check_current_task_canceled(self._diagnostics_loop_idle_interval)
 
-    def reset_document_diagnostics_data(self, document: TextDocument) -> None:
+    def _note_marks(self, document: TextDocument) -> Tuple[DiagnosticsData, int]:
+        """The diagnostics data of `document` and its count of marks, as the loop notes them when it analyzes it."""
+        with self.get_diagnostics_data(document) as data:
+            return data, data.marks
+
+    def reset_document_diagnostics_data(
+        self, document: TextDocument, noted_marks: Optional[Tuple[DiagnosticsData, int]] = None
+    ) -> None:
         with self.get_diagnostics_data(document) as data:
-            data.force = False
+            # a mark since the analysis noted in `noted_marks` keeps the document for the next pass
+            if noted_marks is None or (noted_marks[0] is data and noted_marks[1] == data.marks):
+                data.force = False
             data.version = document.version
             data.skipped_entries = False
             data.single = False
@@ -593,7 +626,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
         collect_slow: bool,
     ) -> None:
         if debounce:
-            check_current_task_canceled(0.75)
+            check_current_task_canceled(self._document_diagnostics_debounce)
 
         data.skipped_entries = False
         collected_keys: List[Any] = []
@@ -745,7 +778,7 @@ class DiagnosticsProtocolPart(LanguageServerProtocolPart):
                 self.refresh_timer = None
 
             if not now:
-                self.refresh_timer = Timer(1, self._refresh)
+                self.refresh_timer = Timer(self._refresh_delay, self._refresh)
                 self.refresh_timer.start()
                 return
 

robotcode/language_server/common/parts/documents.py

@@ -25,7 +25,6 @@ from robotcode.core.lsp.types import (
     TextDocumentSaveReason,
     TextDocumentSyncKind,
     TextDocumentSyncOptions,
-    TextEdit,
     VersionedTextDocumentIdentifier,
     WatchKind,
     WillSaveTextDocumentParams,
@@ -85,11 +84,8 @@ class TextDocumentProtocolPart(LanguageServerProtocolPart, DocumentsManager):
                     self.close_document(document, True)
 
                 elif change.type == FileChangeType.CHANGED:
-                    document.apply_full_change(
-                        None,
-                        self.read_document_text(document.uri, language_id_filter(document)),
-                        save=True,
-                    )
+                    text, disk_info = self.read_document_text_with_disk_info(document.uri, language_id_filter(document))
+                    document.apply_full_change(None, text, save=True, disk_info=disk_info)
                     self.did_change(
                         self,
                         document,
@@ -142,7 +138,13 @@ class TextDocumentProtocolPart(LanguageServerProtocolPart, DocumentsManager):
         if document is not None:
             document.opened_in_editor = False
 
-            self.close_document(document)
+            if document.uri.scheme == "file" and not document.uri.to_path().exists():
+                # deleted while it was open in the editor: handled like a deleted file, which drops the document
+                self.parent.workspace.did_change_watched_files(
+                    self.parent.workspace, [FileEvent(str(document.uri), FileChangeType.DELETED)]
+                )
+            else:
+                self.close_document(document)
 
     @rpc_method(name="textDocument/willSave", param_type=WillSaveTextDocumentParams)
     @__logger.call
@@ -172,33 +174,34 @@ class TextDocumentProtocolPart(LanguageServerProtocolPart, DocumentsManager):
         )
 
         if document is not None:
-            if text is not None:
-                normalized_text = self._normalize_line_endings(text)
-
-                text_changed = document.text() != normalized_text
-                if text_changed:
-                    document.save(None, text)
-                    self.did_change(
-                        self,
-                        document,
-                        callback_filter=language_id_filter(document),
-                    )
+            if text is not None and document.text() != self._normalize_line_endings(text):
+                document.save(None, text)
+                self.did_change(
+                    self,
+                    document,
+                    callback_filter=language_id_filter(document),
+                )
+            else:
+                # closing the document reverts it to the saved text
+                document.mark_saved()
 
             self.did_save(self, document, callback_filter=language_id_filter(document))
 
-    @rpc_method(
-        name="textDocument/willSaveWaitUntil",
-        param_type=WillSaveTextDocumentParams,
-    )
-    @__logger.call
-    def _text_document_will_save_wait_until(
-        self,
-        text_document: TextDocumentIdentifier,
-        reason: TextDocumentSaveReason,
-        *args: Any,
-        **kwargs: Any,
-    ) -> List[TextEdit]:
-        return []
+    # willSaveWaitUntil stays commented out until the server returns edits for it, see the text document sync
+    # options of the protocol.
+    # @rpc_method(
+    #     name="textDocument/willSaveWaitUntil",
+    #     param_type=WillSaveTextDocumentParams,
+    # )
+    # @__logger.call
+    # def _text_document_will_save_wait_until(
+    #     self,
+    #     text_document: TextDocumentIdentifier,
+    #     reason: TextDocumentSaveReason,
+    #     *args: Any,
+    #     **kwargs: Any,
+    # ) -> List[TextEdit]:
+    #     return []
 
     @rpc_method(name="textDocument/didChange", param_type=DidChangeTextDocumentParams)
     @__logger.call

robotcode/language_server/common/parts/workspace.py

@@ -8,7 +8,6 @@ from typing import (
     Dict,
     Final,
     List,
-    Mapping,
     Optional,
     Tuple,
     Type,
@@ -43,7 +42,6 @@ from robotcode.core.lsp.types import (
     ServerCapabilities,
     ServerCapabilitiesWorkspaceType,
     TextDocumentEdit,
-    TextEdit,
     WatchKind,
     WorkspaceEdit,
     WorkspaceFoldersChangeEvent,
@@ -117,6 +115,8 @@ class Workspace(LanguageServerProtocolPart, CoreWorkspace, FileWatcherManagerBas
             workspace_folders=WorkspaceFoldersServerCapabilities(
                 supported=True, change_notifications=str(uuid.uuid4())
             ),
+            # The will* operations stay unregistered until the server returns edits for them: clients wait for their
+            # answer before they create, rename or delete the files.
             file_operations=FileOperationOptions(
                 did_create=FileOperationRegistrationOptions(
                     filters=[
@@ -125,13 +125,13 @@ class Workspace(LanguageServerProtocolPart, CoreWorkspace, FileWatcherManagerBas
                         )
                     ]
                 ),
-                will_create=FileOperationRegistrationOptions(
-                    filters=[
-                        FileOperationFilter(
-                            pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
-                        )
-                    ]
-                ),
+                # will_create=FileOperationRegistrationOptions(
+                #     filters=[
+                #         FileOperationFilter(
+                #             pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
+                #         )
+                #     ]
+                # ),
                 did_rename=FileOperationRegistrationOptions(
                     filters=[
                         FileOperationFilter(
@@ -139,13 +139,13 @@ class Workspace(LanguageServerProtocolPart, CoreWorkspace, FileWatcherManagerBas
                         )
                     ]
                 ),
-                will_rename=FileOperationRegistrationOptions(
-                    filters=[
-                        FileOperationFilter(
-                            pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
-                        )
-                    ]
-                ),
+                # will_rename=FileOperationRegistrationOptions(
+                #     filters=[
+                #         FileOperationFilter(
+                #             pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
+                #         )
+                #     ]
+                # ),
                 did_delete=FileOperationRegistrationOptions(
                     filters=[
                         FileOperationFilter(
@@ -153,13 +153,13 @@ class Workspace(LanguageServerProtocolPart, CoreWorkspace, FileWatcherManagerBas
                         )
                     ]
                 ),
-                will_delete=FileOperationRegistrationOptions(
-                    filters=[
-                        FileOperationFilter(
-                            pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
-                        )
-                    ]
-                ),
+                # will_delete=FileOperationRegistrationOptions(
+                #     filters=[
+                #         FileOperationFilter(
+                #             pattern=FileOperationPattern(glob=f"**/*.{{{','.join(self.parent.file_extensions)}}}")
+                #         )
+                #     ]
+                # ),
             ),
         )
 
@@ -180,60 +180,62 @@ class Workspace(LanguageServerProtocolPart, CoreWorkspace, FileWatcherManagerBas
         self._settings_cache.clear()
         self.did_change_configuration(self, settings)
 
-    @event
-    def will_create_files(sender, files: List[str]) -> Optional[Mapping[str, List[TextEdit]]]: ...
+    # The will* events and their handlers stay commented out until the server returns edits for them, see
+    # extend_capabilities.
+    # @event
+    # def will_create_files(sender, files: List[str]) -> Optional[Mapping[str, List[TextEdit]]]: ...
 
     @event
     def did_create_files(sender, files: List[str]) -> None: ...
 
-    @event
-    def will_rename_files(sender, files: List[Tuple[str, str]]) -> None: ...
+    # @event
+    # def will_rename_files(sender, files: List[Tuple[str, str]]) -> None: ...
 
     @event
     def did_rename_files(sender, files: List[Tuple[str, str]]) -> None: ...
 
-    @event
-    def will_delete_files(sender, files: List[str]) -> None: ...
+    # @event
+    # def will_delete_files(sender, files: List[str]) -> None: ...
 
     @event
     def did_delete_files(sender, files: List[str]) -> None: ...
 
-    @rpc_method(name="workspace/willCreateFiles", param_type=CreateFilesParams, threaded=True)
-    def _workspace_will_create_files(
-        self, files: List[FileCreate], *args: Any, **kwargs: Any
-    ) -> Optional[WorkspaceEdit]:
-        results = self.will_create_files(self, [f.uri for f in files])
-        if len(results) == 0:
-            return None
-
-        result: Dict[str, List[TextEdit]] = {}
-        for e in results:
-            if e is not None and isinstance(e, Mapping):
-                result.update(e)
-
-        # TODO: support full WorkspaceEdit
-
-        return WorkspaceEdit(changes=result)
+    # @rpc_method(name="workspace/willCreateFiles", param_type=CreateFilesParams, threaded=True)
+    # def _workspace_will_create_files(
+    #     self, files: List[FileCreate], *args: Any, **kwargs: Any
+    # ) -> Optional[WorkspaceEdit]:
+    #     results = self.will_create_files(self, [f.uri for f in files])
+    #     if len(results) == 0:
+    #         return None
+    #
+    #     result: Dict[str, List[TextEdit]] = {}
+    #     for e in results:
+    #         if e is not None and isinstance(e, Mapping):
+    #             result.update(e)
+    #
+    #     # TODO: support full WorkspaceEdit
+    #
+    #     return WorkspaceEdit(changes=result)
 
     @rpc_method(name="workspace/didCreateFiles", param_type=CreateFilesParams, threaded=True)
     def _workspace_did_create_files(self, files: List[FileCreate], *args: Any, **kwargs: Any) -> None:
         self.did_create_files(self, [f.uri for f in files])
 
-    @rpc_method(name="workspace/willRenameFiles", param_type=RenameFilesParams, threaded=True)
-    def _workspace_will_rename_files(self, files: List[FileRename], *args: Any, **kwargs: Any) -> None:
-        self.will_rename_files(self, [(f.old_uri, f.new_uri) for f in files])
-
-        # TODO: return WorkspaceEdit
+    # @rpc_method(name="workspace/willRenameFiles", param_type=RenameFilesParams, threaded=True)
+    # def _workspace_will_rename_files(self, files: List[FileRename], *args: Any, **kwargs: Any) -> None:
+    #     self.will_rename_files(self, [(f.old_uri, f.new_uri) for f in files])
+    #
+    #     # TODO: return WorkspaceEdit
 
     @rpc_method(name="workspace/didRenameFiles", param_type=RenameFilesParams, threaded=True)
     def _workspace_did_rename_files(self, files: List[FileRename], *args: Any, **kwargs: Any) -> None:
         self.did_rename_files(self, [(f.old_uri, f.new_uri) for f in files])
 
-    @rpc_method(name="workspace/willDeleteFiles", param_type=DeleteFilesParams, threaded=True)
-    def _workspace_will_delete_files(self, files: List[FileDelete], *args: Any, **kwargs: Any) -> None:
-        self.will_delete_files(self, [f.uri for f in files])
-
-        # TODO: return WorkspaceEdit
+    # @rpc_method(name="workspace/willDeleteFiles", param_type=DeleteFilesParams, threaded=True)
+    # def _workspace_will_delete_files(self, files: List[FileDelete], *args: Any, **kwargs: Any) -> None:
+    #     self.will_delete_files(self, [f.uri for f in files])
+    #
+    #     # TODO: return WorkspaceEdit
 
     @rpc_method(name="workspace/didDeleteFiles", param_type=DeleteFilesParams, threaded=True)
     def _workspace_did_delete_files(self, files: List[FileDelete], *args: Any, **kwargs: Any) -> None:

robotcode/language_server/common/protocol.py

@@ -151,7 +151,9 @@ class LanguageServerProtocol(JsonRPCProtocol):
                 open_close=True,
                 change=TextDocumentSyncKind.INCREMENTAL,
                 will_save=True,
-                will_save_wait_until=True,
+                # willSaveWaitUntil stays unregistered until the server returns edits for it: clients wait for its
+                # answer before they save.
+                # will_save_wait_until=True,
                 save=SaveOptions(include_text=True),
             )
         )

robotcode/language_server/robotframework/configuration.py

@@ -25,6 +25,8 @@ class LanguageServerConfig(ConfigBase):
 class CompletionConfig(ConfigBase):
     filter_default_language: bool = False
     header_style: Optional[str] = None
+    hide_private_keywords: bool = True
+    hide_deprecated_keywords: bool = False
 
 
 @config_section("robotcode.robocop")
@@ -61,6 +63,7 @@ class AnalysisConfig(ConfigBase):
     progress_mode: AnalysisProgressMode = AnalysisProgressMode.OFF
     references_code_lens: bool = False
     find_unused_references: bool = False
+    file_check_interval: int = 5
     cache: CacheConfig = field(default_factory=CacheConfig)
     robot: AnalysisRobotConfig = field(default_factory=AnalysisRobotConfig)
     modifiers: AnalysisDiagnosticModifiersConfig = field(default_factory=AnalysisDiagnosticModifiersConfig)