Merge pull request #663 from Blosc/b2view-plotting

B2view plotting and other improvements

Author: FrancescAlted

.github/workflows/cibuildwheels.yml

@@ -127,8 +127,62 @@ jobs:
             ./wheelhouse/*.tar.gz
 
 
+  build_wheels_wasm:
+    name: Build WASM/Pyodide wheels for ${{ matrix.p_ver }}
+    runs-on: ubuntu-latest
+    env:
+      CIBW_BUILD: ${{ matrix.cibw_build }}
+      # WASM/Pyodide has no SIMD/runtime CPU detection; disable optimised paths
+      CMAKE_ARGS: "-DWITH_ZLIB_OPTIM=OFF -DWITH_OPTIM=OFF -DWITH_RUNTIME_CPU_DETECTION=OFF"
+      CIBW_TEST_COMMAND: "pytest {project}/tests"
+      # Pin the Pyodide version explicitly per target for reproducible builds.
+      # cp313 stays on 0.29.3 (the version wasm.yml proves good): 0.29.4, the
+      # cibuildwheel 4.1 default, regresses SChunk get_slice on WASM.
+      CIBW_PYODIDE_VERSION: ${{ matrix.pyodide_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Python 3.13 -> pyemscripten_2025_0
+          - p_ver: "3.13"
+            cibw_build: "cp313-*"
+            pyodide_version: "0.29.3"
+            artifact_name: "wasm-pyodide-cp313"
+          # Python 3.14 -> pyemscripten_2026_0
+          - p_ver: "3.14"
+            cibw_build: "cp314-*"
+            pyodide_version: "314.0.0"
+            artifact_name: "wasm-pyodide-cp314"
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake
+
+      - name: Install cibuildwheel
+        run: pip install "cibuildwheel==4.1.*"
+
+      - name: Build wheels
+        # Testing is performed automatically by cibuildwheel (via node).
+        # platform=pyodide can only be set via the CLI flag, not an env var.
+        run: cibuildwheel --platform pyodide
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: ${{ matrix.artifact_name }}
+          path: ./wheelhouse/*.whl
+
+
   upload_pypi:
-    needs: [ build_wheels]
+    needs: [ build_wheels, build_wheels_wasm ]
     runs-on: ubuntu-latest
     # Only upload wheels when tagging (typically a release)
     if: startsWith(github.event.ref, 'refs/tags')

RELEASE_NOTES.md

@@ -4,6 +4,34 @@
 
 XXX version-specific blurb XXX
 
+### CTable display
+
+- **`CTable.to_string()` now renders the whole table by default** (every row and
+  every column), like `pandas`' `DataFrame.to_string()`.  New `max_rows` and
+  `max_width` parameters truncate on demand.  *Behaviour change*: previously
+  `to_string()` returned the truncated view; code that relied on that should
+  pass `max_rows=`/`max_width=` (or use `str()`).
+- **The `[N rows x M columns]` dimensions footer now follows pandas**: omitted by
+  `to_string()` (pass `show_dimensions=True` to force it), and shown by
+  `str`/`repr`/`print` only when the view is actually truncated.  Previously it
+  was always appended.
+- **`repr(ctable)` now shows the same truncated table as `str(ctable)`**
+  (pandas/polars convention), instead of the one-line `CTable<…>` summary.  The
+  compact summary remains available via `ctable.info`.
+- **New display options** in `set_printoptions`: `display_width` controls the
+  column-fitting width budget (`None` = auto-detect terminal, `-1` = show all
+  columns, positive int = fixed budget), and `display_rows` now accepts `-1` to
+  show all rows (`0` still shows none).
+- **New `blosc2.printoptions(...)` context manager** temporarily sets the display
+  options and restores them on exit, e.g.
+  `with blosc2.printoptions(display_rows=-1, display_width=-1): print(t)`.
+
+### CTable I/O
+
+- **`CTable.to_csv()` now accepts no path**, returning the CSV as a string like
+  `pandas`' `DataFrame.to_csv()`.  Passing a path still writes the file (and
+  returns `None`); the returned string is byte-for-byte the same as the file.
+
 ## Changes from 4.4.3 to 4.4.5
 
 Note: 4.4.4 was skipped due to a failure during the release process.

doc/getting_started/b2view.rst

@@ -8,7 +8,10 @@ metadata and vlmeta of the selected node, and a paged view of the data
 itself — NDArrays of any dimensionality as well as CTables.
 
 ``b2view`` is installed with python-blosc2; no extra dependencies are
-needed.
+needed, including the in-terminal braille plot (the ``p`` key).  Only the
+high-resolution image view (the ``h`` key) needs the ``hires`` extra —
+``pip install "blosc2[hires]"``.  See :doc:`installation` for the list of
+extras.
 
 Step 1 — Create a sample store
 ------------------------------

doc/getting_started/installation.rst

@@ -16,6 +16,38 @@ Conda
 
     conda install -c conda-forge python-blosc2
 
+Optional features (extras)
+++++++++++++++++++++++++++
+
+The base install already includes everything needed for compression, the
+array machinery, and the :doc:`b2view <b2view>` terminal browser.  A few
+heavier, feature-specific dependencies are kept out of it and grouped
+into *extras* that you opt into with the ``blosc2[extra]`` syntax:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 18 82
+
+   * - Extra
+     - Adds
+   * - ``hires``
+     - The high-resolution image view in b2view (the ``h`` key), which
+       renders a real ``matplotlib`` image in the terminal
+       (``textual-image``, ``matplotlib``).  The lightweight braille plot
+       (the ``p`` key) is built in and needs no extra.
+   * - ``parquet``
+     - The ``parquet-to-blosc2`` converter (``pyarrow``); see
+       :doc:`parquet_to_blosc2`.
+
+Install one or more extras by listing them in brackets (quote the
+argument in shells like ``zsh`` that treat brackets specially):
+
+.. code-block:: console
+
+    pip install "blosc2[hires]"           # b2view high-res view (h key)
+    pip install "blosc2[parquet]"         # the Parquet converter
+    pip install "blosc2[hires,parquet]"   # both at once
+
 Source code
 +++++++++++
 

pyproject.toml

@@ -40,6 +40,7 @@ dependencies = [
     "requests",
     "rich",
     "textual",
+    "textual-plotext",
     "threadpoolctl; platform_machine != 'wasm32'",
 ]
 version = "4.4.6.dev0"
@@ -52,6 +53,11 @@ documentation = "https://www.blosc.org/python-blosc2/python-blosc2.html"
 
 [project.optional-dependencies]
 parquet = ["pyarrow"]
+# The b2view TUI and its in-terminal braille plot (the 'p' key) are core deps,
+# so they work out of the box.  This extra only adds the high-res 'h' view,
+# which renders a real matplotlib image (kitty/iTerm2/sixel, or half-cells
+# elsewhere) — matplotlib is the heavy part, hence the opt-in.
+hires = ["textual-image", "matplotlib"]
 
 [project.scripts]
 parquet-to-blosc2 = "blosc2.cli.parquet_to_blosc2:main"

src/blosc2/__init__.py

@@ -642,6 +642,7 @@ def _raise(exc):
     get_null_policy,
     get_printoptions,
     null_policy,
+    printoptions,
     set_printoptions,
 )
 from .groupby import CTableGroupBy, group_reduce
@@ -1075,5 +1076,6 @@ def _raise(exc):
     "get_null_policy",
     "get_printoptions",
     "null_policy",
+    "printoptions",
     "set_printoptions",
 ]