robotframework-debug 3.8.0__tar.gz → 3.10.0__tar.gz

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-debug
-Version: 3.8.0
+Version: 3.10.0
 Summary: RobotFramework debug shell
 Home-page: https://github.com/imbus/robotframework-debug/
 Author: René Rohner

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/RobotDebug/cmdcompleter.py

@@ -1,11 +1,44 @@
 import re
 
 from prompt_toolkit.completion import Completer, Completion
+from robot.libraries.BuiltIn import BuiltIn
+from robot.parsing.parser.parser import _tokens_to_statements
 
+from .lexer import get_robot_token, get_variable_token
+from .prompttoolkitcmd import set_toolbar_key
 from .robotkeyword import normalize_kw, parse_keyword
 from .styles import _get_style_completions
 
 
+def find_token_at_cursor(cursor_col, cursor_row, statement):
+    statement_type = None
+    for token in statement.tokens:
+        if token.type in ["KEYWORD", "IF", "FOR", "ELSE", "ELSE IF"]:
+            statement_type = token.type
+        if (
+            token.lineno == cursor_row + 1
+            and token.col_offset <= cursor_col <= token.end_col_offset
+        ):
+            return statement_type, token, cursor_col - token.col_offset
+    return None, None, None
+
+
+def find_statement_details_at_cursor(cursor_col, cursor_row, statements):
+    for statement in statements:
+        if not statement:
+            continue
+        if (
+            statement.lineno <= cursor_row + 1 <= statement.end_lineno
+            and statement.col_offset <= cursor_col <= statement.end_col_offset
+        ):
+            statement_type, token, cursor_pos = find_token_at_cursor(
+                cursor_col, cursor_row, statement
+            )
+            if token:
+                return statement, statement_type, token, cursor_pos
+    return None, None, None, None
+
+
 class CmdCompleter(Completer):
     """Completer for debug shell."""
 
@@ -59,7 +92,15 @@ class CmdCompleter(Completer):
         """Compute suggestions."""
         # RobotFrameworkLocalLexer().parse_doc(document)
         text = document.current_line_before_cursor
-        variables, keyword, args = parse_keyword(text.strip())
+        cursor_col = document.cursor_position_col
+        cursor_row = document.cursor_position_row
+        token_list = list(get_robot_token(document.text))
+        statements = list(_tokens_to_statements(token_list))
+        statement, statement_type, token, cursor_pos = find_statement_details_at_cursor(
+            cursor_col, cursor_row, statements
+        )
+
+        # variables, keyword, args = parse_keyword(text.strip())
         if "FOR".startswith(text):
             yield from [
                 Completion(
@@ -101,7 +142,25 @@ class CmdCompleter(Completer):
             yield from _get_style_completions(text.lower())
         elif text.startswith("*"):
             yield from self._get_resource_completions(text.lower())
-        elif keyword:
-            if not args:
-                yield from self._get_command_completions(text.lower())
-
+        elif token:
+            vars = list(get_variable_token([token]))
+            for var in vars:
+                if var.col_offset <= cursor_col <= var.end_col_offset:
+                    token = var
+                    cursor_pos = cursor_col - var.col_offset
+            set_toolbar_key(statement_type, token, cursor_pos)
+            if token.type in ["ASSIGN", "VARIABLE"] or (
+                token.type == "KEYWORD" and re.fullmatch(r"[$&@]\{.[^}]}", token.value)
+            ):
+                yield from [
+                    Completion(
+                        f"{var[:-1]}",
+                        -cursor_pos,
+                        display=var,
+                        display_meta=repr(val),
+                    )
+                    for var, val in BuiltIn().get_variables().items()
+                    if normalize_kw(var[1:]).startswith(normalize_kw(token.value[1:cursor_pos]))
+                ]
+            elif token.type == "KEYWORD":
+                yield from self._get_command_completions(token.value.lower())

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/RobotDebug/debugcmd.py

@@ -109,20 +109,16 @@ Access https://github.com/imbus/robotframework-debug for more details.\
 
         keywords: List[KeywordDoc] = get_keywords()
         for keyword in keywords:
-            name = "{0}.{1}".format(keyword.parent.name, keyword.name)
+            name = f"{keyword.parent.name}.{keyword.name}"
             commands.append(
                 (
                     name,
                     keyword.name,
-                    "Keyword: {0}".format(keyword.shortdoc),
+                    keyword.shortdoc,
                 )
             )
             commands.append(
-                (
-                    keyword.name,
-                    keyword.name,
-                    "Keyword[{0}.]: {1}".format(keyword.parent.name, keyword.shortdoc),
-                )
+                (keyword.name, keyword.name, f"{keyword.shortdoc} [{keyword.parent.name}]")
             )
 
         return CmdCompleter(commands, self)

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/RobotDebug/lexer.py

@@ -1,6 +1,48 @@
+import re
+from contextlib import suppress
+
 from pygments.lexer import Lexer
 from pygments.token import Token
-from robot.parsing import get_tokens
+from robot.parsing import get_model, get_tokens
+from robot.parsing.parser.parser import _tokens_to_statements
+
+
+def get_robot_token(text):
+    if text.strip().startswith("**"):
+        yield from get_tokens(text)
+    else:
+        marker_len = 20
+        new_line_start = " " * marker_len
+        if "\n" in text:
+            text = f"\n{new_line_start}".join(text.split("\n"))
+        suite_str = f"*** Test Cases ***\nFake Test\n{new_line_start}{text}"
+        for token in list(get_tokens(suite_str))[6:]:
+            if (
+                token.type in ["SEPARATOR", "EOL"]
+                and token.col_offset == 0
+                and token.end_col_offset >= marker_len
+            ):
+                if token.end_col_offset == marker_len:
+                    continue
+                token.value = token.value[marker_len:]
+                token.col_offset = 0
+                token.lineno = token.lineno - 2
+            else:
+                token.col_offset = token.col_offset - marker_len
+                token.lineno = token.lineno - 2
+            yield token
+
+
+def get_variable_token(token_list):
+    for token in token_list:
+        if len(token.value) == 0:
+            continue
+        try:
+            var_tokens = token.tokenize_variables()
+        except Exception:
+            var_tokens = [token]
+        for v_token in var_tokens:
+            yield v_token
 
 
 class RobotFrameworkLocalLexer(Lexer):
@@ -103,37 +145,37 @@ class RobotFrameworkLocalLexer(Lexer):
     # }
 
     ROBOT_TO_PYGMENTS = {
-        "SETTING HEADER": Token.Generic.Heading,
-        "VARIABLE HEADER": Token.Generic.Heading,
-        "TESTCASE HEADER": Token.Generic.Heading,
-        "TASK HEADER": Token.Generic.Heading,
-        "KEYWORD HEADER": Token.Generic.Heading,
-        "COMMENT HEADER": Token.Generic.Heading,
+        "SETTING HEADER": Token.Keyword.Namespace,
+        "VARIABLE HEADER": Token.Keyword.Namespace,
+        "TESTCASE HEADER": Token.Keyword.Namespace,
+        "TASK HEADER": Token.Keyword.Namespace,
+        "KEYWORD HEADER": Token.Keyword.Namespace,
+        "COMMENT HEADER": Token.Keyword.Namespace,
         "TESTCASE NAME": Token.Name.Class,
         "KEYWORD NAME": Token.Name.Class,
-        "DOCUMENTATION": Token.Name.Attribute,
-        "SUITE SETUP": Token.Name.Attribute,
-        "SUITE TEARDOWN": Token.Name.Attribute,
-        "METADATA": Token.Name.Attribute,
-        "TEST SETUP": Token.Name.Attribute,
-        "TEST TEARDOWN": Token.Name.Attribute,
-        "TEST TEMPLATE": Token.Name.Attribute,
-        "TEST TIMEOUT": Token.Name.Attribute,
-        "FORCE TAGS": Token.Name.Attribute,
-        "DEFAULT TAGS": Token.Name.Attribute,
-        "KEYWORD TAGS": Token.Name.Attribute,
-        "LIBRARY": Token.Name.Attribute,
-        "RESOURCE": Token.Name.Attribute,
-        "VARIABLES": Token.Name.Attribute,
-        "SETUP": Token.Keyword.Namespace,
-        "TEARDOWN": Token.Keyword.Namespace,
-        "TEMPLATE": Token.Keyword.Namespace,
-        "TIMEOUT": Token.Keyword.Namespace,
-        "TAGS": Token.Keyword.Namespace,
-        "ARGUMENTS": Token.Keyword.Namespace,
-        "RETURN_SETTING": Token.Keyword.Namespace,
+        "DOCUMENTATION": Token.Name.Label,
+        "SUITE SETUP": Token.Name.Label,
+        "SUITE TEARDOWN": Token.Name.Label,
+        "METADATA": Token.Name.Label,
+        "TEST SETUP": Token.Name.Label,
+        "TEST TEARDOWN": Token.Name.Label,
+        "TEST TEMPLATE": Token.Name.Label,
+        "TEST TIMEOUT": Token.Name.Label,
+        "FORCE TAGS": Token.Name.Label,
+        "DEFAULT TAGS": Token.Name.Label,
+        "KEYWORD TAGS": Token.Name.Label,
+        "LIBRARY": Token.Name.Label,
+        "RESOURCE": Token.Name.Label,
+        "VARIABLES": Token.Name.Label,
+        "SETUP": Token.Name.Property,
+        "TEARDOWN": Token.Name.Property,
+        "TEMPLATE": Token.Name.Property,
+        "TIMEOUT": Token.Name.Property,
+        "TAGS": Token.Name.Property,
+        "ARGUMENTS": Token.Name.Property,
+        "RETURN_SETTING": Token.Name.Property,
         "NAME": Token.Name,
-        "VARIABLE": Token.Name.Variable,
+        "VARIABLE": Token.Name.Variable.Instance,
         "ARGUMENT": Token.String,
         "ASSIGN": Token.Name.Variable,
         "KEYWORD": Token.Name.Function,
@@ -196,36 +238,17 @@ class RobotFrameworkLocalLexer(Lexer):
     #                         break
     #     return statement_at_cursor, token_at_cursor
 
-    def get_robot_token(self, text):
-        if text.strip().startswith("**"):
-            yield from get_tokens(text)
-        else:
-            marker_len = 20
-            new_line_start = " " * marker_len
-            if "\n" in text:
-                text = f"\n{new_line_start}".join(text.split("\n"))
-            suite_str = f"*** Test Cases ***\nFake Test\n{new_line_start}{text}"
-            for token in list(get_tokens(suite_str))[6:]:
-                if (
-                    token.type in ["SEPARATOR", "EOL"]
-                    and token.col_offset == 0
-                    and token.end_col_offset >= marker_len
-                ):
-                    if token.end_col_offset == marker_len:
-                        continue
-                    token.value = token.value[marker_len:]
-                    token.col_offset = 0
-                    token.lineno = token.lineno - 2
-                else:
-                    token.col_offset = token.col_offset - marker_len
-                    token.lineno = token.lineno - 2
-                yield token
-
     def get_tokens_unprocessed(self, text):
-        token_list = self.get_robot_token(text)
+        token_list = get_robot_token(text)
         index = 0
-        for token in token_list:
-            if len(token.value) == 0:
-                continue
-            yield index, self.ROBOT_TO_PYGMENTS.get(token.type, Token.Generic.Error), token.value
-            index += len(token.value)
+        for v_token in get_variable_token(token_list):
+            yield index, self.to_pygments_token_type(v_token), v_token.value
+            index += len(v_token.value)
+
+    def to_pygments_token_type(self, token):
+        if token.type == "VARIABLE":
+            if re.match(r"[$&@%]\{(EMPTY|TRUE|FALSE|NONE)}", token.value, re.IGNORECASE):
+                return Token.Name.Constant
+            if re.match(r"\$\{\d+}", token.value):
+                return Token.Name.Constant
+        return self.ROBOT_TO_PYGMENTS.get(token.type, Token.Generic.Error)

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/RobotDebug/prompttoolkitcmd.py

@@ -2,26 +2,17 @@ import cmd
 import os
 import re
 
-from prompt_toolkit import HTML
 from prompt_toolkit.application import get_app
 from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
 from prompt_toolkit.buffer import Buffer
 from prompt_toolkit.clipboard.pyperclip import PyperclipClipboard
 from prompt_toolkit.cursor_shapes import CursorShape
-from prompt_toolkit.filters import (
-    Condition,
-    has_completions,
-    has_selection,
-    in_paste_mode,
-    is_multiline,
-)
+from prompt_toolkit.filters import Condition, has_completions, has_selection
 from prompt_toolkit.history import FileHistory
 from prompt_toolkit.key_binding import KeyBindings
 from prompt_toolkit.lexers import PygmentsLexer
 from prompt_toolkit.output import ColorDepth
 from prompt_toolkit.shortcuts import CompleteStyle, prompt
-from pygments.lexer import Lexer
-from pygments.lexers.robotframework import RobotFrameworkLexer
 
 from .lexer import RobotFrameworkLocalLexer
 from .robotkeyword import get_rprompt_text
@@ -168,6 +159,50 @@ def _(event):
     b.exit_selection()
 
 
+@kb.add("{")
+def _(event):
+    b = event.current_buffer
+    b.insert_text("{")
+    b.insert_text("}", move_cursor=False)
+
+
+@kb.add("[")
+def _(event):
+    b = event.current_buffer
+    b.insert_text("[")
+    b.insert_text("]", move_cursor=False)
+
+
+MOUSE_SUPPORT = True
+
+
+@kb.add("f12")
+def _(event):
+    global MOUSE_SUPPORT
+    MOUSE_SUPPORT = not MOUSE_SUPPORT
+
+
+TOOLBAR_KEY = ("", None, None)
+
+
+def set_toolbar_key(statement_type, token, cursor_pos):
+    global TOOLBAR_KEY
+    TOOLBAR_KEY = statement_type, token, cursor_pos
+
+
+def bottom_toolbar():
+    return [
+        ("class:bottom-toolbar-key", "STATEMENT: "),
+        ("class:bottom-toolbar", f"{TOOLBAR_KEY[0]}    "),
+        ("class:bottom-toolbar-key", "value: "),
+        ("class:bottom-toolbar", f"{TOOLBAR_KEY[1].value if TOOLBAR_KEY[1] else ''}    "),
+        ("class:bottom-toolbar-key", "TOKEN: "),
+        ("class:bottom-toolbar", f"{TOOLBAR_KEY[1].type if TOOLBAR_KEY[1] else ''}    "),
+        ("class:bottom-toolbar-key", "TOKEN: "),
+        ("class:bottom-toolbar", f"{TOOLBAR_KEY[2] if TOOLBAR_KEY[2] else ''}    "),
+    ]
+
+
 class BaseCmd(cmd.Cmd):
     """Basic REPL tool."""
 
@@ -291,14 +326,6 @@ Type "help" for more information.\
     def prompt_continuation(self, width, line_number, is_soft_wrap):
         return " " * width
 
-    def bottom_toolbar(self):
-        return [
-            ("class:bottom-toolbar-key", "more features"),
-            ("class:bottom-toolbar", " coming soon...     "),
-            ("class:bottom-toolbar-key", "Shift+ArrowDown"),
-            ("class:bottom-toolbar", " to insert a new line."),
-        ]
-
     def get_input(self):
         kwargs = {}
         if self.get_prompt_tokens:
@@ -309,7 +336,7 @@ Type "help" for more information.\
         try:
             line = prompt(
                 auto_suggest=AutoSuggestFromHistory(),
-                bottom_toolbar=self.bottom_toolbar,
+                bottom_toolbar=bottom_toolbar,
                 clipboard=PyperclipClipboard(),
                 color_depth=ColorDepth.DEPTH_24_BIT,
                 completer=self.get_completer(),
@@ -321,10 +348,10 @@ Type "help" for more information.\
                 key_bindings=kb,
                 lexer=PygmentsLexer(RobotFrameworkLocalLexer),
                 message=prompt_str,
-                mouse_support=True,
+                mouse_support=MOUSE_SUPPORT,
                 prompt_continuation=self.prompt_continuation,
                 rprompt=get_rprompt_text(),
-                **kwargs
+                **kwargs,
             )
         except EOFError:
             line = "EOF"

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/RobotDebug/styles.py

@@ -18,6 +18,8 @@ BASE_STYLE = Style.from_dict(
     {
         "pygments.name.function": "bold",
         "pygments.literal.string": "italic",
+        # "pygments.name.variable.instance": "italic",
+        "pygments.name.class": "underline",
         "bottom-toolbar": "#333333 bg:#ffffff",
         "bottom-toolbar-key": "#333333 bg:#aaaaff",
     }

robotframework-debug-3.10.0/RobotDebug/version.py

@@ -0,0 +1 @@
+VERSION = "3.10.0"

{robotframework-debug-3.8.0 → robotframework-debug-3.10.0}/robotframework_debug.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-debug
-Version: 3.8.0
+Version: 3.10.0
 Summary: RobotFramework debug shell
 Home-page: https://github.com/imbus/robotframework-debug/
 Author: René Rohner

robotframework-debug-3.8.0/RobotDebug/version.py

@@ -1 +0,0 @@
-VERSION = "3.8.0"