scan

function of dascore.io.core

source

scan(
    path: str | pathlib._local.Path | upath.core.UPath | dascore.core.patch_meta.PatchMeta | dascore.core.spool.Spool | dascore.utils.io.IOResourceManager | collections.abc.Iterable[str, Path, UPath, PatchMeta, Spool, IOResourceManager, collections.abc.Iterable[str | pathlib._local.Path | upath.core.UPath | dascore.core.patch_meta.PatchMeta | dascore.utils.io.IOResourceManager[str, Path, UPath, PatchMeta, IOResourceManager]]] ,
    file_format: str | None[str, None] = None,
    file_version: str | None[str, None] = None,
    ext: str | None[str, None] = None,
    timestamp: float | None[float, None] = None,
    progress: Literal[‘standard’, ‘basic’, None, False] | Progress = standard,
    snap: bool | str | collections.abc.Collection[bool, str, collections.abc.Collection[str], None] = None,
)-> ‘list[PatchSummary]’

Scan a potential patch source and return its patch summaries.

Inaccessible files and subdirectories are skipped with a warning. An inaccessible root directory raises PermissionError. Legacy DASDAE pickled coordinates raise DASDAEUnpickleError unless allow_dasdae_format_unpickle=True is enabled for trusted files.

Parameters

Parameter	Description
path	A resource containing Fiber data.
file_format	File format. DASCore detects it when omitted. Only applies to path-like inputs.
file_version	File version. DASCore detects it when omitted. Only applies to path-like inputs.
ext	The extensions to map.
timestamp	Minimum modification time.
progress	Progress display. None disables it, "basic" suits low-latency operations, and a rich.progress.Progress subclass customizes it.
snap	The dimensions whose stored labels come back on a grid. None (the default) snaps the names the format’s reader defaults to, shown in its get_metadata signature; True every one-dimensional numeric or time-like dimension; False none, returning every coordinate exactly as stored; a name or tuple of names those dimensions, raising if a patch has no such dimension. Where a stored label sits more than dascore.config.max_shift steps off its grid, a reader keeps the labels as stored and warns, naming the file. See rule 3 of the coordinate guidelines.

Returns

A list of PatchSummary instances.

Examples

import dascore as dc

summary = dc.scan("examples://terra15_das_1_trimmed.hdf5")[0]

See Also

scan_payloads Return full coordinate managers instead of envelope summaries.