Skip to content

render

Rich rendering helpers shared by the fluid-control CLI command handlers.

These helpers require the rich extra and are kept separate from the command definitions so both the interactive entry point (fluid_control.cli.cli) and the command handlers (fluid_control.cli.commands) can reuse them without a circular import.

location_table(loc)

Render an axis-position dict as a Rich table.

Parameters:

Name Type Description Default
loc dict[str, float]

Mapping of axis name → position in mm.

 required

Returns:

Type Description
Table

A [Table][rich.table.Table] ready for console output.
Source code in src/fluid_control/cli/render.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def location_table(loc: dict[str, float]) -> Table:
    """
    Render an axis-position dict as a Rich table.

    Args:
        loc: Mapping of axis name → position in mm.

    Returns:
        A [`Table`][rich.table.Table] ready for console output.

    """
    table = Table(show_header=True, header_style="festo.brand", box=box.SIMPLE, padding=(0, 1))
    table.add_column("Axis", style="bold")
    table.add_column("Position (mm)", justify="right", style="festo.value")
    for axis, pos in loc.items():
        table.add_row(axis, f"{pos:.3f}")
    return table

print_result(result)

Print a fluid-control result to the console with status styling.

Parameters:

Name Type Description Default
result OperationResult | Sequence[int | str]

An OperationResult (code, message) (or any two-element [status_code, message] sequence) as returned by fluid-control operations. Status code 0 is clear (success), 1 is error, 2 is busy.

 required
Source code in src/fluid_control/cli/render.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def print_result(result: OperationResult | Sequence[int | str]) -> None:
    """
    Print a fluid-control result to the console with status styling.

    Args:
        result: An [`OperationResult`][fluid_control.fluid_control.OperationResult]
            ``(code, message)`` (or any two-element ``[status_code, message]``
            sequence) as returned by fluid-control operations.  Status code
            ``0`` is clear (success), ``1`` is error, ``2`` is busy.

    """
    if not result:
        return
    code = result[0] if result else 1
    message = str(result[1]) if len(result) > 1 else ""
    if code == 0:
        console.print(f"[festo.ok]✓[/] {message}")
    elif code == 2:
        console.print(f"[festo.muted]~[/] {message}")
    else:
        console.print(f"[red]✗[/] {message}")

status_table(status)

Render a fluid-control status dict as a Rich table.

Parameters:

Name Type Description Default
status dict

Status dict as returned by PressureOverLiquidControl.get_status.

 required

Returns:

Type Description
Table

A [Table][rich.table.Table] ready for console output.
Source code in src/fluid_control/cli/render.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def status_table(status: dict) -> Table:
    """
    Render a fluid-control status dict as a Rich table.

    Args:
        status: Status dict as returned by
            [`PressureOverLiquidControl.get_status`][fluid_control.fluid_control.PressureOverLiquidControl.get_status].

    Returns:
        A [`Table`][rich.table.Table] ready for console output.

    """
    table = Table(show_header=True, header_style="festo.brand", box=box.SIMPLE, padding=(0, 1))
    table.add_column("Key", style="bold")
    table.add_column("Value", justify="left", style="festo.value")
    for key, value in status.items():
        table.add_row(str(key), str(value))
    return table