Registry /
testing / robotframework-debuglibrary
Install & Compatibility
Where this runs
tested against v2.5.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 34.3MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 2.4s · import 0.000s · 35MB
31MB installed
● package 31MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DebugLibrary
✓ *** Settings ***
Library DebugLibrary
✗ Library debuglibrary
Robot Framework library imports are case-sensitive. 'DebugLibrary' must be used with correct capitalization.
Import the `DebugLibrary` in your Robot Framework `*** Settings ***`. Use the `Debug` keyword to force a breakpoint and open the interactive shell. Use `Debug If` to conditionally pause execution. Alternatively, run `rfdebug` from the command line for a standalone interactive Robot Framework shell.
*** Settings ***
Library DebugLibrary
*** Test Cases ***
Example Debugging Test
Log To Console Starting test execution...
Debug # Execution pauses here, interactive shell opens
Log To Console Resuming test after breakpoint.
${sum} = Evaluate ${1} + ${2}
Log To Console The sum is: ${sum}
Debug If ${sum} > 10 # Pauses if condition is true
Log To Console Test finished.
Debug
Known issues
breakingPython 3.7 support was dropped in v2.5.0. Earlier versions (v2.4.0) dropped Python 3.6 support, and v2.3.0 dropped Python 3.5 support. Version 2.0.0 dropped Python 2.x and 3.4 support.fixUpgrade to a supported Python version (Python 3.8+ for v2.5.0, Python 3.9+ for newer versions).
affects: >=2.5.0
breakingRobot Framework 7.0 support was added in v2.5.0. Prior to v2.4.0, Robot Framework <4.0 was supported. Changes related to `exc.full_message` (removed in RF 5.0) were addressed in v2.3.0.fixEnsure `robotframework-debuglibrary` version matches your Robot Framework version. Upgrade to `robotframework-debuglibrary` 2.5.0 for Robot Framework 7.0 compatibility. For Robot Framework 5.0+, ensure at least `robotframework-debuglibrary` 2.3.0 or newer is used.
affects: <2.5.0 when using RF 7.0; <2.4.0 when using RF >=4.0
breakingThe `prompt-toolkit` dependency was upgraded to version 3.x in `robotframework-debuglibrary` v2.4.0, which might introduce incompatibilities with older Python versions or `prompt-toolkit` versions. Explicitly declared `prompt-toolkit >=2` in v2.2.1, and 2.x in v2.0.0.fixUpgrade `robotframework-debuglibrary` to 2.4.0 or newer to ensure compatibility with `prompt-toolkit` 3.x. Ensure `prompt-toolkit` is updated if issues arise after library upgrade.
affects: <2.4.0 when using prompt-toolkit 3.x; <2.0.0 when using prompt-toolkit 2.x
gotchaThe short name for listing available libraries was changed from `l` to `ls` in v2.2.0 to avoid conflict with the new `list` command for step debugging.fixWhen using `robotframework-debuglibrary` v2.2.0 or newer, use `ls` to list libraries within the interactive shell instead of `l`.
affects: <2.2.0
Upgrade
Version history
2.5.0latest on PyPI · released Jan 12, 2024
Audit
Dependencies
robotframeworkrequiredCore dependency for Robot Framework test execution. Version 2.5.0 supports Robot Framework 7.0; version 2.4.0 supports >=4.0.
prompt-toolkitrequiredProvides the interactive shell functionality and command-line interface. Version 2.4.0 upgraded to prompt-toolkit >=3.x.