raster.rasterio_open()

Open a rasterio dataset from a local path or an S3-backed UPath.

Usage

Source

raster.rasterio_open(path: AnyPath, mode: Literal['r'] = ..., kwargs={}) -> AbstractContextManager[DatasetReader]
 
raster.rasterio_open(path: AnyPath, mode: Literal['r+', 'w', 'w+'], kwargs={}) -> AbstractContextManager[DatasetWriter]

A drop-in replacement for rasterio.open that automatically injects GDAL environment variables derived from a UPath’s fsspec storage options, enabling reads and writes against S3-compatible object stores without manually managing credentials.

Parameters

path: str | Path | UPath

Path to the raster file. A UPath with protocol s3 triggers credential extraction from its underlying fsspec filesystem. A plain Path or str is treated as a local file.

mode: ("r", "r+", "w", "w+") = "r"

File mode passed directly to rasterio.open. Defaults to "r".

**kwargs: Any

Additional keyword arguments forwarded to rasterio.open, such as driver, width, height, count, dtype, or crs.

Returns

AbstractContextManager[rasterio.DatasetReader]

When mode="r".

AbstractContextManager[rasterio.DatasetWriter]

When mode is "r+", "w", or "w+".

Raises

ValueError

If path uses a protocol other than local ("") or "s3".