|
lsst.obs.base
20.0.0-69-g8f355a9+701c885a11
|
Public Member Functions | |
| def | __init__ (self, re.Pattern pattern, bool isForFiles) |
| def | __str__ (self) |
| bool | isForFiles (self) |
| int | rank (self) |
| bool | __call__ (self, str path, str name, Mapping[DatasetType, Mapping[Optional[str], List[FileDataset]]] datasets, *Callable[[DataCoordinate], bool] predicate) |
| Tuple[Optional[DataCoordinate], Optional[str]] | translate (self, dict dataId2, *bool partial=False) |
| def | __lt__ (self, PathElementHandler other) |
Public Attributes | |
| lastDataId2 | |
A `PathElementHandler` that matches via a regular expression, and does
nothing.
An `IgnoreHandler` is used to ignore file or directory patterns that can
occur at any level in the directory tree, and have no relation to any
Gen2 filename template.
Parameters
----------
pattern : `re.Pattern`
A regular expression pattern.
isForFiles : `bool`
Whether this handler should be applied to files (`True`) or
directories (`False`).
Definition at line 56 of file handlers.py.
| def lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler.__init__ | ( | self, | |
| re.Pattern | pattern, | ||
| bool | isForFiles | ||
| ) |
Definition at line 72 of file handlers.py.
| bool lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler.__call__ | ( | self, | |
| str | path, | ||
| str | name, | ||
| Mapping[DatasetType, Mapping[Optional[str], List[FileDataset]]] | datasets, | ||
| *Callable[[DataCoordinate], bool] | predicate | ||
| ) |
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`, `dict` ]
Dictionary that found datasets should be added to. Nested dicts
are keyed by either `None` (for most datasets) or a `str`
"CALIBDATE" for calibration datasets.
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 91 of file handlers.py.
|
inherited |
Handlers are sorted by rank to reduce the possibility that more flexible handlers will have a chance to match something they shouldn't.
Definition at line 140 of file scanner.py.
| def lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler.__str__ | ( | self | ) |
Definition at line 79 of file handlers.py.
| bool lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler.isForFiles | ( | self | ) |
Report what kind of path element this object handlers. Returns ------- Return `True` if this handler is for file entries, or `False` if it is for directories.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.
Definition at line 82 of file handlers.py.
| int lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler.rank | ( | self | ) |
Return a rough indication of how flexible this handler is in terms of the path element names it can match. Handlers that match a constant path element should always return zero.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.
Definition at line 87 of file handlers.py.
|
inherited |
Translate the given data ID from Gen2 to Gen3.
The default implementation returns `None`. Subclasses that are able
to translate data IDs should override this method.
Parameters
----------
dataId2 : `dict`
Gen2 data ID.
partial : `bool`, optional
If `True` (`False` is default) this is a partial data ID for some
dataset, and missing keys are expected.
Returns
-------
dataId3 : `lsst.daf.butler.DataCoordinate` or `None`
A Gen3 data ID, or `None` if this handler cannot translate data
IDs.
calibDate : `str` or `None`
A Gen2 calibration "CALIBDATE" value, or `None` if there was no
such value in the template.
Reimplemented in lsst.obs.base.gen2to3.repoWalker.handlers.MultiExtensionFileHandler, lsst.obs.base.gen2to3.repoWalker.handlers.TargetFileHandler, and lsst.obs.base.gen2to3.repoWalker.handlers.SubdirectoryHandler.
Definition at line 114 of file scanner.py.
|
inherited |
Definition at line 60 of file scanner.py.
1.8.18