|
def | __init__ (self, PathElementParser parser, bool isForFiles, Optional[str] message) |
|
bool | isForFiles (self) |
|
def | handle (self, str path, dict nextDataId2, Mapping[DatasetType, List[FileDataset]] datasets, *Log log, Callable[[DataCoordinate], bool] predicate) |
|
def | __str__ (self) |
|
bool | __call__ (self, str path, str name, Mapping[DatasetType, List[FileDataset]] datasets, *Log log, Callable[[DataCoordinate], bool] predicate) |
|
int | rank (self) |
|
Optional[DataCoordinate] | translate (self, dict dataId2, *bool partial=False, Log log) |
|
def | __lt__ (self, PathElementHandler other) |
|
A `ParsedPathElementHandler` that does nothing with an entry other
optionally logging a warning message.
A `SkipHandler` is used for Gen2 datasets that we can recognize but do not
want to (or cannot) extract Gen3 datasets from, or other files/directories
that alway appears at a fixed level in the diectory tree.
Parameters
----------
parser : `PathElementParser`
An object that matches the path element this handler is responsible for
and extracts a (partial) Gen2 data ID from it.
isForFiles : `bool`
Whether this handler should be applied to files (`True`) or
directories (`False`).
message : `str`, optional
A message to log at warning level when this handler matches a path
entry. If `None`, matched entrie will be silently skipped.
Definition at line 161 of file handlers.py.
bool lsst.obs.base.gen2to3.repoWalker.handlers.ParsedPathElementHandler.__call__ |
( |
|
self, |
|
|
str |
path, |
|
|
str |
name, |
|
|
Mapping[DatasetType, List[FileDataset]] |
datasets, |
|
|
*Log |
log, |
|
|
Callable[[DataCoordinate], bool] |
predicate |
|
) |
| |
|
inherited |
Apply the handler to a file path.
Parameters
----------
path : `str`
Full path of the file or directory.
name : `str`
Local name of the file or directory within its parent directory.
datasets : `dict` [`DatasetType`, `list` [`FileDataset`] ]
Dictionary that found datasets should be added to.
log : `Log`, optional
Log to use to report warnings and debug information.
predicate : `~collections.abc.Callable`
A callable taking a single `DataCoordinate` argument and returning
`bool`, indicating whether that (Gen3) data ID represents one
that should be included in the scan.'
Returns
-------
matched : `bool`
`True` if this handler was a match for the given path and no other
handlers need to be tried on it, `False` otherwise.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.
Definition at line 119 of file handlers.py.
def lsst.obs.base.gen2to3.repoWalker.handlers.SkipHandler.handle |
( |
|
self, |
|
|
str |
path, |
|
|
dict |
nextDataId2, |
|
|
Mapping[DatasetType, List[FileDataset]] |
datasets, |
|
|
*Log |
log, |
|
|
Callable[[DataCoordinate], bool] |
predicate |
|
) |
| |
Customization hook for ``__call__``.
Subclasses must override this method, while external callers (i.e.
`DirectoryScanner` should instead invoke `__call__`.
Parameters
----------
path : `str`
Full path of the file or directory.
nextDataId2 : `dict`
Gen2 data ID (usually partial) extracted from the path so far.
datasets : `dict` [`DatasetType`, `list` [`FileDataset`] ]
Dictionary that found datasets should be added to.
log : `Log`, optional
Log to use to report warnings and debug information.
predicate : `~collections.abc.Callable`
A callable taking a single `DataCoordinate` argument and returning
`bool`, indicating whether that (Gen3) data ID represents one
that should be included in the scan.
formatterMap : `dict`, optional
Map dataset type to specialist formatter.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.handlers.ParsedPathElementHandler.
Definition at line 192 of file handlers.py.
Optional[DataCoordinate] lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.translate |
( |
|
self, |
|
|
dict |
dataId2, |
|
|
*bool |
partial = False , |
|
|
Log |
log |
|
) |
| |
|
inherited |