improved argument completion and fixed some minor bugs.

Signed-off-by: René <[email protected]>

Author: Snooz82

RobotDebug/RobotDebug.py

@@ -44,7 +44,7 @@ def start_keyword(self, name, attrs):
 
         path = attrs["source"]
         if path and Path(path).exists() and path not in self.source_files:
-            self.source_files[path] = Path(path).open().readlines()
+            self.source_files[path] = Path(path).open().readlines()  # noqa: SIM115
         lineno = attrs["lineno"]
         self.library.current_source_path = path
         self.library.current_source_line = lineno

RobotDebug/cmdcompleter.py

@@ -8,7 +8,7 @@
 from robot.libraries.BuiltIn import BuiltIn
 from robot.parsing.parser.parser import _tokens_to_statements
 
-from .globals import IS_RF_7
+from .globals import IS_RF_7, KEYWORD_SEP
 from .lexer import get_robot_token, get_variable_token
 from .prompttoolkitcmd import PromptToolkitCmd
 from .robotkeyword import normalize_kw
@@ -69,9 +69,16 @@ def _find_statement_details_at_cursor(self):
 
     def _find_token_at_cursor(self):
         for token in self.statement.tokens:
-            if (
-                token.type
-            ):  # in ["KEYWORD", "IF", "FOR", "ELSE", "ELSE IF"]:   TODO: Commented to get all tokens in debug. lets see the impact
+            if token.type in [
+                "KEYWORD",
+                "IF",
+                "FOR",
+                "ELSE",
+                "ELSE IF",
+                "TRY",
+                "WHILE",
+                "VAR",
+            ]:  # TODO: Commented to get all tokens in debug. lets see the impact
                 self.statement_type = token.type
             if (
                 token.lineno == self.cursor_row + 1
@@ -93,6 +100,12 @@ def __init__(self, libs, keywords, helps, cmd_repl: Optional[PromptToolkitCmd] =
         self.helps = helps
         self.libs = libs
         self.keywords = list(keywords)
+        self.keywords_catalog = {}
+        for keyword in self.keywords:
+            self.keywords_catalog[normalize_kw(keyword.name)] = keyword
+            self.keywords_catalog[
+                f"{normalize_kw(keyword.parent.name)}.{normalize_kw(keyword.name)}"
+            ] = keyword
         self.current_statement = None
         for name, display, display_meta in self.get_commands():
             self.names.append(name)
@@ -163,28 +176,28 @@ def _get_resource_completions(self, text):
         )
 
     def _get_argument_completer(self, text):
-        for keyword in self.keywords:
-            if normalize_kw(keyword.name) == normalize_kw(
-                self.current_statement.statement.keyword
-            ) or f"{normalize_kw(keyword.parent.name)}.{normalize_kw(keyword.name)}" == normalize_kw(
-                self.current_statement.statement.keyword
-            ):
-                data_tokens = self.current_statement.statement.data_tokens
-                args = keyword.args
-                set_named_args, set_pos_args = self.get_set_args(args, data_tokens)
-                if set_named_args:
-                    yield from self.get_named_arg_completion(args, set_named_args, set_pos_args)
-                else:
-                    yield from self.get_pos_arg_completion(args, set_pos_args)
+        keyword = self.keywords_catalog.get(
+            normalize_kw(self.current_statement.statement.keyword), None
+        )
+        if keyword:
+            data_tokens = self.current_statement.statement.data_tokens
+            args = keyword.args
+            set_named_args, set_pos_args = self.get_set_args(args, data_tokens)
+            if set_named_args:
+                yield from self.get_named_arg_completion(args, set_named_args, set_pos_args)
+            else:
+                yield from self.get_pos_arg_completion(args, set_pos_args)
 
-    def get_pos_arg_completion(self, args, set_pos_args):
+    def get_pos_arg_completion(
+        self, args, set_pos_args
+    ):  # TODO: here is an issue. if more positional args are set, than existing, named_only will be removed from proposal
         for index, arg in enumerate([*args.positional_or_named, *args.named_only]):
             if index + 1 > len(set_pos_args):
-                suffix = "=" if arg in [*args.positional_or_named, *args.named_only] else ""
+                # suffix = "=" if arg in [*args.positional_or_named, *args.named_only] else ""
                 yield Completion(
-                    f"{arg}",
+                    f"{arg}=",
                     0,
-                    display=f"{arg}{suffix}",
+                    display=f"{arg}=",
                     display_meta=str(args.defaults.get(arg, "")),
                 )
 
@@ -338,7 +351,7 @@ def _get_keyword_completions(
         ):
             yield from [
                 Completion(
-                    f"{var[:-1]}",
+                    var,
                     -cursor_pos,
                     display=var,
                     display_meta=repr(val),
@@ -365,7 +378,7 @@ def __init__(self, completer: CmdCompleter):
     def get_suggestion(self, buffer: Buffer, document: Document) -> Union[Suggestion, None]:
         text = document.text
         completions = [compl.text for compl in self.completer.get_completions(document, None)]
-        last_word = text.split("  ")[-1]
+        last_word = KEYWORD_SEP.split(text)[-1]
         matches = [kw for kw in completions if kw.startswith(last_word)]
         matches.extend([kw for kw in completions if kw.lower().startswith(last_word.lower())])
         return Suggestion(matches[0][len(last_word) :] if matches else "")

RobotDebug/globals.py

@@ -1,3 +1,4 @@
+import re
 from enum import Enum
 
 from robot.version import get_version
@@ -25,3 +26,4 @@ class StepMode(str, Enum):
 
 
 IS_RF_7 = int(get_version().split(".", 1)[0]) >= 7  # noqa: PLR2004
+KEYWORD_SEP = re.compile(r"[ \t]{2,}|\t")

RobotDebug/history_app.py

@@ -136,10 +136,14 @@ def get_history_content(his, pure_commands: bool = True):
             [
                 e
                 for e in dict.fromkeys(
-                    reversed([re.sub(r" {2,}", " " * 4, v).strip() for v in his.get_strings()])
+                    reversed(
+                        [
+                            re.sub(r"(?:(?<![\n ])(?:[ \t]{2,}|\t))", " " * 4, v).strip()
+                            for v in his.get_strings()
+                        ]
+                    )
                 )
-                if (not HEADER_MATCHER.match(e) and pure_commands)
-                or (HEADER_MATCHER.match(e) and not pure_commands)
+                if bool(HEADER_MATCHER.match(e)) != pure_commands
             ]
         )
     )

RobotDebug/lexer.py

@@ -50,8 +50,7 @@ def get_variable_token(token_list):
             var_tokens = list(token.tokenize_variables())
         except Exception:
             var_tokens = [token]
-        for v_token in var_tokens:
-            yield v_token
+        yield from var_tokens
 
 
 class RobotFrameworkLocalLexer(Lexer):

RobotDebug/prompttoolkitcmd.py

@@ -304,7 +304,7 @@ def loop_once(self):
         if line is None:
             return None
 
-        if line == "exit" or line == "EOF":
+        if line in ["exit", "EOF"]:
             line = "EOF"
             return True
 

RobotDebug/robotkeyword.py

@@ -1,4 +1,3 @@
-import re
 import tempfile
 from pathlib import Path
 from typing import Iterator, List, Tuple
@@ -14,10 +13,9 @@
     from robot.running import ResourceFile
 from robot.variables.search import is_variable
 
+from .globals import KEYWORD_SEP
 from .robotlib import ImportedLibraryDocBuilder, ImportedResourceDocBuilder, get_libs
 
-KEYWORD_SEP = re.compile("  +|\t")
-
 _lib_keywords_cache = {}
 _resource_keywords_cache = {}
 temp_resources = []

RobotDebug/robotlib.py

@@ -1,4 +1,5 @@
 from copy import deepcopy
+
 from robot.libdocpkg.model import LibraryDoc
 from robot.libdocpkg.robotbuilder import (
     KeywordDocBuilder,

RobotDebug/sourcelines.py

@@ -16,7 +16,9 @@ def print_source_lines(style, source_file, lineno, before_and_after=5):
     if not source_file or not lineno:
         return
 
-    Path(source_file).open().readlines()
+    Path(
+        source_file
+    ).open().readlines()  # noqa: SIM115  TODO: not sure why i did this. Maybe to check if file is actually readable...
     prefixed_token = get_pygments_token_from_file(lineno, source_file)
     printable_token = filter_token_by_lineno(
         prefixed_token, lineno - before_and_after, lineno + before_and_after + 1
@@ -28,7 +30,9 @@ def print_test_case_lines(style, source_file, current_lineno):
     if not source_file or not current_lineno:
         return
 
-    Path(source_file).open().readlines()
+    Path(
+        source_file
+    ).open().readlines()  # noqa: SIM115  TODO: not sure why i did this. Maybe to check if file is actually readable...
     prefixed_token = get_pygments_token_from_file(current_lineno, source_file)
     printable_token = filter_token_by_scope(prefixed_token, current_lineno)
     print_pygments_styles(printable_token, style)

RobotDebug/version.py

@@ -1 +1 @@
-VERSION = "4.4.0"
+VERSION = "4.5.0"