Skip to content

Components catalog

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

You need a quick map of bundled component families to choose the right starting abstraction.

2) The idea

Omnipy ships component groups for common data/interoperability patterns:

  • General
  • JSON
  • Nested
  • Raw
  • Remote
  • Tables

3) Example

>>> import omnipy as om
>>> ds = om.JsonListOfDictsDataset({'rows': [{'id': 'a', 'x': 1}, {'id': 'b', 'x': 2}]})
>>> ds.json()

4) Output / display

╭───┬────────────────┬──────────────────────┬────────┬──────────────────╮
│ # │ Data file name │         Type         │ Length │ Size (in memory) │
│   │                │                      │        │                  │
│ 0 │ rows           │ JsonListOfDictsModel │      2 │           2.8 kB │
╰───┴────────────────┴──────────────────────┴────────┴──────────────────╯

5) When to use / when not

Use these components when standard Python containers plus one-off glue stop scaling for your pipeline.

If plain Model[T]/Dataset[...] already solves your case, stay simple.

6) Gotchas

  • Depth differs by area; some families are richer than others.
  • Prefer examples and APIs that exist today (Now/Preview/Planned labels matter).