Skip to content

Keyboard

GUI shortcuts

Built-in shortcuts while using the GUI (Qt and matplotlib backends):

  • F1 show the help shortcuts in the terminal
  • F11 toggle fullscreen mode
  • W write full resolution image to disk
  • R reset parameters
  • I print parameters dictionary in the command line
  • E export parameters dictionary to a yaml file
  • O import parameters dictionary from a yaml file (sliders update)
  • G export a pipeline diagram (requires graphviz)

KeyboardControl

A KeyboardControl behaves exactly like a slider internally, but is driven by key presses instead of a widget:

from interactive_pipe import interactive, KeyboardControl

@interactive(
    image_index=KeyboardControl(0, [0, 2], keydown="pagedown", keyup="pageup", modulo=True)
)
def switch_image(img1, img2, img3, image_index=0):
    return [img1, img2, img3][image_index]
  • keydown decreases the value (or toggles a bool), keyup increases it.
  • modulo=True wraps around at the range bounds — here Page Up past index 2 goes back to 0.
  • Special keys: arrows, "pageup"/"pagedown", spacebar, "f1"–"f12"; anything else is a single character.
  • On backends without key events (gradio, notebook), a KeyboardControl maps back to a regular slider — no need to remove it.

Keyboard bindings always use the explicit KeyboardControl object — there is no tuple shorthand for them. A bool KeyboardControl(True, keydown="k") turns a checkbox into a K toggle.

Key-bound one-shot events

For events that are not values — "trigger this on the next run" — bind a key to the context and read it through the read-only events proxy:

from interactive_pipe import events, interactive

@interactive()
def noise_burst(img):
    if events.get("noise_burst"):  # True only on the run following the key press
        return add_noise(img)
    return img

demo = interactive_pipeline(gui="qt")(my_pipeline)
demo.pipeline.bind_key_to_context("n", "noise_burst", "one-shot noise burst")

See demo/key_event_demo.py for the full example.