robotframework-dialogsplus 0.1.0__tar.gz → 0.2.1__tar.gz

robotframework_dialogsplus-0.2.1/CLAUDE.md

@@ -0,0 +1,45 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project
+
+`robotframework-dialogsplus` — a Robot Framework library providing modern, styled GUI dialogs (built on `customtkinter`) as a drop-in enhancement to Robot Framework's built-in `Dialogs` library. It only works with a real desktop (GUI dialogs require an interactive display), so it cannot run in headless CI/CD environments.
+
+## Commands
+
+Package management is via `uv` (see `uv.lock`).
+
+```bash
+uv sync                      # install dependencies into .venv
+uv run robot atests/         # run the acceptance tests (opens real GUI dialogs — requires manual interaction)
+uv run robot atests/testing.robot -t "Get Confirmation Returns Boolean"   # run a single test case by name
+uv run robotidy src atests   # format Robot Framework files (robotframework-tidy, a dev dependency)
+uv run ruff check .          # lint Python source
+uv build                     # build the wheel/sdist (hatchling backend)
+```
+
+There is no Python unit test suite — correctness is verified only through the `.robot` acceptance tests in `atests/`, which pop up real dialog windows and require a human (or scripted UI automation) to click through them. They cannot run in headless/CI environments.
+
+Keyword documentation (`docs/DialogsPlus.html`) is generated from the library's docstrings via Robot Framework's Libdoc, e.g.:
+
+```bash
+uv run python -m robot.libdoc src/DialogsPlus/dialogsplus.py docs/DialogsPlus.html
+```
+
+## Architecture
+
+The library follows a three-layer structure, all under `src/DialogsPlus/`:
+
+1. **`dialogsplus.py`** — the Robot Framework library class (`DialogsPlus`, `ROBOT_LIBRARY_SCOPE = 'SUITE'`). Each public method is decorated `@keyword` and becomes a Robot Framework keyword (e.g. `get_value_from_user_input` → `Get Value From User Input`). This layer only handles keyword argument parsing/validation, dynamic size calculations (e.g. dialog height/width scaled by number of fields/options in `get_multi_value` and `select_options_with_checkboxes`), and delegates the actual dialog logic to `widgets/wrappers.py`. The class constructor optionally loads a `DialogConfig` from a YAML file (`Library DialogsPlus config=path/to/config.yaml`).
+
+2. **`widgets/wrappers.py`** — one static-method "runner" class per keyword (e.g. `GetValueFromUserDialog`, `MultiValueInput`, `ChooseFromFileDialog`). Each wrapper instantiates the corresponding dialog class from `widgets/styling.py`, calls `.show()`, logs via `robot.api.logger`, and translates the raw dialog result dict into the keyword's return value (e.g. mapping a `status` of `"yes"/"no"/"cancel"` to `True/False/None`). `ExecuteManualStepDialog` also raises `robot.errors.ExecutionFailed` when the user fails a manual step, prompting for a failure reason via a nested `InputDialog`.
+
+3. **`widgets/styling.py`** — the actual `customtkinter`-based dialog implementations (`InputDialog`, `ManualStepDialog`, `CountdownDialog`, `ConfirmationDialog`, `MultiValueInputDialog`, `FileDialog`, `FolderDialog`, `CheckboxConfirmationDialog`, `MultiCheckboxDialog`, `PauseDialog`). Each subclasses `BaseDialog` from `widgets/base.py` and implements `build_ui(app)`, populating `self.result` and calling `app.quit()` on submit/cancel.
+
+Supporting modules:
+
+- **`widgets/base.py`** — `BaseDialogRunner` creates/centers/tears down the `ctk.CTk()` app window (sets appearance mode/theme once globally on first use, sets the window icon from `widgets/assets/robot.ico`, and runs `app.mainloop()`), and `BaseDialog` provides the styled widget factory methods (`create_button`, `create_label`, `create_entry`, `create_frame`, `create_progress_bar`, `create_checkbox`) that all dialogs use, plus the generic `show()` → `build_ui()` → return `self.result` flow.
+- **`utils/config.py`** — `DialogConfig` holds all visual/layout settings (theme, fonts, colors, sizes, spacing) with defaults, and `DialogConfig.from_yaml(path)` loads overrides from a user-supplied YAML config file (see `atests/config.yaml` for the shape).
+
+When adding a new keyword: add a `@keyword`-decorated method to `dialogsplus.py`, a runner class (or static method) in `wrappers.py`, and a new `BaseDialog` subclass in `styling.py` — following the existing pattern rather than putting UI logic directly in `dialogsplus.py`.

{robotframework_dialogsplus-0.1.0 → robotframework_dialogsplus-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: robotframework-dialogsplus
-Version: 0.1.0
+Version: 0.2.1
 Summary: A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords.
 Author-email: Alpha-Centauri-00 <Alpha@Centauri.c0m>
 License-Expression: MIT
@@ -31,7 +31,18 @@ A drop-in enhancement for Robot Framework's Dialogs library with modern UI and e
 - Supports dynamic sizing based on input fields or options
 
 ---
+## Installation
 
+```bach
+pip install robotframework-dialogsplus
+```
 
 
-Pull requests are welcome! More info coming soon.
+## 📚 Keyword Documentation
+
+👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
+
+👉 More Example of [HowTo](https://github.com/Alpha-Centauri-00/DialogsPlus/blob/main/docs/HowTo.md)
+                           
+
+Pull requests are welcome! More info coming soon.

{robotframework_dialogsplus-0.1.0 → robotframework_dialogsplus-0.2.1}/README.md

@@ -19,7 +19,18 @@ A drop-in enhancement for Robot Framework's Dialogs library with modern UI and e
 - Supports dynamic sizing based on input fields or options
 
 ---
+## Installation
 
+```bach
+pip install robotframework-dialogsplus
+```
 
 
-Pull requests are welcome! More info coming soon.
+## 📚 Keyword Documentation
+
+👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
+
+👉 More Example of [HowTo](https://github.com/Alpha-Centauri-00/DialogsPlus/blob/main/docs/HowTo.md)
+                           
+
+Pull requests are welcome! More info coming soon.

robotframework_dialogsplus-0.2.1/atests/testing.robot

@@ -0,0 +1,215 @@
+*** Settings ***
+Library           DialogsPlus    #config=D:/robotframework-dialogsplus/atests/config.yaml
+Library           OperatingSystem
+
+# Suite Setup       Set Log Level    level=TRACE
+# Test Setup        Log Test Case Name
+
+
+*** Keywords ***
+Log Test Case Name
+    [Tags]    robot:flatten
+    Log    <p style="background-color: #06bdb1; font-weight: bold; display: inline-block; padding: 4px;">*** Running Test: ${TEST NAME} ***</p>    html=${True}
+
+log Hello
+    Log     Hello    level=WARN
+
+*** Variables ***
+
+@{fields_val}     username    password    email    phone
+@{fields}         username    password
+&{default_val}    username=admin    password=P@55    phone=1234567
+&{default}        username=user1    password=P@55
+
+*** Test Cases ***
+
+Get Value From User Default
+    ${result}    Get Value From User Input   
+    ...    prompt=Enter your name:    
+    ...    default=Robot framework
+    
+    Should Be Equal    ${result}    Robot framework
+
+Run Manual Steps Executes
+    VAR    @{steps}        
+    ...    Open the app    
+    ...    Click Start button    
+    ...    Verify status
+
+    Run Manual Steps    ${steps}
+    Log    Manual steps executed successfully
+
+Run Manual Steps Executes With Plain Args
+    Run Manual Steps    
+    ...                open github    
+    ...                add username    
+    ...                add password    
+    ...                press login
+
+    Log    Manual steps executed successfully
+
+Count Down Runs
+    Count Down    3
+    Log    Countdown executed for 3 seconds
+
+Get Confirmation Returns Boolean
+    ${result}    Get Confirmation    Are you sure?
+    Should Be True    isinstance(${result}, bool)
+
+Get Multi Value
+    ${result}    Get Multi Value    ${fields}    default=${default}
+    Should Be Equal    ${result}[username]    user1
+
+
+Get Multi Value Multiple Fields
+    ${result}    Get Multi Value    ${fields_val}    default=${default_val}
+    Should Be Equal    ${result}[password]    P@55
+    Should Be Equal    ${result}[phone]       1234567
+
+Choose Single XML File
+    ${XML_FILETYPES}    Evaluate    [("xml files", "*.xml")]
+    ${result}=    Choose File    
+    ...    message=Select Single XML File    
+    ...    filetypes=${XML_FILETYPES}
+    
+    Should Contain    ${result}    .xml
+
+Choose Multiple HTML Files
+    ${HTML_FILETYPES}    Evaluate    [("HTML", "*.html")]
+    ${result}=    Choose File    
+    ...    message=Select Multiple HTML Files    
+    ...    filetypes=${HTML_FILETYPES}   multiple=True
+
+    Should Contain    ${result}[0]    .html
+
+Choose Folder Test
+    ${result}=    Choose Folder    message=Select Any Directory
+    Directory Should Exist    ${result}
+
+Single Ceckbox Test
+    ${r}    Confirm With Checkbox    
+    ...    message=Do you accept the terms?    
+    ...    checkbox_text=I accept, no matter what!
+
+    Should Be True    ${r}
+
+Select Many Checkbox Test
+    ${r}    Select Options With Checkboxes    
+    ...    message=Select as much as you want   
+    ...    options=${fields_val}
+
+    Should Not Be True    ${r}[username]
+    Should Not Be True    ${r}[password]
+    Should Not Be True    ${r}[email]
+    Should Not Be True    ${r}[phone]
+
+Select Many Checkbox With Defaults Test
+    @{Contacts}    Create List        Email    SMS    Phone    Slack    Discord
+    @{Selected_Defaults}    Create List    Email    SMS
+    ${selected}=    Select Options With Checkboxes
+    ...    message=Choose your preferences
+    ...    options=${Contacts}
+    ...    defaults=@{Selected_Defaults}         # Default Selected!
+    
+    Should Be True        ${selected}[Email]
+    Should Be True        ${selected}[SMS]
+    Should Not Be True    ${selected}[Phone]
+    Should Not Be True    ${selected}[Slack]
+    Should Not Be True    ${selected}[Discord]
+
+Pause The Test
+    Pause Test Execution    message=Check If System Is Running!
+
+Pause The Test With Command
+    Pause Test Execution    message=Check If System Is Running!    command=log Hello
+
+Pause The Test With Command That Opens A Dialog
+    @{args}    Create List    2
+    Pause Test Execution
+    ...    message=Check If System Is Running!
+    ...    command=Count Down
+    ...    command_args=${args}
+
+Pause The Test With Command That Fails
+    TRY
+        Pause Test Execution    message=Click Run, then Continue    command=Not Exist Keyword
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog With Text Box And Checkbox
+    Create Dialog    title=Login Form
+    Add Text Box    name=username    label=Username    default=admin
+    Add Checkbox    name=remember_me    label=Remember Me
+    Add Button    text=OK
+    Add Button    text=Cancel
+    ${result}    Show Dialog
+    Log    Button clicked: ${result}[button]
+    Log    Username: ${result}[username]
+    Log    Remember me: ${result}[remember_me]
+
+
+Create Dialog With Side Command Button
+    Create Dialog    title=Diagnostics
+    Add Label    text=Run diagnostics before continuing if you like.
+    Add Button    text=Run Diagnostics    command=log Hello    closes_dialog=False
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[button]    OK
+
+Add Text Box Fails Without Create Dialog First
+    TRY
+        Add Text Box    name=orphan
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog Fails Without A Closing Button
+    Create Dialog    title=No Closing Button
+    Add Label    text=This has no OK/Cancel button
+    TRY
+        Show Dialog
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog With Masked Text Box
+    Create Dialog    title=Login Form
+    Add Text Box    name=username    label=Username    default=admin
+    Add Text Box    name=password    label=Password    mask=True
+    Add Button    text=OK
+    ${result}    Show Dialog
+
+Create Dialog With Radio Group
+    Create Dialog    title=Test Result
+    Add Radio Group    name=verdict    label=Verdict    options=Pass|Fail|Blocked    default=Pass
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Contain    ${{['Pass', 'Fail', 'Blocked']}}    ${result}[verdict]
+    Log    Verdict selected: ${result}[verdict]
+
+Add Radio Group Fail and Pass
+    Create Dialog    title=Verdict
+    Add Radio Group    name=verdict    options=Pass|Fail    default=Pass
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[verdict]    Pass
+
+Create Dialog With Dropdown
+    Create Dialog    title=Browser Selection
+    Add Dropdown    name=browser    label=Browser    options=Chrome|Firefox|Edge    default=Firefox
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Log    Browser selected: ${result}[browser]
+
+Add Dropdown Fails With Bad Default
+    Create Dialog    title=Bad Dropdown Default
+    TRY
+        Add Dropdown    name=browser    options=Chrome|Firefox    default=Safari
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+    Add Dropdown    name=browser    options=Chrome|Firefox    default=Chrome
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[browser]    Chrome