geotiff: forward missing_sources from open_geotiff to read_vrt (#1810)

[brendancol]

Summary

• Adds missing_sources to open_geotiff and forwards it to read_vrt for .vrt sources
• Rejects missing_sources on non-VRT sources with a clear ValueError, matching the existing on_gpu_failure rejection pattern
• Closes geotiff: open_geotiff silently drops missing_sources when routing to read_vrt #1810

Background

read_vrt gained missing_sources='warn'|'raise' in #1806, but the dispatcher open_geotiff did not expose it. Callers wanting strict failure on broken VRT sources had to call read_vrt directly. Same class of bug as #1561 / #1605 / #1685 / #1795.

Repro (pre-fix)

from xrspatial.geotiff import open_geotiff
open_geotiff("mosaic.vrt", missing_sources="raise")
# TypeError: open_geotiff() got an unexpected keyword argument 'missing_sources'

Test plan

• New regression suite test_open_geotiff_missing_sources_1810.py exercises signature, warn/raise/invalid policies through the dispatcher, non-VRT rejection, and the no-kwarg backward-compat path (6 tests pass)
• Existing parity suites still pass: test_open_geotiff_vrt_kwarg_drop_1685.py, test_vrt_missing_sources_policy_1799.py, test_backend_kwarg_parity_1561.py, test_signature_annotations_1654.py, test_signature_parity_1631.py (48 tests pass)
• Broader smoke: 253 tests pass for open_geotiff or read_vrt or write_vrt or signature or kwarg or missing_sources or namespace
• No source signature is renamed; default 'warn' preserves the existing behaviour for callers that never set the kwarg

[Copilot]

Pull request overview

This PR improves GeoTIFF/VRT API consistency by exposing missing_sources on the public open_geotiff dispatcher and forwarding it to read_vrt when opening .vrt sources. It also adjusts the internal per-tile dimension safety checks so that a caller’s max_pixels (used as an output/window budget) no longer rejects normal source tile sizes during VRT assembly.

Changes:

• Add missing_sources to open_geotiff, forward it to read_vrt for .vrt sources, and reject it for non-VRT sources with a clear ValueError.
• Update _reader.py per-tile dimension sanity checks to use MAX_PIXELS_DEFAULT rather than the caller’s max_pixels.
• Add regression tests for both the open_geotiff(missing_sources=...) dispatcher behavior and the VRT per-tile safety-check behavior.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
xrspatial/geotiff/__init__.py	Adds missing_sources to open_geotiff, validates/rejects on non-VRT, and forwards to read_vrt.
xrspatial/geotiff/_reader.py	Changes per-tile dimension checks to use MAX_PIXELS_DEFAULT instead of caller-provided max_pixels.
xrspatial/geotiff/tests/test_open_geotiff_missing_sources_1810.py	New regression tests ensuring the dispatcher exposes/forwards/validates missing_sources.
xrspatial/geotiff/tests/test_vrt_source_tile_check_1823.py	New regression tests covering the per-tile check behavior vs caller max_pixels.
.claude/sweep-api-consistency-state.csv	Updates sweep state metadata for the API consistency sweep.

Comments suppressed due to low confidence (1)

xrspatial/geotiff/_reader.py:2031

• Same issue as the local tile path: using MAX_PIXELS_DEFAULT unconditionally for the per-tile dimension check prevents callers from increasing max_pixels to handle very-large-tile COGs. Consider basing this check on max(max_pixels, MAX_PIXELS_DEFAULT) (or a dedicated per-tile override) so the check ignores small output budgets but still supports explicit opt-in for big tiles.

    # ``max_pixels`` -- intended as an output-window budget -- does not
    # reject normal 256x256 tiles. See #1823.
    if window is None:
        _check_dimensions(width, height, samples, max_pixels)
    _check_dimensions(tw, th, samples, MAX_PIXELS_DEFAULT)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.