feat(langserver): better signature help and completion of keyword arguments and library import arguments, including completions for type converters like Enums, bools, TypedDict, ...

Author: d-biehl

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -439,7 +439,7 @@ def resolve(
         resolve_variables_until: Any = None,
         dict_to_kwargs: bool = False,
         validate: bool = True,
-    ) -> Tuple[List[Any], Dict[str, Any]]:
+    ) -> Tuple[List[Any], List[Tuple[str, Any]]]:
         from robot.running.arguments.argumentresolver import (
             ArgumentResolver,
             DictToKwargs,
@@ -470,7 +470,7 @@ def resolve(
                 resolve_variables_until=resolve_variables_until,
                 dict_to_kwargs=dict_to_kwargs,
             )
-            return cast(Tuple[List[Any], Dict[str, Any]], resolver.resolve(arguments, variables))
+            return cast(Tuple[List[Any], List[Tuple[str, Any]]], resolver.resolve(arguments, variables))
 
         positional, named = NamedArgumentResolver(self.__robot_arguments).resolve(arguments, variables)
         positional, named = VariableReplacer(resolve_variables_until).replace(positional, named, variables)
@@ -626,7 +626,10 @@ def to_markdown(self, add_signature: bool = True, header_level: int = 2, add_typ
 
     def _get_signature(self, header_level: int, add_type: bool = True) -> str:
         if add_type:
-            result = f"#{'#'*header_level} {'Library' if self.is_initializer else 'Keyword'} *{self.name}*\n"
+            result = (
+                f"#{'#'*header_level} "
+                f"{(self.libtype or 'Library').capitalize() if self.is_initializer else 'Keyword'} *{self.name}*\n"
+            )
         else:
             if not self.is_initializer:
                 result = f"\n\n#{'#'*header_level} {self.name}\n"
@@ -1971,7 +1974,7 @@ def _get_initial_handler(self, library: Any, name: Any, method: Any) -> Any:
                                 col_offset=-1,
                                 end_col_offset=-1,
                                 end_line_no=-1,
-                                type="library",
+                                type="variables",
                                 libname=libdoc.name,
                                 libtype=libdoc.type,
                                 longname=f"{libdoc.name}.{kw[0].name}",
@@ -2008,7 +2011,7 @@ def _get_initial_handler(self, library: Any, name: Any, method: Any) -> Any:
                                     col_offset=-1,
                                     end_col_offset=-1,
                                     end_line_no=-1,
-                                    type="library",
+                                    type="variables",
                                     libname=libdoc.name,
                                     libtype=libdoc.type,
                                     longname=f"{libdoc.name}.{kw[0].name}",

packages/language_server/src/robotcode/language_server/robotframework/languages.py

@@ -7,6 +7,8 @@ class Languages(Protocol):
     headers: Dict[str, str]
     settings: Dict[str, str]
     bdd_prefixes: Set[str]
+    true_strings: Set[str]
+    false_strings: Set[str]
 
     def add_language(self, name: str) -> None:
         ...

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

@@ -645,7 +645,7 @@ def get_argument_info_at_position(
         tokens: Tuple[Token, ...],
         token_at_position: Token,
         position: Position,
-    ) -> Tuple[int, List[ArgumentInfo], Optional[Token]]:
+    ) -> Tuple[int, Optional[List[ArgumentInfo]], Optional[Token]]:
         from robot.parsing.lexer.tokens import Token as RobotToken
         from robot.utils.escaping import split_from_equals
 
@@ -670,7 +670,7 @@ def get_argument_info_at_position(
             and tokens[token_at_position_index - 1].type == RobotToken.CONTINUATION
             and position.character < range_from_token(tokens[token_at_position_index - 1]).end.character + 2
         ):
-            return -1, kw_arguments, None
+            return -1, None, None
 
         token_at_position_index = tokens.index(token_at_position)
 
@@ -723,35 +723,55 @@ def get_argument_info_at_position(
         if argument_token is not None and argument_token.type == RobotToken.ARGUMENT:
             arg_name_or_value, arg_value = split_from_equals(argument_token.value)
             if arg_value is not None:
-                arg_name = arg_name_or_value
-                named_arg = True
-                argument_index = next((i for i, v in enumerate(kw_arguments) if v.name == arg_name), -1)
+                old_argument_index = argument_index
+                argument_index = next(
+                    (
+                        i
+                        for i, v in enumerate(kw_arguments)
+                        if v.name == arg_name_or_value or v.kind == KeywordArgumentKind.VAR_NAMED
+                    ),
+                    -1,
+                )
+
                 if argument_index == -1:
+                    argument_index = old_argument_index
+                else:
+                    named_arg = True
+
+        if not named_arg and argument_index >= 0:
+            need_named = False
+            for i, a in enumerate(arguments):
+                if i == argument_index:
+                    break
+                arg_name_or_value, arg_value = split_from_equals(a.value)
+                if arg_value is not None and any(
+                    (i for i, v in enumerate(kw_arguments) if v.name == arg_name_or_value)
+                ):
+                    need_named = True
+                    break
+
+            a_index = next(
+                (
+                    i
+                    for i, v in enumerate(kw_arguments)
+                    if v.kind in [KeywordArgumentKind.POSITIONAL_ONLY, KeywordArgumentKind.POSITIONAL_OR_NAMED]
+                    and i == argument_index
+                ),
+                -1,
+            )
+            if a_index >= 0 and not need_named:
+                argument_index = a_index
+            else:
+                if need_named:
                     argument_index = next(
                         (i for i, v in enumerate(kw_arguments) if v.kind == KeywordArgumentKind.VAR_NAMED), -1
                     )
+                else:
+                    argument_index = next(
+                        (i for i, v in enumerate(kw_arguments) if v.kind == KeywordArgumentKind.VAR_POSITIONAL), -1
+                    )
 
-        if (
-            argument_index >= len(kw_arguments)
-            and len(kw_arguments) > 0
-            and kw_arguments[-1].kind in [KeywordArgumentKind.VAR_POSITIONAL, KeywordArgumentKind.VAR_NAMED]
-        ):
-            argument_index = len(kw_arguments) - 1
-
-        if not named_arg and argument_index >= 0 and argument_index < len(kw_arguments) and argument_token is not None:
-            while (
-                argument_index >= 0
-                and argument_index < len(kw_arguments)
-                and kw_arguments[argument_index].kind in [KeywordArgumentKind.NAMED_ONLY]
-            ):
-                argument_index -= 1
-
-            if argument_index >= 0 and argument_index < len(kw_arguments):
-                args = arguments[:argument_index]
-                for a in args:
-                    arg_name_or_value, arg_value = split_from_equals(a.value)
-                    if arg_value is not None:
-                        argument_index = -1
-                        break
+        if argument_index >= len(kw_arguments):
+            argument_index = -1
 
         return argument_index, kw_arguments, argument_token

packages/language_server/src/robotcode/language_server/robotframework/parts/model_helper.py

@@ -122,10 +122,15 @@ async def _signature_help_KeywordCall_or_Fixture(  # noqa: N802
             analyse_run_keywords=False,
         )
 
-        if keyword_doc_and_token is None or keyword_doc_and_token[0] is None:
+        if keyword_doc_and_token is None:
             return None
 
-        keyword_doc = keyword_doc_and_token[0]
+        keyword_doc, keyword_token = keyword_doc_and_token
+        if keyword_doc is None:
+            return None
+
+        if keyword_token is not None and position < range_from_token(keyword_token).extend(end_character=2).end:
+            return None
 
         if keyword_doc.is_any_run_keyword():
             # TODO
@@ -143,6 +148,8 @@ def _get_signature_help(
         argument_index, kw_arguments, _ = self.get_argument_info_at_position(
             keyword_doc, tokens, token_at_position, position
         )
+        if kw_arguments is None:
+            return None
 
         signature = SignatureInformation(
             label=keyword_doc.parameter_signature(),

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

@@ -3,10 +3,10 @@ data: !GeneratedTestData
   line: 12
   name: no param resource
 result: !SignatureHelp
-  active_parameter: 3
+  active_parameter: -1
   active_signature: 0
   signatures:
-  - activeParameter: 3
+  - activeParameter: -1
     documentation: null
     label: (message, level = INFO, html = ${False})
     parameters:

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_signature_help.test[signature_help.robot-012-059-no_param_resource].out

@@ -3,10 +3,10 @@ data: !GeneratedTestData
   line: 12
   name: no param resource
 result: !SignatureHelp
-  active_parameter: 3
+  active_parameter: -1
   active_signature: 0
   signatures:
-  - activeParameter: 3
+  - activeParameter: -1
     documentation: null
     label: (message, level = INFO, html = ${False})
     parameters:

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_signature_help.test[signature_help.robot-012-062-no_param_resource].out

@@ -3,10 +3,10 @@ data: !GeneratedTestData
   line: 12
   name: no param resource
 result: !SignatureHelp
-  active_parameter: 3
+  active_parameter: -1
   active_signature: 0
   signatures:
-  - activeParameter: 3
+  - activeParameter: -1
     documentation: null
     label: (message, level = INFO, html = ${False})
     parameters:

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_signature_help.test[signature_help.robot-012-065-no_param_resource].out

@@ -3,10 +3,10 @@ data: !GeneratedTestData
   line: 24
   name: no params
 result: !SignatureHelp
-  active_parameter: 3
+  active_parameter: -1
   active_signature: 0
   signatures:
-  - activeParameter: 3
+  - activeParameter: -1
     documentation: null
     label: '(i: int, b: bool, l: TestEnum = A)'
     parameters:

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_signature_help.test[signature_help.robot-024-046-no_params].out

@@ -3,10 +3,10 @@ data: !GeneratedTestData
   line: 33
   name: BuiltIn no params
 result: !SignatureHelp
-  active_parameter: 0
+  active_parameter: -1
   active_signature: 0
   signatures:
-  - activeParameter: 0
+  - activeParameter: -1
     documentation: null
     label: ()
     parameters: []