Blosc/python-blosc2

[DOC] Tutorial: variable-length columns (ListArray and BatchArray)

Open

#649 geöffnet am 2. Juni 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (47 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (207 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

12.batcharray.ipynb covers BatchArray basics but there is no tutorial for ListArray — the newer, more flexible varlen column type. Users working with nested or ragged data (e.g. GPS waypoints, tags, embeddings of varying length) have no worked example to follow.

Suggested work: Extend 12.batcharray.ipynb or add 12b.listarray.ipynb covering:

  • Creating a ListArray with item_spec
  • Appending, extending, and fancy-indexing
  • Embedding a ListArray as a column inside a CTable (using the dataclass schema API)
  • Arrow round-trip (from_arrow / to_arrow)
  • When to prefer ListArray over BatchArray

Contributor Guide

Research-Richtung
Erweitern Sie das vorhandene Notebook 12.batcharray.ipynb, indem Sie einen neuen Abschnitt hinzufügen oder ein separates Notebook für ListArray erstellen, das die Erstellung mit item spec, Appending, Indexierung, Einbettung in CTable und Arrow Roundtrip abdeckt. Fügen Sie Codebeispiele und Erklärungen für jeden Schritt hinzu.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Pythonblosc2Jupyter Notebooks
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70