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

Public Member Functions

def __init__
 
def prune (self)
 
def build
 

Public Attributes

 template
 
 keys
 
 elements
 

Detailed Description

An intermediate base for `BuilderNode` classes that are provided as
direct inputs to a `RepoWalker`, and generally correspond to exactly one
Gen2 dataset type.

Parameters
----------
template : `str`
    The complete Gen2 template to be matched (not just the template for
    one path element).
keys : `dict` [`str`, `type`]
    A mapping from Gen2 data ID key to the type of its value.

Definition at line 104 of file builders.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderInput.__init__ (   self,
  template 
)

Definition at line 117 of file builders.py.

Member Function Documentation

◆ build()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.build (   self,
  parser 
)
inherited

Definition at line 74 of file builders.py.

◆ prune()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderNode.prune (   self,
  Tuple,
  BuilderNode,
  List,
  str,
  bool 
)
inherited
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).

Definition at line 56 of file builders.py.

Member Data Documentation

◆ elements

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

Definition at line 120 of file builders.py.

◆ keys

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

Definition at line 119 of file builders.py.

◆ template

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

Definition at line 118 of file builders.py.


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