Skip to content

Display & visualization

Maturity labels

  • Now: Stable and supported in current releases.
  • Preview: Usable today, but behavior and APIs may evolve.
  • Planned: Not yet implemented.

Note

Status: Now

1) What it solves

Typed data is only useful if you can inspect it quickly while iterating.

2) The idea

Omnipy models and datasets expose a shared display surface: peek(), full(), browse(), and _docs().

3) Example

>>> import omnipy as om
>>> m = om.Model[dict[str, list[int]]]({'a': [1, 2], 'b': [3, 4]})
>>> m

4) Output / display

╭────────────────────────────╮
│      Model[dict[str,       │
│        list[int]]]         │
│                            │
│ {'a': [1, 2], 'b': [3, 4]} │
╰────────────────────────────╯

5) When to use / when not

Use in notebooks, terminal debugging, and docs examples.

Avoid browse() in headless environments.

6) Gotchas

  • Display output depends on UI environment (terminal vs notebook).
  • Keep runnable docs examples on _docs()/.json() for deterministic output.