Files
windmill/python-client/wmill
Ruben FiszelandClaude Opus 5.5 98439f8521 feat: test flows from the SDKs with mocked or replaced steps, subflows included (#12538)
* feat: test flows from the SDKs with mocked or replaced steps

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: walk only real flow modules and refuse overrides a step would ignore

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: harden flow tests against sdk tokens, rls, test-run pins and built-in tools

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: require the code capability to test a flow

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: refuse overriding ai agent tools in flow tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: refuse overriding the preprocessor, which a flow test never runs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat: override steps inside subflows in flow tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: gate subflow overrides on worker version and disable caching in flow tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: note subflows never run their preprocessor in flow test docstrings

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 14:40:33 +01:00
..
2024-01-16 23:32:26 +01:00
2026-10-21 20:07:53 +02:00

wmill

The core client for the Windmill platform.

Usage

Basic Usage

The wmill package has several methods at the top-level for the most frequent operations you will need.

The following are some common examples:

import time

import wmill


def main():
    # Get the value of a variable
    wmill.get_variable("u/user/variable_path")
    
    # Run a script synchronously and get the result
    wmill.run_script("f/pathto/script", args={"arg1": "value1"})
    
    # Get the value of a resource
    wmill.get_resource("u/user/resource_path")
    
    # Set the script's state
    wmill.set_state({"ts": time.time()})
    
    # Get the script's state
    wmill.get_state()

Advanced Usage

The wmill package also exposes the Windmill class, which is the core client for the Windmill platform.

import time

from wmill import Windmill

def main():
    client = Windmill(
        # token=...  <- this is optional. otherwise the client will look for the WM_TOKEN env var
    )

    # Get the current version of the client
    client.version

    # Get the current user
    client.user
    
    # Convenience get and post methods exist for https://app.windmill.dev/openapi.html#/
    # these are thin wrappers around the httpx library's get and post methods
    # list worker groups
    client.get("/configs/list_worker_groups")
    # create a group
    client.post(
        f"/w/{client.workspace}/groups/create",
        json={
            "name": "my-group",
            "summary": "my group summary",
        }
    )
    
    # Get and set the state of the script
    now = time.time()
    client.state = {"ts": now}
    assert client.state == {"ts": now}
    
    # Run a job asynchronously
    job_id = client.run_script_async(path="path/to/script")
    # Get its status
    client.get_job_status(job_id)
    # Get its result
    client.get_result(job_id)