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

Public Member Functions

def __init__
 
def build
 
def prune (self)
 

Public Attributes

 template
 
 keys
 
 elements
 

Detailed Description

An input to a `RepoWalker` that indicates that matched files should be
skipped, possibly with a warning message.

BuilderSkipInputs can be pruned.  When they are not pruned, they build
`SkipHandler` instances.

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.
message : `str`, optional
    If not `None`, a warning message that should be printed either when a
    matching file is enountered or a directory that may contain such files
    is skipped.
isForFiles : `bool`, optional
    If `True` (default), this handler should be run on files.  Otherwise it
    should be run on directories.

Definition at line 136 of file builders.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 158 of file builders.py.

Member Function Documentation

◆ build()

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

Definition at line 164 of file builders.py.

◆ prune()

def lsst.obs.base.gen2to3.repoWalker.builders.BuilderSkipInput.prune (   self,
  Tuple,
  BuilderNode,
  List,
  str,
  bool 
)

Definition at line 170 of file builders.py.

Member Data Documentation

◆ elements

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

Definition at line 119 of file builders.py.

◆ keys

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

Definition at line 118 of file builders.py.

◆ template

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

Definition at line 117 of file builders.py.


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