Merge branch 'main' into cli

Author: tlambert03

.github/workflows/ci.yml

@@ -15,9 +15,18 @@ jobs:
   check-manifest:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - run: pipx run check-manifest
 
+  pyright:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - run: uv run pyright
+
   test:
     name: ${{ matrix.os }} py${{ matrix.python-version }} ${{ matrix.gui }} ${{ matrix.canvas }}
     runs-on: ${{ matrix.os }}
@@ -85,9 +94,9 @@ jobs:
             canvas: pygfx
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
 
@@ -154,9 +163,9 @@ jobs:
         python-version: ["3.10", "3.12"]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - uses: pyvista/setup-headless-display-action@main
@@ -193,8 +202,8 @@ jobs:
   test-docs:
     runs-on: macos-latest # nicer screenshots
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v6
       - name: 📚 Build docs
         run: uv run --group docs mkdocs build --strict
       - uses: actions/upload-artifact@v4
@@ -213,7 +222,7 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 

.github/workflows/deploy_docs.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: macos-latest  # nicer screenshots
     if: github.repository == 'pyapp-kit/ndv'
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - uses: astral-sh/setup-uv@v5
+      - uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
 

.github_changelog_generator

@@ -3,4 +3,4 @@ project=ndv
 issues=false
 exclude-labels=duplicate,question,invalid,wontfix,hide
 add-sections={"tests":{"prefix":"**Tests & CI:**","labels":["tests"]}, "documentation":{"prefix":"**Documentation:**", "labels":["documentation"]}}
-exclude-tags-regex=.*rc
+exclude-tags-regex=.*rc

.pre-commit-config.yaml

@@ -4,26 +4,36 @@ ci:
   autoupdate_commit_msg: "ci(pre-commit.ci): autoupdate"
 
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: ".*\\.md"
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: ["--unsafe"]
+      - id: check-added-large-files
+
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.24
+    rev: v0.24.1
     hooks:
       - id: validate-pyproject
 
-  - repo: https://github.com/crate-ci/typos
-    rev: v1.30.1
+  - repo: https://github.com/adhtruong/mirrors-typos
+    rev: v1.35.5
     hooks:
       - id: typos
         args: [--force-exclude] # omitting --write-changes
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.0
+    rev: v0.12.10
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --unsafe-fixes]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.17.1
     hooks:
       - id: mypy
         files: "^src/"
@@ -32,3 +42,17 @@ repos:
           - pydantic
           - psygnal
           - IPython
+          - types-wxpython
+          - qtpy
+          - git+https://github.com/tlambert03/[email protected]
+
+  - repo: local
+    hooks:
+      - id: pyright
+        stages: [manual]
+        exclude: "^docs/"
+        name: pyright
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+        entry: uv run pyright

CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [v0.4.0](https://github.com/pyapp-kit/ndv/tree/v0.4.0) (2025-05-21)
+
+[Full Changelog](https://github.com/pyapp-kit/ndv/compare/v0.3.1...v0.4.0)
+
+**Implemented enhancements:**
+
+- feat: Purge ArrayDataDisplayModel from ArrayViews [\#196](https://github.com/pyapp-kit/ndv/pull/196) ([gselzer](https://github.com/gselzer))
+- feat: Expose viewer model as `viewer_options` argument to imshow and ArrayViewer [\#194](https://github.com/pyapp-kit/ndv/pull/194) ([tlambert03](https://github.com/tlambert03))
+- feat: add circular/ring buffer and data wrapper, that can be used to facilitate a streaming viewer [\#186](https://github.com/pyapp-kit/ndv/pull/186) ([tlambert03](https://github.com/tlambert03))
+- feat: add signals to DataWrapper [\#182](https://github.com/pyapp-kit/ndv/pull/182) ([tlambert03](https://github.com/tlambert03))
+- feat: histogram highlights [\#181](https://github.com/pyapp-kit/ndv/pull/181) ([gselzer](https://github.com/gselzer))
+- feat: explicit backend setters [\#180](https://github.com/pyapp-kit/ndv/pull/180) ([gselzer](https://github.com/gselzer))
+- feat: Add autoscale tails to Jupyter [\#179](https://github.com/pyapp-kit/ndv/pull/179) ([gselzer](https://github.com/gselzer))
+- Histogram hscroll pan [\#176](https://github.com/pyapp-kit/ndv/pull/176) ([gselzer](https://github.com/gselzer))
+- feat: add show\_controls and show\_data\_info options to viewer model [\#175](https://github.com/pyapp-kit/ndv/pull/175) ([tlambert03](https://github.com/tlambert03))
+- feat: add back play button, as well as dimension size label [\#163](https://github.com/pyapp-kit/ndv/pull/163) ([tlambert03](https://github.com/tlambert03))
+- feat: pygfx gamma [\#158](https://github.com/pyapp-kit/ndv/pull/158) ([gselzer](https://github.com/gselzer))
+- feat: Add autoscale tail ignore via popup [\#147](https://github.com/pyapp-kit/ndv/pull/147) ([gselzer](https://github.com/gselzer))
+- feat: Better histogram control \(plus pygfx histogram overhaul\) [\#146](https://github.com/pyapp-kit/ndv/pull/146) ([gselzer](https://github.com/gselzer))
+
+**Fixed bugs:**
+
+- fix: improve callable invocation and cleanup in MainThreadInvoker [\#183](https://github.com/pyapp-kit/ndv/pull/183) ([tlambert03](https://github.com/tlambert03))
+
+**Merged pull requests:**
+
+- ci\(pre-commit.ci\): autoupdate [\#188](https://github.com/pyapp-kit/ndv/pull/188) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+- ci\(dependabot\): bump astral-sh/setup-uv from 5 to 6 [\#187](https://github.com/pyapp-kit/ndv/pull/187) ([dependabot[bot]](https://github.com/apps/dependabot))
+- ci\(pre-commit.ci\): autoupdate [\#173](https://github.com/pyapp-kit/ndv/pull/173) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+
 ## [v0.3.1](https://github.com/pyapp-kit/ndv/tree/v0.3.1) (2025-03-26)
 
 [Full Changelog](https://github.com/pyapp-kit/ndv/compare/v0.3.0...v0.3.1)

Makefile

@@ -40,5 +40,5 @@ docs:
 docs-serve:
 	uv run --group docs mkdocs serve --no-strict
 
-lint: 
-	uv run pre-commit run --all-files
+lint:
+	uv run pre-commit run --all-files

docs/cookbook/streaming.md

@@ -0,0 +1,28 @@
+# Streaming updates
+
+`ndv` can be used to visualize data that is continuously updated, such as
+images from a camera or a live data stream. The following document shows some
+examples of such implementation.
+
+## Basic streaming, with no history
+
+To visualize a live data stream, simply create an `ndv.ArrayViewer` controller
+with an empty buffer matching your data shape.  Then, when new data is available,
+update the buffer in place with the new data. Calling `update()` on the
+[`ArrayDisplayModel.current_index`][ndv.models.ArrayDisplayModel]
+will force the display to fetch your new data:
+
+````python title="examples/streaming.py"
+--8<-- "examples/streaming.py"
+````
+
+## Streaming, remembering the last N frames
+
+To visualize a live data stream while keeping the last N frames in memory,
+you can use the [`ndv.models.RingBuffer`][] class.  It offers a convenient
+`append()` method to add new data, and takes care of updating the "apparent"
+shape of the data (as far as the viewer is concerned):
+
+````python title="examples/streaming_with_history.py"
+--8<-- "examples/streaming_with_history.py"
+````

docs/css/material.css

@@ -2,25 +2,25 @@
 .md-main__inner {
     margin-bottom: 1.5rem;
   }
-  
+
   /* Custom admonition: preview */
   :root {
     --md-admonition-icon--preview: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.5 12a3.5 3.5 0 1 1-7 0 3.5 3.5 0 0 1 7 0Z"/><path d="M12 3.5c3.432 0 6.124 1.534 8.054 3.241 1.926 1.703 3.132 3.61 3.616 4.46a1.6 1.6 0 0 1 0 1.598c-.484.85-1.69 2.757-3.616 4.461-1.929 1.706-4.622 3.24-8.054 3.24-3.432 0-6.124-1.534-8.054-3.24C2.02 15.558.814 13.65.33 12.8a1.6 1.6 0 0 1 0-1.598c.484-.85 1.69-2.757 3.616-4.462C5.875 5.034 8.568 3.5 12 3.5ZM1.633 11.945a.115.115 0 0 0-.017.055c.001.02.006.039.017.056.441.774 1.551 2.527 3.307 4.08C6.691 17.685 9.045 19 12 19c2.955 0 5.31-1.315 7.06-2.864 1.756-1.553 2.866-3.306 3.307-4.08a.111.111 0 0 0 .017-.056.111.111 0 0 0-.017-.056c-.441-.773-1.551-2.527-3.307-4.08C17.309 6.315 14.955 5 12 5 9.045 5 6.69 6.314 4.94 7.865c-1.756 1.552-2.866 3.306-3.307 4.08Z"/></svg>');
   }
-  
+
   .md-typeset .admonition.preview,
   .md-typeset details.preview {
     border-color: rgb(220, 139, 240);
   }
-  
+
   .md-typeset .preview>.admonition-title,
   .md-typeset .preview>summary {
     background-color: rgba(142, 43, 155, 0.1);
   }
-  
+
   .md-typeset .preview>.admonition-title::before,
   .md-typeset .preview>summary::before {
     background-color: rgb(220, 139, 240);
     -webkit-mask-image: var(--md-admonition-icon--preview);
     mask-image: var(--md-admonition-icon--preview);
-  }
+  }

docs/hooks.py

@@ -146,8 +146,8 @@ def generate_screenshots(script: Path) -> Iterable[tuple[bytes, Mode]]:
 
     def _start_app(*_: Any) -> QCoreApplication:
         if (app := QApplication.instance()) is None:
-            QApplication._APP = app = original_new(*_)  # type: ignore
-            QApplication.__init__(app, [])  # type: ignore
+            QApplication._APP = app = original_new(*_)  # type: ignore[attr-defined]
+            QApplication.__init__(app, [])  # type: ignore[arg-type]
         return app
 
     patch_app = patch.object(QApplication, "__new__", _start_app)

examples/cookbook/microscope_dashboard.py

@@ -14,6 +14,8 @@
 - move the stage in the x and y directions.
 """
 
+from __future__ import annotations
+
 from typing import Any, cast
 
 import astropy.units as u