robotframework-debug 4.6.0__tar.gz → 4.6.1__tar.gz

{robotframework_debug-4.6.0 → robotframework_debug-4.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-debug
-Version: 4.6.0
+Version: 4.6.1
 Summary: A debug library and REPL for Robot Framework.
 Keywords: robotframework,debug,shell,repl
 Author-email: René Rohner <snooz@posteo.de>

{robotframework_debug-4.6.0 → robotframework_debug-4.6.1}/RobotDebug/__init__.py

@@ -1,6 +1,6 @@
 """A debug library and REPL for Robot Framework."""
 
-__version__ = "4.6.0"
+__version__ = "4.6.1"
 
 from .RobotDebug import Listener, RobotDebug  # noqa: F401
 from .version import VERSION  # noqa: F401

{robotframework_debug-4.6.0 → robotframework_debug-4.6.1}/RobotDebug/debugcmd.py

@@ -158,14 +158,22 @@ Access https://github.com/imbus/robotframework-debug for more details.\
             print_error("< not found library", lib_name)
             return
         for lib in matched:
-            if lib:
-                print_output("< Keywords of library", lib.name)
-                for keyword in get_lib_keywords(lib):
-                    # ``short_doc`` is RF >= 7; ``shortdoc`` on older releases.
-                    short_doc = getattr(keyword, "short_doc", None) or getattr(
-                        keyword, "shortdoc", ""
-                    )
-                    print_output(f"   {keyword.name}\t", short_doc)
+            if not lib:
+                continue
+            print_output("< Keywords of library", lib.name)
+            try:
+                keywords = get_lib_keywords(lib)
+            except Exception as exc:
+                # Don't let one library's doc-build error silently abort the
+                # whole listing; report it and continue with the next library.
+                print_error("   ! could not read keywords:", repr(exc))
+                continue
+            for keyword in keywords:
+                # ``short_doc`` is RF >= 7; ``shortdoc`` on older releases.
+                short_doc = getattr(keyword, "short_doc", None) or getattr(
+                    keyword, "shortdoc", ""
+                )
+                print_output(f"   {keyword.name}\t", short_doc)
 
     do_k = do_keywords
 

{robotframework_debug-4.6.0 → robotframework_debug-4.6.1}/docs/compatibility_matrix.md

@@ -5,11 +5,11 @@ Acceptance suite (`tests/atest/suites`) run against each Robot Framework release
 | Feature area | RF 5.0.1<br/>(Py 3.10.19) | RF 6.0.2<br/>(Py 3.11.15) | RF 6.1.1<br/>(Py 3.11.15) | RF 7.0.1<br/>(Py 3.11.15) | RF 7.2.2<br/>(Py 3.12.8) | RF 7.3.2<br/>(Py 3.12.8) | RF 7.4.2<br/>(Py 3.12.8) |
 |---|---|---|---|---|---|---|---|
 | REPL basics | ✅ 9/9 | ✅ 9/9 | ✅ 9/9 | ✅ 9/9 | ✅ 9/9 | ✅ 9/9 | ✅ 9/9 |
-| REPL commands | ✅ 7/7 | ✅ 7/7 | ✅ 7/7 | ✅ 7/7 | ✅ 7/7 | ✅ 7/7 | ✅ 7/7 |
+| REPL commands | ✅ 15/15 | ✅ 15/15 | ✅ 15/15 | ✅ 15/15 | ✅ 15/15 | ✅ 15/15 | ✅ 15/15 |
 | Debug keyword | ✅ 6/6 | ✅ 6/6 | ✅ 6/6 | ✅ 6/6 | ✅ 6/6 | ✅ 6/6 | ✅ 6/6 |
 | Listener on error | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 |
 | Step debugging | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 | ✅ 5/5 |
-| **Total** | **✅ 32/32** | **✅ 32/32** | **✅ 32/32** | **✅ 32/32** | **✅ 32/32** | **✅ 32/32** | **✅ 32/32** |
+| **Total** | **✅ 40/40** | **✅ 40/40** | **✅ 40/40** | **✅ 40/40** | **✅ 40/40** | **✅ 40/40** | **✅ 40/40** |
 
 ## Notes
 All tested Robot Framework versions pass the full suite.

robotframework_debug-4.6.1/tests/atest/suites/02_repl_commands.robot

@@ -0,0 +1,121 @@
+*** Settings ***
+Documentation       Every interactive ``irobot`` shell meta command and its
+...                 aliases/flags: libs[ -s], res[ -s], keywords/k, docs/d,
+...                 style, clear/cls, help and the ``?`` help prefix.
+...
+...                 ``keywords``/``k`` and ``docs``/``d`` build library keyword
+...                 documentation, which used to break on Robot Framework 7.4.x
+...                 (removed ``LibraryDocBuilder._get_type_docs``); see the
+...                 compatibility matrix and ``RobotDebug/robotlib.py``.
+
+Resource            ../resources/shell.resource
+
+Force Tags          repl    commands
+
+
+*** Test Cases ***
+List Imported Libraries
+    ${input}=    Lines    libs    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Imported libraries:
+    Should Contain    ${out}    BuiltIn
+    Should Contain    ${out}    RobotDebug
+
+List Imported Libraries With Source
+    ${input}=    Lines    libs -s    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Imported libraries:
+    # -s adds the source path of each library.
+    Should Contain    ${out}    BuiltIn.py
+
+List Imported Resources
+    ${input}=    Lines    res    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Imported resources:
+
+List Imported Resources With Source
+    ${input}=    Lines    res -s    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Imported resources:
+
+List Keywords Of A Library
+    [Tags]    libdoc
+    ${input}=    Lines
+    ...    keywords\tRobotDebug
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Keywords of library RobotDebug
+    # "Variables" is a RobotDebug keyword and, unlike "Debug", is not a
+    # substring of the echoed "keywords RobotDebug" command.
+    Should Contain    ${out}    Variables
+
+List Keywords Short Alias K
+    [Tags]    libdoc
+    ${input}=    Lines
+    ...    k\tBuiltIn
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Keywords of library BuiltIn
+    Should Contain    ${out}    Log To Console
+
+Show Keyword Documentation
+    [Tags]    libdoc
+    ${input}=    Lines
+    ...    docs\tDebug
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    interactive shell
+
+Show Keyword Documentation Short Alias D
+    [Tags]    libdoc
+    ${input}=    Lines
+    ...    d\tLog To Console
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Logs the given message to the console.
+
+List Available Output Styles
+    ${input}=    Lines    style    exit
+    ${out}=    Run Interactive Shell    ${input}
+    # "monokai" is a Pygments style available in every supported version.
+    Should Contain    ${out}    monokai
+
+Set Output Style
+    ${input}=    Lines
+    ...    style\tmonokai
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Set style to:
+    Should Contain    ${out}    monokai
+
+Clear Screen Does Not Crash The Shell
+    # clear/cls emits terminal escapes; assert a later keyword still runs.
+    ${input}=    Lines
+    ...    cls
+    ...    Log To Console\tALIVE_AFTER_CLEAR
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    ALIVE_AFTER_CLEAR
+
+Help Without Arguments
+    ${input}=    Lines    help    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Input Robotframework keywords
+
+Help For A Specific Command
+    ${input}=    Lines    help libs    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Print imported
+
+Help For A Command Alias
+    ${input}=    Lines    help c    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Continue execution.
+
+Question Mark Is A Help Prefix
+    [Tags]    libdoc
+    ${input}=    Lines
+    ...    ?keywords
+    ...    exit
+    ${out}=    Run Interactive Shell    ${input}
+    Should Contain    ${out}    Print keywords of libraries

robotframework_debug-4.6.0/tests/atest/suites/02_repl_commands.robot

@@ -1,64 +0,0 @@
-*** Settings ***
-Documentation       Interactive ``irobot`` shell meta commands: libs, res,
-...                 keywords/k, docs/d and help.
-...
-...                 NOTE: ``keywords``/``k`` and ``docs``/``d`` build library
-...                 keyword documentation and are known to break on Robot
-...                 Framework 7.4.x (removed ``LibraryDocBuilder._get_type_docs``).
-...                 See the compatibility matrix.
-
-Resource            ../resources/shell.resource
-
-Force Tags          repl    commands
-
-
-*** Test Cases ***
-List Imported Libraries
-    ${input}=    Lines    libs    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Imported libraries:
-    Should Contain    ${out}    BuiltIn
-    Should Contain    ${out}    RobotDebug
-
-List Imported Resources
-    ${input}=    Lines    res    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Imported resources:
-
-List Keywords Of A Library
-    [Tags]    libdoc
-    ${input}=    Lines
-    ...    keywords\tRobotDebug
-    ...    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Keywords of library RobotDebug
-    # "Variables" is a RobotDebug keyword and, unlike "Debug", is not a
-    # substring of the echoed "keywords RobotDebug" command.
-    Should Contain    ${out}    Variables
-
-List Keywords Short Alias K
-    [Tags]    libdoc
-    ${input}=    Lines
-    ...    k\tBuiltIn
-    ...    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Keywords of library BuiltIn
-    Should Contain    ${out}    Log To Console
-
-Show Keyword Documentation
-    [Tags]    libdoc
-    ${input}=    Lines
-    ...    docs\tDebug
-    ...    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    interactive shell
-
-Help Without Arguments
-    ${input}=    Lines    help    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Input Robotframework keywords
-
-Help For A Specific Command
-    ${input}=    Lines    help libs    exit
-    ${out}=    Run Interactive Shell    ${input}
-    Should Contain    ${out}    Print imported