lsst.obs.base  19.0.0-62-g3425666
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput:
lsst.obs.base.gen2to3.repoWalker.builders.BuilderInput lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode

Public Member Functions

def __init__ (self, *str datasetTypeName, str template, Dict[str, type] keys, StorageClass storageClass, DimensionUniverse universe, FormatterParameter formatter, TranslatorFactory translatorFactory, Optional[PathElementHandler] targetHandler=None, **Any kwargs)
 
PathElementHandler build (self, PathElementParser parser, Dict[str, type] allKeys, Dict[str, type] cumulativeKeys, *Optional[re.Pattern] fileIgnoreRegEx, Optional[re.Pattern] dirIgnoreRegEx)
 
Tuple[BuilderNode, List[str], bool] prune (self)
 

Public Attributes

 datasetType
 
 template
 
 keys
 
 elements
 

Detailed Description

An input to a `RepoWalker` that matches files that correspond to
datasets that we want to extract.

BuilderTargetInputs can never be pruned, and always build
`TargetFileHandler` instances.

Parameters
----------
datasetTypeName : `str`
    Name of the dataset type.
template : `str`
    Full Gen2 filename template.
keys : `dict` [`str`, `type`]
    Dictionary that maps Gen2 data ID key to the type of its value.
storageClass : `StorageClass`
    `StorageClass` for the Gen3 dataset type.
universe : `DimensionUniverse`
    All candidate dimensions for the Gen3 dataset type.
formatter : `lsst.daf.butler.Formatter` or `str`, optional
    A Gen 3 formatter class or fully-qualified name.
translatorFactory : `TranslatorFactory`
    Object that can be used to construct data ID translators.
targetHandler : `PathElementHandler`, optional
    Override target handler for this dataset type.
kwargs:
    Additional keyword arguments are passed to `Translator.makeMatching`,
    in along with ``datasetTypeName`` and ``keys``.

Definition at line 176 of file builders.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput.__init__ (   self,
*str  datasetTypeName,
str  template,
Dict[str, type]  keys,
StorageClass  storageClass,
DimensionUniverse  universe,
FormatterParameter  formatter,
TranslatorFactory  translatorFactory,
Optional[PathElementHandler]   targetHandler = None,
**Any  kwargs 
)

Definition at line 205 of file builders.py.

Member Function Documentation

◆ build()

PathElementHandler lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput.build (   self,
PathElementParser  parser,
Dict[str, type]  allKeys,
Dict[str, type]  cumulativeKeys,
*Optional[re.Pattern]  fileIgnoreRegEx,
Optional[re.Pattern]   dirIgnoreRegEx 
)
Transform this node in the build tree into a corresponding
`PathElementHandler`, recursing to any children.

Must be called after `prune`.

Parameters
----------
parser : `PathElementParser`
    An object that matches the path element the new handler is
    responsible for and extracts a (partial) Gen2 data ID from it.
allKeys : `dict` [`str`, `type`]
    A mapping from Gen2 data ID key to the type of its value.  Will
    contain all keys that may be extracted by the given parser, and
    possibly others.
cumulativeKeys : `dict` [`str`, `type`], optional
    A dictionary containing key strings and types for Gen2 data ID keys
    that have been extracted from previous path elements for this
    template, including those extracted by ``parser``.

Returns
-------
handler : `PathElementHandler`
    A new handler object.

Reimplemented from lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.

Definition at line 220 of file builders.py.

◆ prune()

Tuple[BuilderNode, List[str], bool] lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput.prune (   self)
Attempt to prune this node and its children from the tree.

Returns
-------
replacement : `BuilderNode`
    The result of recursively pruning child nodes; often just ``self``.
messages : `list` [`str`]
    Warning messages that should be logged by a parent node when a
    matching path element is encountered, if this node is pruned.
prune : `bool`
    If `True`, this node may be pruned from the tree (but will not
    necessarily be - it may correspond to a path element that should
    be skipped with siblings that should not be).

Reimplemented from lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.

Definition at line 227 of file builders.py.

Member Data Documentation

◆ datasetType

lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput.datasetType

Definition at line 210 of file builders.py.

◆ elements

lsst.obs.base.gen2to3.repoWalker.builders.BuilderInput.elements
inherited

Definition at line 120 of file builders.py.

◆ keys

lsst.obs.base.gen2to3.repoWalker.builders.BuilderInput.keys
inherited

Definition at line 119 of file builders.py.

◆ template

lsst.obs.base.gen2to3.repoWalker.builders.BuilderInput.template
inherited

Definition at line 118 of file builders.py.


The documentation for this class was generated from the following file: