lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode Class Reference

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

Public Member Functions
Tuple[BuilderNode, List[str], bool]	prune (self)
PathElementHandler	build (self, PathElementParser parser, Dict[str, type] allKeys, Dict[str, type] cumulativeKeys, *Optional[re.Pattern] fileIgnoreRegEx, Optional[re.Pattern] dirIgnoreRegEx)

Detailed Description

Abstract interface for nodes in the temporary tree that is used to
construct a `RepoWalker`.

Definition at line 50 of file builders.py.

Member Function Documentation

build()

PathElementHandler lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.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 in lsst.obs.base.gen2to3.repoWalker.builders.BuilderTree, lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs, lsst.obs.base.gen2to3.repoWalker.builders.BuilderPrunedTree, lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput, and lsst.obs.base.gen2to3.repoWalker.builders.BuilderSkipInput.

Definition at line 74 of file builders.py.

              ) -> PathElementHandler:
        """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.
        """
        raise NotImplementedError()
 
 

prune()

Tuple[BuilderNode, List[str], bool] lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.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 in lsst.obs.base.gen2to3.repoWalker.builders.BuilderTree, lsst.obs.base.gen2to3.repoWalker.builders.BuilderDuplicateInputs, lsst.obs.base.gen2to3.repoWalker.builders.BuilderPrunedTree, lsst.obs.base.gen2to3.repoWalker.builders.BuilderTargetInput, and lsst.obs.base.gen2to3.repoWalker.builders.BuilderSkipInput.

Definition at line 56 of file builders.py.

    def prune(self) -> Tuple[BuilderNode, List[str], bool]:
        """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).
        """
        raise NotImplementedError()
 

---

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