piermesh/docs/ui.md

ui: TUI application

class ui.TUI(driver_class: Type[Driver] | None = None, css_path: str | PurePath | List[str | PurePath] | None = None, watch_css: bool = False)

TUI for PierMesh

🔗 Source

visibleLogo

Whether the logo is visible or not, used in toggling visibility

• Type: bool

nodeOb

Reference to the Node running the PierMesh service

• Type: Node

done

Whether the TUI has been killed

• Type: bool

CSS_PATH : ClassVar[CSSPathType | None] = 'ui.tcss'

File paths to load CSS from.

action_quitFull()

Kill the whole stack by setting self to done and terminating the thread. We check in run.monitor later and kill the rest of the stack then with psutil

SEE ALSO

run.monitor

action_toggleFullscreen()

Toggle fullscreen logs by either collapsing width or setting it to it’s original size

compose()

Build the TUI

do_set_cpu_percent(percent: float)

Set CPU percent in the label and progress bar

• Parameters: percent (float) – Percent of the cpu PierMesh is using

do_set_mem(memmb: float)

Set memory usage label in the ui

• Parameters: memmb (float) – Memory usage of PierMesh in megabytes

do_write_line(logLine: str)

Write line to the logs panel

• Parameters: logLine (str) – Line to log

on_mount()

Called at set up, configures the title and the progess bar