fix: made RobotCode work with Python 3.12

Because of some changes in `runtime_protocols', see python doc

Author: d-biehl

hatch.toml

@@ -48,10 +48,10 @@ extra-dependencies = [
   "robotframework @ git+https://github.com/robotframework/robotframework.git",
 ]
 
-[envs.py312_rfmaster]
+[envs.py312_latest]
 python = "3.12"
 extra-dependencies = [
-  "robotframework @ git+https://github.com/robotframework/robotframework.git",
+  "robotframework==6.1.1",
 ]
 
 [envs.rfdevel]

packages/core/src/robotcode/core/dataclasses.py

@@ -105,11 +105,6 @@ def _decode_case(cls, s: str) -> str:  # pragma: no cover
         ...
 
 
-@runtime_checkable
-class ConfigBase(HasCaseDecoder, HasCaseEncoder, Protocol):
-    pass
-
-
 _T = TypeVar("_T")
 
 

packages/core/src/robotcode/core/utils/inspect.py

@@ -1,5 +1,5 @@
 import inspect
-from typing import Any, Callable, Coroutine, Iterator, List, Optional
+from typing import Any, Callable, Coroutine, Iterator, Optional
 
 
 def iter_methods(
@@ -22,13 +22,6 @@ def iter_methods(
                 yield m
 
 
-def get_methods(
-    instance_or_type: Any,
-    predicate: Optional[Callable[[Callable[..., Any]], bool]] = None,
-) -> List[Callable[..., Any]]:
-    return list(iter_methods(instance_or_type, predicate))
-
-
 _lambda_type = type(lambda: 0)
 _lambda_name = (lambda: 0).__name__
 

packages/jsonrpc2/src/robotcode/jsonrpc2/protocol.py

@@ -154,6 +154,8 @@ class RpcMethodEntry(NamedTuple):
 
 @runtime_checkable
 class RpcMethod(Protocol):
+    __slots__ = "__rpc_method__"
+
     __rpc_method__: RpcMethodEntry
 
 
@@ -264,7 +266,12 @@ def get_methods(obj: Any) -> Dict[str, RpcMethodEntry]:
                 )
                 for method, rpc_method in map(
                     lambda m1: (m1, cast(RpcMethod, m1)),
-                    filter(lambda m2: isinstance(m2, RpcMethod), iter_methods(obj)),
+                    iter_methods(
+                        obj,
+                        lambda m2: isinstance(m2, RpcMethod)
+                        or inspect.ismethod(m2)
+                        and isinstance(m2.__func__, RpcMethod),
+                    ),
                 )
             }
 
@@ -761,7 +768,13 @@ async def handle_request(self, message: JsonRPCRequest) -> None:
 
         params = self._convert_params(e.method, e.param_type, message.params)
 
-        if isinstance(e.method, HasThreaded) and e.method.__threaded__:
+        if (
+            isinstance(e.method, HasThreaded)
+            and e.method.__threaded__
+            or inspect.ismethod(e.method)
+            and isinstance(e.method.__func__, HasThreaded)
+            and e.method.__func__.__threaded__
+        ):
             task = run_coroutine_in_thread(
                 ensure_coroutine(cast(Callable[..., Any], e.method)), *params[0], **params[1]
             )
@@ -826,7 +839,13 @@ async def handle_notification(self, message: JsonRPCNotification) -> None:
         try:
             params = self._convert_params(e.method, e.param_type, message.params)
 
-            if isinstance(e.method, HasThreaded) and e.method.__threaded__:
+            if (
+                isinstance(e.method, HasThreaded)
+                and e.method.__threaded__
+                or inspect.ismethod(e.method)
+                and isinstance(e.method.__func__, HasThreaded)
+                and e.method.__func__.__threaded__
+            ):
                 task = run_coroutine_in_thread(
                     ensure_coroutine(cast(Callable[..., Any], e.method)), *params[0], **params[1]
                 )

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

@@ -1,26 +1,26 @@
-from typing import Any, Callable, List, Protocol, Set, TypeVar, Union, runtime_checkable
+from typing import Any, Callable, List, Protocol, TypeVar, Union, runtime_checkable
 
 from .text_document import TextDocument
 
 _F = TypeVar("_F", bound=Callable[..., Any])
 
+LANGUAGE_ID_ATTR = "__language_id__"
+
 
 def language_id(id: str, *ids: str) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__language_id__", {id, *ids})
+        setattr(func, LANGUAGE_ID_ATTR, {id, *ids})
         return func
 
     return decorator
 
 
-@runtime_checkable
-class HasLanguageId(Protocol):
-    __language_id__: Set[str]
+TRIGGER_CHARACTERS_ATTR = "__trigger_characters__"
 
 
 def trigger_characters(characters: List[str]) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__trigger_characters__", characters)
+        setattr(func, TRIGGER_CHARACTERS_ATTR, characters)
         return func
 
     return decorator
@@ -31,22 +31,28 @@ class HasTriggerCharacters(Protocol):
     __trigger_characters__: List[str]
 
 
+RETRIGGER_CHARACTERS_ATTR = "__retrigger_characters__"
+
+
 @runtime_checkable
 class HasRetriggerCharacters(Protocol):
     __retrigger_characters__: str
 
 
 def retrigger_characters(characters: List[str]) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__retrigger_characters__", characters)
+        setattr(func, RETRIGGER_CHARACTERS_ATTR, characters)
         return func
 
     return decorator
 
 
+ALL_COMMIT_CHARACTERS_ATTR = "__all_commit_characters__"
+
+
 def all_commit_characters(characters: List[str]) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__all_commit_characters__", characters)
+        setattr(func, ALL_COMMIT_CHARACTERS_ATTR, characters)
         return func
 
     return decorator
@@ -57,9 +63,12 @@ class HasAllCommitCharacters(Protocol):
     __all_commit_characters__: List[str]
 
 
+CODE_ACTION_KINDS_ATTR = "__code_action_kinds__"
+
+
 def code_action_kinds(characters: List[str]) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__code_action_kinds__", characters)
+        setattr(func, CODE_ACTION_KINDS_ATTR, characters)
         return func
 
     return decorator
@@ -72,33 +81,35 @@ class HasCodeActionKinds(Protocol):
 
 def language_id_filter(language_id_or_document: Union[str, TextDocument]) -> Callable[[Any], bool]:
     def filter(c: Any) -> bool:
-        return not isinstance(c, HasLanguageId) or (
+        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 c.__language_id__
+            in getattr(c, LANGUAGE_ID_ATTR)
         )
 
     return filter
 
 
-@runtime_checkable
-class IsCommand(Protocol):
-    __command_name__: str
+COMMAND_NAME_ATTR = "__command_name__"
 
 
 def command(name: str) -> Callable[[_F], _F]:
     def decorator(func: _F) -> _F:
-        setattr(func, "__command_name__", name)
+        setattr(func, COMMAND_NAME_ATTR, name)
         return func
 
     return decorator
 
 
+def is_command(func: Callable[..., Any]) -> bool:
+    return hasattr(func, COMMAND_NAME_ATTR)
+
+
 def get_command_name(func: Callable[..., Any]) -> str:
-    if isinstance(func, IsCommand):
-        return func.__command_name__  # type: ignore
+    if hasattr(func, COMMAND_NAME_ATTR):
+        return str(getattr(func, COMMAND_NAME_ATTR))
 
     raise TypeError(f"{func} is not a command.")

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

@@ -17,7 +17,7 @@
     TextDocumentIdentifier,
 )
 from robotcode.jsonrpc2.protocol import rpc_method
-from robotcode.language_server.common.decorators import HasCodeActionKinds, language_id_filter
+from robotcode.language_server.common.decorators import CODE_ACTION_KINDS_ATTR, HasCodeActionKinds, language_id_filter
 from robotcode.language_server.common.has_extend_capabilities import HasExtendCapabilities
 from robotcode.language_server.common.parts.protocol_part import LanguageServerProtocolPart
 from robotcode.language_server.common.text_document import TextDocument
@@ -49,7 +49,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                     *[
                         cast(HasCodeActionKinds, e).__code_action_kinds__
                         for e in self.collect
-                        if isinstance(e, HasCodeActionKinds)
+                        if hasattr(e, CODE_ACTION_KINDS_ATTR)
                     ]
                 )
             )

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

@@ -17,7 +17,7 @@
     ServerCapabilities,
 )
 from robotcode.jsonrpc2.protocol import JsonRPCErrorException, rpc_method
-from robotcode.language_server.common.decorators import IsCommand, get_command_name
+from robotcode.language_server.common.decorators import get_command_name, is_command
 from robotcode.language_server.common.has_extend_capabilities import HasExtendCapabilities
 from robotcode.language_server.common.parts.protocol_part import LanguageServerProtocolPart
 
@@ -60,7 +60,7 @@ def register_all(self, instance: object) -> None:
             getattr(instance, k) for k, v in type(instance).__dict__.items() if callable(v) and not k.startswith("_")
         ]
         for method in all_methods:
-            if isinstance(method, IsCommand):
+            if is_command(method):
                 self.register(cast(_FUNC_TYPE, method))
 
     def get_command_name(self, callback: _FUNC_TYPE, name: Optional[str] = None) -> str:

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

@@ -19,7 +19,13 @@
     TextEdit,
 )
 from robotcode.jsonrpc2.protocol import rpc_method
-from robotcode.language_server.common.decorators import HasAllCommitCharacters, HasTriggerCharacters, language_id_filter
+from robotcode.language_server.common.decorators import (
+    ALL_COMMIT_CHARACTERS_ATTR,
+    TRIGGER_CHARACTERS_ATTR,
+    HasAllCommitCharacters,
+    HasTriggerCharacters,
+    language_id_filter,
+)
 from robotcode.language_server.common.has_extend_capabilities import HasExtendCapabilities
 from robotcode.language_server.common.parts.protocol_part import LanguageServerProtocolPart
 from robotcode.language_server.common.text_document import TextDocument
@@ -51,7 +57,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                     *[
                         cast(HasTriggerCharacters, e).__trigger_characters__
                         for e in self.collect
-                        if isinstance(e, HasTriggerCharacters)
+                        if hasattr(e, TRIGGER_CHARACTERS_ATTR)
                     ]
                 )
             )
@@ -61,7 +67,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                     *[
                         cast(HasAllCommitCharacters, e).__all_commit_characters__
                         for e in self.collect
-                        if isinstance(e, HasAllCommitCharacters)
+                        if hasattr(e, ALL_COMMIT_CHARACTERS_ATTR)
                     ]
                 )
             )

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

@@ -18,7 +18,7 @@
 )
 from robotcode.jsonrpc2.protocol import rpc_method
 from robotcode.language_server.common.decorators import (
-    HasLanguageId,
+    LANGUAGE_ID_ATTR,
     language_id_filter,
 )
 from robotcode.language_server.common.has_extend_capabilities import (
@@ -52,8 +52,8 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
         if len(self.collect):
             document_filters: DocumentSelector = []
             for e in self.collect:
-                if isinstance(e, HasLanguageId):
-                    for lang_id in e.__language_id__:  # type: ignore
+                if hasattr(e, LANGUAGE_ID_ATTR):
+                    for lang_id in getattr(e, LANGUAGE_ID_ATTR):
                         document_filters.append(TextDocumentFilterType1(language=lang_id))
             capabilities.inline_value_provider = InlineValueRegistrationOptions(
                 work_done_progress=True,

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

@@ -16,7 +16,13 @@
     TextDocumentIdentifier,
 )
 from robotcode.jsonrpc2.protocol import rpc_method
-from robotcode.language_server.common.decorators import HasRetriggerCharacters, HasTriggerCharacters, language_id_filter
+from robotcode.language_server.common.decorators import (
+    RETRIGGER_CHARACTERS_ATTR,
+    TRIGGER_CHARACTERS_ATTR,
+    HasRetriggerCharacters,
+    HasTriggerCharacters,
+    language_id_filter,
+)
 from robotcode.language_server.common.has_extend_capabilities import HasExtendCapabilities
 from robotcode.language_server.common.text_document import TextDocument
 
@@ -45,7 +51,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                     *[
                         cast(HasTriggerCharacters, e).__trigger_characters__
                         for e in self.collect
-                        if isinstance(e, HasTriggerCharacters)
+                        if hasattr(e, TRIGGER_CHARACTERS_ATTR)
                     ]
                 )
             )
@@ -55,7 +61,7 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                     *[
                         cast(HasRetriggerCharacters, e).__retrigger_characters__
                         for e in self.collect
-                        if isinstance(e, HasRetriggerCharacters)
+                        if hasattr(e, RETRIGGER_CHARACTERS_ATTR)
                     ]
                 )
             )