Inheritance diagram for lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs:

Public Member Functions
def	__init__ (self, BuilderInput old, BuilderInput new)

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)

Detailed Description

A `BuilderNode` that represents a collection of `BuilderInput` instances
that all have the same template.

Definition at line 270 of file builders.py.

Constructor & Destructor Documentation

◆ init()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs.__init__	(		self,
		BuilderInput	old,
		BuilderInput	new
	)

Definition at line 274 of file builders.py.

     def __init__(self, old: BuilderInput, new: BuilderInput):
         self._children = []
         if isinstance(old, BuilderDuplicateInputs):
             self._children.extend(old._children)
         else:
             self._children.append(old)
         self._children.append(new)
         self._messages = []  # populated in prune()
  

Member Function Documentation

◆ build()

PathElementHandler lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs.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 283 of file builders.py.

               ) -> PathElementHandler:
         # Docstring inherited from BuilderNode.
         message = "; ".join(self._messages) if self._messages else None
         return SkipHandler(parser=parser, isForFiles=False, message=message)
  

◆ prune()

Tuple[BuilderNode, List[str], bool] lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs.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 290 of file builders.py.

     def prune(self) -> Tuple[BuilderNode, List[str], bool]:
         # Docstring inherited from BuilderNode.
         unprunable = []
         newChildren = []
         for child in self._children:
             newChild, childMessages, toPruneChild = child.prune()
             if toPruneChild:
                 self._messages.extend(childMessages)
             else:
                 unprunable.append(newChild)
             newChildren.append(newChildren)
         self._children = newChildren
         if len(unprunable) == 0:
             # All children are just skips, so we can prune this node if we
             # remember their messages.
             return self, self._messages, True
         elif len(unprunable) == 1 and not self._messages:
             # Exactly one child is a target, and the others were ignored with
             # no warning messages.  Tell parent node to just use that child,
             # so if we see any matching files, we just assume they're for that
             # target.
             return unprunable[0], [], False
         else:
             # Multiple targets or skips with messages, which means we won't
             # know how to handle any matching files.  Replace any messages we
             # have with a single message that combines them all as well as
             # any target dataset types that they are ambiguous with.
             nested = [f"{c.datasetType.name} (target)" for c in unprunable]
             nested.extend(self._messages)
             self._messages = [f"ambiguous match: [{', '.join(nested)}]"]
             return self, self._messages, True
  
  

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

/j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/gen2to3/repoWalker/builders.py