lsst.obs.base  19.0.0-21-gaaa92db
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler:
lsst.obs.base.gen2to3.repoWalker.handlers.IgnoreHandler lsst.obs.base.gen2to3.repoWalker.handlers.ParsedPathElementHandler lsst.obs.base.gen2to3.repoWalker.handlers.SkipHandler lsst.obs.base.gen2to3.repoWalker.handlers.SubdirectoryHandler lsst.obs.base.gen2to3.repoWalker.handlers.TargetFileHandler

Public Member Functions

def __init__ (self)
 
def isForFiles (self)
 
def __call__
 
def rank (self)
 
def translate
 
def __lt__
 

Public Attributes

 lastDataId2
 

Detailed Description

An interface for objects that handle a single path element (directory or
file) in a Gen2 data repository.

Handlers added to a `DirectoryScanner` instance, which then calls them
until one succeeds when it processes each element in a directoy.

Definition at line 51 of file scanner.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.__init__ (   self)

Definition at line 58 of file scanner.py.

Member Function Documentation

◆ __call__()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.__call__ (   self,
  path 
)

Definition at line 75 of file scanner.py.

◆ __lt__()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.__lt__ (   self,
  other 
)

Definition at line 136 of file scanner.py.

◆ isForFiles()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.isForFiles (   self,
  bool 
)
Report what kind of path element this object handlers.

Returns
-------
Return `True` if this handler is for file entries, or `False` if it
is for directories.

Definition at line 64 of file scanner.py.

◆ rank()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.rank (   self,
  int 
)
Return a rough indication of how flexible this handler is in terms
of the path element names it can match.

Handlers that match a constant path element should always return zero.

Definition at line 104 of file scanner.py.

◆ translate()

def lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.translate (   self,
  dataId2 
)

Definition at line 112 of file scanner.py.

Member Data Documentation

◆ lastDataId2

lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.lastDataId2

Definition at line 59 of file scanner.py.


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