robotcode-language-server 1.3.0.dev3__tar.gz → 1.3.0.dev5__tar.gz

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotcode-language-server
-Version: 1.3.0.dev3
+Version: 1.3.0.dev5
 Summary: RobotCode Language Server for Robot Framework
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -25,10 +25,10 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
-Requires-Dist: robotcode-analyze==1.3.0-dev.3
-Requires-Dist: robotcode-jsonrpc2==1.3.0-dev.3
-Requires-Dist: robotcode-robot==1.3.0-dev.3
-Requires-Dist: robotcode==1.3.0-dev.3
+Requires-Dist: robotcode-analyze==1.3.0-dev.5
+Requires-Dist: robotcode-jsonrpc2==1.3.0-dev.5
+Requires-Dist: robotcode-robot==1.3.0-dev.5
+Requires-Dist: robotcode==1.3.0-dev.5
 Requires-Dist: robotframework>=4.1.0
 Description-Content-Type: text/markdown
 

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/pyproject.toml

@@ -27,10 +27,10 @@ classifiers = [
 ]
 dependencies = [
   "robotframework>=4.1.0",
-  "robotcode-jsonrpc2==1.3.0-dev.3",
-  "robotcode-robot==1.3.0-dev.3",
-  "robotcode-analyze==1.3.0-dev.3",
-  "robotcode==1.3.0-dev.3",
+  "robotcode-jsonrpc2==1.3.0-dev.5",
+  "robotcode-robot==1.3.0-dev.5",
+  "robotcode-analyze==1.3.0-dev.5",
+  "robotcode==1.3.0-dev.5",
 ]
 dynamic = ["version"]
 

robotcode_language_server-1.3.0.dev5/src/robotcode/language_server/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.3.0-dev.5"

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/configuration.py

@@ -52,7 +52,7 @@ class RoboTidyConfig(ConfigBase):
 class DocumentationServerConfig(ConfigBase):
     start_port: int = 3100
     end_port: int = 3199
-    start_on_demand: bool = True
+    start_on_demand: bool = False
 
 
 @config_section("robotcode.inlayHints")

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/parts/formatting.py

@@ -39,7 +39,7 @@ class RobotFormattingProtocolPart(RobotLanguageServerProtocolPart, RoboCopTidyMi
         self.line_separator = os.linesep
         self.short_test_name_length = 18
         self.setting_and_variable_name_length = 14
-        self.robocop_installed_message_shown = False
+        self.is_robocop_notification_shown = False
 
     def get_tidy_config(self, document: TextDocument) -> RoboTidyConfig:
         folder = self.parent.workspace.get_workspace_folder(document.uri)
@@ -65,14 +65,15 @@ class RobotFormattingProtocolPart(RobotLanguageServerProtocolPart, RoboCopTidyMi
         **further_options: Any,
     ) -> Optional[List[TextEdit]]:
         if (get_robot_version() >= (5, 0)) and self.robocop_installed and self.robocop_version >= (6, 0):
-            if not self.robocop_installed_message_shown and self.robotidy_installed:
+            if not self.is_robocop_notification_shown and self.robotidy_installed:
                 self.parent.window.show_message(
-                    "`robotframework-robocop >= 6.0` is installed and will be used for formatting.\n"
-                    "`robotframework-tidy` is also detected in the workspace. "
-                    "It is not needed as `robocop` handles formatting tasks.\n",
+                    "`robotframework-robocop >= 6.0` is installed and will be used for formatting.\n\n"
+                    "`robotframework-tidy` is also detected in the workspace, but its use is redundant.\n"
+                    "Robocop fully supports all formatting tasks and provides a more comprehensive solution.\n\n"
+                    "Note: The use of `robotframework-tidy` is deprecated and should be avoided in favor of Robocop.",
                     MessageType.INFO,
                 )
-                self.robocop_installed_message_shown = True
+                self.is_robocop_notification_shown = True
 
             return self.format_robocop(document, options, **further_options)
 

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/parts/hover.py

@@ -163,7 +163,7 @@ class RobotHoverProtocolPart(RobotLanguageServerProtocolPart, ModelHelper):
                     else:
                         value = ""
 
-                    text = f"### {variable.type.value.title()} `{variable.name}`\n\n"
+                    text = f"### {variable.type.value.title()} `{variable.convertable_name}`\n\n"
 
                     if value:
                         text += "```python\n"

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/parts/keywords_treeview.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, List, Optional
 
 from robotcode.core.lsp.types import TextDocumentIdentifier
+from robotcode.core.uri import Uri
 from robotcode.core.utils.dataclasses import CamelSnakeMixin
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
@@ -16,6 +17,26 @@ if TYPE_CHECKING:
 @dataclass(repr=False)
 class GetDocumentImportsParams(CamelSnakeMixin):
     text_document: TextDocumentIdentifier
+    no_documentation: Optional[bool] = None
+
+
+@dataclass(repr=False)
+class GetDocumentKeywordsParams(CamelSnakeMixin):
+    text_document: TextDocumentIdentifier
+    no_documentation: Optional[bool] = None
+
+
+@dataclass(repr=False)
+class GetLibraryDocumentationParams(CamelSnakeMixin):
+    workspace_folder_uri: str
+    library_name: str
+
+
+@dataclass(repr=False)
+class GetKeywordDocumentationParams(CamelSnakeMixin):
+    workspace_folder_uri: str
+    library_name: str
+    keyword_name: str
 
 
 @dataclass(repr=False)
@@ -26,6 +47,14 @@ class Keyword(CamelSnakeMixin):
     documentation: Optional[str] = None
 
 
+@dataclass(repr=False)
+class LibraryDocumentation(CamelSnakeMixin):
+    name: str
+    documentation: Optional[str] = None
+    keywords: Optional[List[Keyword]] = None
+    initializers: Optional[List[Keyword]] = None
+
+
 @dataclass(repr=False)
 class DocumentImport(CamelSnakeMixin):
     name: str
@@ -54,6 +83,7 @@ class RobotKeywordsTreeViewPart(RobotLanguageServerProtocolPart, ModelHelper):
     def _get_document_imports(
         self,
         text_document: TextDocumentIdentifier,
+        no_documentation: Optional[bool] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Optional[List[DocumentImport]]:
@@ -72,16 +102,18 @@ class RobotKeywordsTreeViewPart(RobotLanguageServerProtocolPart, ModelHelper):
                     alias=v.alias,
                     id=str(hash(v)),
                     type="library",
-                    documentation=v.library_doc.to_markdown(add_signature=False),
+                    documentation=v.library_doc.to_markdown(add_signature=False) if not no_documentation else None,
                     keywords=[
                         Keyword(
                             l.name,
                             str(hash(l)),
                             l.parameter_signature(),
-                            l.to_markdown(add_signature=False),
+                            l.to_markdown(add_signature=False) if not no_documentation else None,
                         )
                         for l in v.library_doc.keywords.values()
-                    ],
+                    ]
+                    if not no_documentation
+                    else None,
                 )
             )
         for _k, v in namespace.get_resources().items():
@@ -91,21 +123,29 @@ class RobotKeywordsTreeViewPart(RobotLanguageServerProtocolPart, ModelHelper):
                     alias=None,
                     id=str(hash(v)),
                     type="resource",
-                    documentation=v.library_doc.to_markdown(add_signature=False),
+                    documentation=v.library_doc.to_markdown(add_signature=False) if not no_documentation else None,
                     keywords=[
-                        Keyword(l.name, str(hash(l)), l.parameter_signature(), l.to_markdown(add_signature=False))
+                        Keyword(
+                            l.name,
+                            str(hash(l)),
+                            l.parameter_signature(),
+                            l.to_markdown(add_signature=False) if not no_documentation else None,
+                        )
                         for l in v.library_doc.keywords.values()
-                    ],
+                    ]
+                    if not no_documentation
+                    else None,
                 )
             )
 
         return result
 
-    @rpc_method(name="robot/keywordsview/getDocumentKeywords", param_type=GetDocumentImportsParams, threaded=True)
+    @rpc_method(name="robot/keywordsview/getDocumentKeywords", param_type=GetDocumentKeywordsParams, threaded=True)
     @_logger.call
     def _get_document_keywords(
         self,
         text_document: TextDocumentIdentifier,
+        no_documentation: Optional[bool] = None,
         *args: Any,
         **kwargs: Any,
     ) -> Optional[List[Keyword]]:
@@ -116,7 +156,12 @@ class RobotKeywordsTreeViewPart(RobotLanguageServerProtocolPart, ModelHelper):
         namespace = self.parent.documents_cache.get_namespace(document)
 
         return [
-            Keyword(l.name, str(hash(l)), l.parameter_signature(), l.to_markdown(add_signature=False))
+            Keyword(
+                l.name,
+                str(hash(l)),
+                l.parameter_signature(),
+                l.to_markdown(add_signature=False) if not no_documentation else None,
+            )
             for l in namespace.get_library_doc().keywords.values()
         ]
 
@@ -165,3 +210,72 @@ class RobotKeywordsTreeViewPart(RobotLanguageServerProtocolPart, ModelHelper):
             )
 
         return None
+
+    @rpc_method(
+        name="robot/keywordsview/getLibraryDocumentation", param_type=GetLibraryDocumentationParams, threaded=True
+    )
+    @_logger.call
+    def _get_library_documentation(
+        self,
+        workspace_folder_uri: str,
+        library_name: str,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[LibraryDocumentation]:
+        imports_manager = self.parent.documents_cache.get_imports_manager_for_uri(Uri(workspace_folder_uri))
+
+        libdoc = imports_manager.get_libdoc_for_library_import(library_name, (), ".")
+        if libdoc.errors:
+            raise ValueError(f"Errors while loading library documentation: {libdoc.errors}")
+
+        return LibraryDocumentation(
+            name=libdoc.name,
+            documentation=libdoc.to_markdown(),
+            keywords=[
+                Keyword(
+                    l.name,
+                    str(hash(l)),
+                    l.parameter_signature(),
+                    l.to_markdown(),
+                )
+                for l in libdoc.keywords.values()
+            ],
+            initializers=[
+                Keyword(
+                    s.name,
+                    str(hash(s)),
+                    s.parameter_signature(),
+                    s.to_markdown(),
+                )
+                for s in libdoc.inits.values()
+            ],
+        )
+
+    @rpc_method(
+        name="robot/keywordsview/getKeywordDocumentation", param_type=GetKeywordDocumentationParams, threaded=True
+    )
+    @_logger.call
+    def _get_keyword_documentation(
+        self,
+        workspace_folder_uri: str,
+        library_name: str,
+        keyword_name: str,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[Keyword]:
+        imports_manager = self.parent.documents_cache.get_imports_manager_for_uri(Uri(workspace_folder_uri))
+
+        libdoc = imports_manager.get_libdoc_for_library_import(library_name, (), ".")
+        if libdoc.errors:
+            raise ValueError(f"Errors while loading library documentation: {libdoc.errors}")
+
+        kw = libdoc.keywords.get(keyword_name, None)
+        if kw is None:
+            raise ValueError(f"Keyword '{keyword_name}' not found in library '{library_name}'.")
+
+        return Keyword(
+            name=kw.name,
+            id=str(hash(kw)),
+            signature=kw.parameter_signature(),
+            documentation=kw.to_markdown(),
+        )

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/parts/project_info.py

@@ -1,3 +1,4 @@
+import sys
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Optional
 
@@ -7,6 +8,7 @@ from robotcode.core.utils.dataclasses import CamelSnakeMixin
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 
+from ...__version__ import __version__ as robotcode_version
 from .protocol_part import RobotLanguageServerProtocolPart
 from .robocop_tidy_mixin import RoboCopTidyMixin
 
@@ -19,6 +21,9 @@ class ProjectInfo(CamelSnakeMixin):
     robot_version_string: str
     robocop_version_string: Optional[str]
     tidy_version_string: Optional[str] = None
+    python_version_string: Optional[str] = None
+    python_executable: Optional[str] = None
+    robot_code_version_string: Optional[str] = None
 
 
 class ProjectInfoPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
@@ -46,4 +51,7 @@ class ProjectInfoPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
             robot_version_string=get_version(),
             robocop_version_string=robocop_version_string,
             tidy_version_string=tidy_version_string,
+            python_version_string=sys.version,
+            python_executable=sys.executable,
+            robot_code_version_string=robotcode_version,
         )

{robotcode_language_server-1.3.0.dev3 → robotcode_language_server-1.3.0.dev5}/src/robotcode/language_server/robotframework/parts/semantic_tokens.py

@@ -471,7 +471,9 @@ class RobotSemanticTokenProtocolPart(RobotLanguageServerProtocolPart):
                         sem_mod.add(RobotSemTokenModifiers.BUILTIN)
 
                 if kw_doc is not None and kw_doc.is_embedded and kw_doc.matcher.embedded_arguments:
-                    if get_robot_version() >= (6, 0):
+                    if get_robot_version() >= (7, 3):
+                        m = kw_doc.matcher.embedded_arguments.name.fullmatch(kw)
+                    elif get_robot_version() >= (6, 0):
                         m = kw_doc.matcher.embedded_arguments.match(kw)
                     else:
                         m = kw_doc.matcher.embedded_arguments.name.match(kw)

robotcode_language_server-1.3.0.dev3/src/robotcode/language_server/__version__.py

@@ -1 +0,0 @@
-__version__ = "1.3.0-dev.3"