vericue 0.3.5__tar.gz

vericue-0.3.5/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: vericue
+Version: 0.3.5
+Summary: Python client library for veriCue test automation framework
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Provides-Extra: inspector
+Requires-Dist: rich>=13.0; extra == "inspector"
+Provides-Extra: robot
+Requires-Dist: robotframework>=6.0; extra == "robot"

vericue-0.3.5/README.md

@@ -0,0 +1,87 @@
+# veriCue Python Client
+
+An asynchronous Python client library for communicating with the veriCue server. Built on asyncio.
+
+## Installation
+
+```bash
+# Install from the client directory
+pip install -e client/python
+
+# With development dependencies (pytest)
+pip install -e "client/python[dev]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+from vericue import VeriCueClient
+
+async def main():
+    async with VeriCueClient() as client:
+        await client.connect("127.0.0.1", 4242)
+
+        pong = await client.ping()
+        print(f"Ping: {pong}")        # True
+
+        version = await client.version()
+        print(f"Server: {version}")    # {"server": "vericue", "version": "0.1.0", ...}
+
+        echo = await client.echo("hello")
+        print(f"Echo: {echo}")         # "hello"
+
+asyncio.run(main())
+```
+
+## API
+
+```python
+class VeriCueClient:
+    async def connect(host="127.0.0.1", port=4242) -> None
+    async def disconnect() -> None
+    is_connected: bool
+
+    # High-level commands
+    async def ping() -> bool
+    async def version() -> dict
+    async def echo(text: str) -> str
+
+    # Low-level command
+    async def send_request(method: str, params: dict = None) -> dict
+```
+
+Supports async context manager (`async with`). Default timeout: 10 seconds (configurable via `VeriCueClient(timeout=30.0)`).
+
+## Error Handling
+
+```python
+from vericue import VeriCueClient, ServerError, ConnectionError, ProtocolError
+
+try:
+    result = await client.send_request("unknown_method")
+except ServerError as e:
+    print(e.code, e.message)    # 1003, "Unknown method: unknown_method"
+except ConnectionError:
+    print("Not connected to server")
+```
+
+## Testing
+
+```bash
+pytest client/python/tests/
+```
+
+Tests use a mock TCP server (asyncio) — no running veriCue server required.
+
+## Structure
+
+```
+vericue/
+├── __init__.py    — public exports
+├── client.py      — VeriCueClient (asyncio)
+├── protocol.py    — framing and message building
+└── errors.py      — exceptions (VeriCueError, ServerError, ConnectionError, ProtocolError)
+examples/          — usage examples
+tests/             — unit and integration tests
+```

vericue-0.3.5/examples/event_subscriptions.py

@@ -0,0 +1,78 @@
+"""Live event subscription example.
+
+Subscribes to a button's ``clicked`` signal and a line-edit's ``text``
+property, simulates input, then prints every push event the server
+sends. Demonstrates both per-subscription callbacks and the shared
+``events()`` async iterator.
+
+Usage:
+    # Start the test app first (in another shell):
+    QT_QPA_PLATFORM=offscreen \
+        LD_LIBRARY_PATH=build/server:$QT_LIB \
+        build/examples/test_app/vericue-test-app --port 4242
+
+    python client/python/examples/event_subscriptions.py
+"""
+
+from __future__ import annotations
+
+import asyncio
+
+from vericue import VeriCueClient
+
+
+async def main() -> None:
+    async with VeriCueClient() as client:
+        await client.connect("127.0.0.1", 4242)
+
+        # 1. Subscribe with a per-event callback.
+        async def on_click(event: dict) -> None:
+            print(f"  → callback got click event at {event['timestamp']}")
+
+        click_id = await client.subscribe_signal(
+            "TestWindow/centralWidget/testButton", "clicked", callback=on_click,
+        )
+        print(f"Subscribed to clicked: {click_id}")
+
+        # 2. Subscribe to a property and just consume from the queue.
+        text_id = await client.subscribe_property(
+            "TestWindow/centralWidget/testInput", "text",
+        )
+        print(f"Subscribed to text property: {text_id}")
+
+        # 3. Subscribe to destroyed.
+        destroyed_id = await client.subscribe_destroyed(
+            "TestWindow/centralWidget/testLabel",
+        )
+        print(f"Subscribed to destroyed: {destroyed_id}")
+
+        # Inspect what's active server-side.
+        active = await client.list_subscriptions()
+        print(f"Active subscriptions: {[s['subscription_id'] for s in active]}")
+
+        # Simulate some activity that should produce events.
+        await client.mouse_click("TestWindow/centralWidget/testButton")
+        await client.set_property(
+            "TestWindow/centralWidget/testInput", "text", "hello world",
+        )
+
+        # Drain a few events.
+        for _ in range(2):
+            try:
+                event = await client.next_event(timeout=2.0)
+                print(
+                    f"  ← {event['event']:18s} sub={event['subscription_id']} "
+                    f"data={event['data']}"
+                )
+            except asyncio.TimeoutError:
+                print("  (no more events within 2s)")
+                break
+
+        await client.unsubscribe(click_id)
+        await client.unsubscribe(text_id)
+        await client.unsubscribe(destroyed_id)
+        print("All subscriptions removed.")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

vericue-0.3.5/examples/keyboard_and_drag.py

@@ -0,0 +1,88 @@
+"""Keyboard shortcuts and drag & drop example.
+
+Demonstrates key_press (special keys, modifier combos) and drag commands.
+
+Usage:
+    1. Start a demo app:  ./build/examples/demo_app/vericue-demo-app
+    2. Run this script:   python examples/keyboard_and_drag.py
+"""
+
+import asyncio
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from vericue import VeriCueClient
+
+
+async def main():
+    async with VeriCueClient() as client:
+        await client.connect("127.0.0.1", 4242)
+        print("Connected.\n")
+
+        # --- Keyboard shortcuts ---
+        print("=== Keyboard Shortcuts ===")
+
+        # Click on input field and type, then use keyboard to select all + delete
+        input_path = "DemoMainWindow/centralWidget/inputField"
+
+        await client.mouse_click(input_path)
+        await client.type_text(input_path, "Hello World")
+        print("Typed 'Hello World'")
+
+        # Select all with Ctrl+A
+        await client.key_press(input_path, "ctrl+a")
+        print("Pressed Ctrl+A (select all)")
+
+        # Delete selection
+        await client.key_press(input_path, "delete")
+        print("Pressed Delete")
+
+        # Type new text and press Enter
+        await client.type_text(input_path, "New content")
+        await client.key_press(input_path, "enter")
+        print("Typed 'New content' + Enter")
+
+        # Tab to next widget
+        await client.key_press(input_path, "tab")
+        print("Pressed Tab (focus next widget)")
+
+        # Arrow keys
+        await client.key_press(input_path, "up", repeat=3)
+        print("Pressed Up x3")
+
+        # Escape
+        await client.key_press(input_path, "escape")
+        print("Pressed Escape")
+
+        # Function key
+        await client.key_press(input_path, "f1")
+        print("Pressed F1")
+
+        # --- Drag ---
+        print("\n=== Drag & Drop ===")
+
+        # Drag on the progress bar (simulates slider drag)
+        progress_path = "DemoMainWindow/centralWidget/progressBar"
+
+        result = await client.drag(progress_path, 10, 10, 150, 10)
+        print(f"Dragged from ({result['from']['x']},{result['from']['y']}) "
+              f"to ({result['to']['x']},{result['to']['y']})")
+
+        # Drag with right button
+        result = await client.drag(progress_path, 0, 0, 50, 50, button="right")
+        print(f"Right-button drag completed")
+
+        # Drag with modifier (Ctrl+drag for copy in many apps)
+        result = await client.drag(
+            progress_path, 20, 15, 180, 15,
+            modifiers=["ctrl"]
+        )
+        print(f"Ctrl+drag completed")
+
+        print("\nDone!")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

vericue-0.3.5/examples/model_data_access.py

@@ -0,0 +1,190 @@
+"""Model/View data access example.
+
+Demonstrates reading data from QTableView, QTreeView, and QListView models:
+model info (row/column counts, headers), single cell reads, range queries,
+and filtering.
+
+Usage:
+    1. Build and start the table demo:
+         cmake --build build --parallel
+         ./build/examples/table_app/vericue-table-app --port 4245
+    2. Run this script:
+         python examples/model_data_access.py
+"""
+
+import asyncio
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from vericue import VeriCueClient, ServerError
+
+
+HOST = "127.0.0.1"
+PORT = 4245
+
+
+def log(msg: str) -> None:
+    print(f"  >> {msg}")
+
+
+async def main():
+    async with VeriCueClient(timeout=15.0) as client:
+        await client.connect(HOST, PORT)
+        log("Connected to Table Demo app\n")
+
+        # ──────────────────────────────────────────
+        # 1. EMPLOYEE TABLE — model info
+        # ──────────────────────────────────────────
+        print("=" * 60)
+        print("  1. EMPLOYEE TABLE — Model Info")
+        print("=" * 60)
+
+        table_path = (await client.find_object(object_name="employeeTable"))["path"]
+        info = await client.get_model_info(table_path)
+
+        log(f"Model class:  {info['model_class']}")
+        log(f"Rows:         {info['row_count']}")
+        log(f"Columns:      {info['column_count']}")
+        log(f"Headers:      {info['horizontal_headers']}")
+
+        # ──────────────────────────────────────────
+        # 2. EMPLOYEE TABLE — single cell reads
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  2. EMPLOYEE TABLE — Single Cell Reads")
+        print("=" * 60)
+
+        for row in range(min(5, info["row_count"])):
+            name = await client.get_model_data(table_path, row=row, column=0)
+            dept = await client.get_model_data(table_path, row=row, column=1)
+            salary = await client.get_model_data(table_path, row=row, column=2)
+            log(f"Row {row}: {name['value']:20s} | {dept['value']:15s} | ${salary['value']}")
+
+        # ──────────────────────────────────────────
+        # 3. EMPLOYEE TABLE — range query (all rows)
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  3. EMPLOYEE TABLE — Full Range Query")
+        print("=" * 60)
+
+        data = await client.get_model_data(table_path)
+        log(f"Fetched {data['row_count']} rows")
+
+        # Print as formatted table
+        headers = info["horizontal_headers"]
+        col_widths = [max(len(str(h)), 15) for h in headers]
+
+        header_line = " | ".join(f"{h:<{w}}" for h, w in zip(headers, col_widths))
+        log(header_line)
+        log("-" * len(header_line))
+
+        for row_data in data["rows"]:
+            cells = row_data["cells"]
+            values = [str(cells.get(str(i), "")) for i in range(len(headers))]
+            line = " | ".join(f"{v:<{w}}" for v, w in zip(values, col_widths))
+            log(line)
+
+        # ──────────────────────────────────────────
+        # 4. EMPLOYEE TABLE — filtered columns
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  4. EMPLOYEE TABLE — Name and City Only (columns 0, 3)")
+        print("=" * 60)
+
+        data = await client.get_model_data(table_path, columns=[0, 3])
+        for row_data in data["rows"]:
+            cells = row_data["cells"]
+            name = cells.get("0", "")
+            city = cells.get("3", "")
+            log(f"{name:20s} → {city}")
+
+        # ──────────────────────────────────────────
+        # 5. EMPLOYEE TABLE — partial range
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  5. EMPLOYEE TABLE — Rows 3-7 only")
+        print("=" * 60)
+
+        data = await client.get_model_data(table_path, start_row=3, end_row=7)
+        log(f"Fetched rows {data['start_row']}-{data['end_row']} ({data['row_count']} rows)")
+        for row_data in data["rows"]:
+            cells = row_data["cells"]
+            log(f"  Row {row_data['row']}: {cells.get('0', '')} — {cells.get('1', '')}")
+
+        # ──────────────────────────────────────────
+        # 6. CITY LIST — model info + data
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  6. CITY LIST")
+        print("=" * 60)
+
+        list_path = (await client.find_object(object_name="cityList"))["path"]
+        list_info = await client.get_model_info(list_path)
+        log(f"Model: {list_info['model_class']}, {list_info['row_count']} items")
+
+        list_data = await client.get_model_data(list_path)
+        cities = [row["cells"]["0"] for row in list_data["rows"]]
+        log(f"Cities: {', '.join(cities)}")
+
+        # ──────────────────────────────────────────
+        # 7. FILE TREE — model info + data
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  7. FILE TREE")
+        print("=" * 60)
+
+        tree_path = (await client.find_object(object_name="fileTree"))["path"]
+        tree_info = await client.get_model_info(tree_path)
+        log(f"Model: {tree_info['model_class']}")
+        log(f"Top-level rows: {tree_info['row_count']}, columns: {tree_info['column_count']}")
+        log(f"Headers: {tree_info['horizontal_headers']}")
+
+        tree_data = await client.get_model_data(tree_path)
+        for row_data in tree_data["rows"]:
+            cells = row_data["cells"]
+            log(f"  {cells.get('0', '')} {cells.get('1', '')}")
+
+        # ──────────────────────────────────────────
+        # 8. SEARCH — find employees by department
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  8. SEARCH — Engineering Department")
+        print("=" * 60)
+
+        all_data = await client.get_model_data(table_path)
+        engineering = [
+            row for row in all_data["rows"]
+            if row["cells"].get("1") == "Engineering"
+        ]
+        log(f"Found {len(engineering)} engineers:")
+        for row_data in engineering:
+            cells = row_data["cells"]
+            log(f"  {cells['0']:20s} ${cells['2']} in {cells['3']}")
+
+        # ──────────────────────────────────────────
+        # 9. AGGREGATION — average salary by department
+        # ──────────────────────────────────────────
+        print(f"\n{'=' * 60}")
+        print("  9. SALARY SUMMARY")
+        print("=" * 60)
+
+        departments: dict[str, list[int]] = {}
+        for row_data in all_data["rows"]:
+            cells = row_data["cells"]
+            dept = cells.get("1", "")
+            salary = int(cells.get("2", "0"))
+            departments.setdefault(dept, []).append(salary)
+
+        for dept, salaries in sorted(departments.items()):
+            avg = sum(salaries) / len(salaries)
+            log(f"  {dept:15s}  avg: ${avg:>10,.0f}  headcount: {len(salaries)}")
+
+        print(f"\n{'=' * 60}")
+        print("  DONE — all model data access completed")
+        print("=" * 60)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

vericue-0.3.5/examples/ping_example.py

@@ -0,0 +1,23 @@
+"""Minimal example: connect to a veriCue server and run basic commands."""
+
+import asyncio
+
+from vericue import VeriCueClient
+
+
+async def main():
+    async with VeriCueClient() as client:
+        await client.connect("127.0.0.1", 4242)
+
+        pong = await client.ping()
+        print(f"Ping: {pong}")
+
+        version = await client.version()
+        print(f"Version: {version}")
+
+        echo = await client.echo("hello vericue")
+        print(f"Echo: {echo}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())