refactor(langserver): move TextDocument from langserver to core package, some other simple refactorings

Author: d-biehl

packages/language_server/src/robotcode/language_server/common/text_document.py renamed to packages/core/src/robotcode/core/text_document.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import collections
 import inspect
 import io
@@ -17,6 +15,8 @@
     cast,
 )
 
+from typing_extensions import Self
+
 from robotcode.core.event import event
 from robotcode.core.lsp.types import DocumentUri, Position, Range
 from robotcode.core.uri import Uri
@@ -244,7 +244,7 @@ def __get_cache_reference(self, entry: Callable[..., Any], /, *, add_remove: boo
 
         return weakref.ref(entry, self.__remove_cache_entry if add_remove else None)
 
-    def get_cache_value(self, entry: Callable[[TextDocument], _T]) -> Optional[_T]:
+    def get_cache_value(self, entry: Callable[[Self], _T]) -> Optional[_T]:
         reference = self.__get_cache_reference(entry)
 
         e = self._cache.get(reference, None)
@@ -255,7 +255,7 @@ def get_cache_value(self, entry: Callable[[TextDocument], _T]) -> Optional[_T]:
 
     def get_cache(
         self,
-        entry: Union[Callable[[TextDocument], _T], Callable[..., _T]],
+        entry: Union[Callable[[Self], _T], Callable[..., _T]],
         *args: Any,
         **kwargs: Any,
     ) -> _T:
@@ -270,7 +270,7 @@ def get_cache(
 
             return cast(_T, e.data)
 
-    def remove_cache_entry(self, entry: Union[Callable[[TextDocument], _T], Callable[..., _T]]) -> None:
+    def remove_cache_entry(self, entry: Union[Callable[[Self], _T], Callable[..., _T]]) -> None:
         self.__remove_cache_entry(self.__get_cache_reference(entry, add_remove=False))
 
     def set_data(self, key: Any, data: Any) -> None:

packages/language_server/src/robotcode/language_server/common/decorators.py

@@ -9,8 +9,7 @@
 )
 
 from robotcode.core.lsp.types import CodeActionKind
-
-from .text_document import TextDocument
+from robotcode.core.text_document import TextDocument
 
 _F = TypeVar("_F", bound=Callable[..., Any])
 
@@ -25,6 +24,22 @@ def decorator(func: _F) -> _F:
     return decorator
 
 
+def language_id_filter(
+    language_id_or_document: Union[str, TextDocument],
+) -> Callable[[Any], bool]:
+    def filter(c: Any) -> bool:
+        return not hasattr(c, LANGUAGE_ID_ATTR) or (
+            (
+                language_id_or_document.language_id
+                if isinstance(language_id_or_document, TextDocument)
+                else language_id_or_document
+            )
+            in getattr(c, LANGUAGE_ID_ATTR)
+        )
+
+    return filter
+
+
 TRIGGER_CHARACTERS_ATTR = "__trigger_characters__"
 
 
@@ -91,22 +106,6 @@ class HasCodeActionKinds(Protocol):
     __code_action_kinds__: List[str]
 
 
-def language_id_filter(
-    language_id_or_document: Union[str, TextDocument],
-) -> Callable[[Any], bool]:
-    def filter(c: Any) -> bool:
-        return not hasattr(c, LANGUAGE_ID_ATTR) or (
-            (
-                language_id_or_document.language_id
-                if isinstance(language_id_or_document, TextDocument)
-                else language_id_or_document
-            )
-            in getattr(c, LANGUAGE_ID_ATTR)
-        )
-
-    return filter
-
-
 COMMAND_ID_ATTR = "__command_name__"
 
 

packages/language_server/src/robotcode/language_server/common/parts/code_action.py

@@ -14,6 +14,7 @@
     ServerCapabilities,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import (
@@ -24,7 +25,6 @@
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/code_lens.py

@@ -11,10 +11,10 @@
     ServerCapabilities,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
-from robotcode.language_server.common.text_document import TextDocument
 
 from .protocol_part import LanguageServerProtocolPart
 

packages/language_server/src/robotcode/language_server/common/parts/completion.py

@@ -18,6 +18,7 @@
     TextDocumentIdentifier,
     TextEdit,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import (
@@ -30,7 +31,6 @@
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/declaration.py

@@ -11,13 +11,13 @@
     ServerCapabilities,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/definition.py

@@ -11,13 +11,13 @@
     ServerCapabilities,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/diagnostics.py

@@ -26,14 +26,14 @@
     WorkspaceDiagnosticParams,
     WorkspaceDiagnosticReport,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.uri import Uri
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import JsonRPCErrorException, rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/document_highlight.py

@@ -11,13 +11,13 @@
     ServerCapabilities,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol

packages/language_server/src/robotcode/language_server/common/parts/document_symbols.py

@@ -25,13 +25,13 @@
     SymbolInformation,
     TextDocumentIdentifier,
 )
+from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import language_id_filter
 from robotcode.language_server.common.parts.protocol_part import (
     LanguageServerProtocolPart,
 )
-from robotcode.language_server.common.text_document import TextDocument
 
 if TYPE_CHECKING:
     from robotcode.language_server.common.protocol import LanguageServerProtocol