lsst.pipe.base  13.0-12-gaf0c0ec+8
Public Member Functions | List of all members
lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner Class Reference

A TaskRunner for CmdLineTasks that require a 'butler' keyword argument to be passed to their constructor. More...

Inheritance diagram for lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner:
lsst.pipe.base.cmdLineTask.TaskRunner

Public Member Functions

def makeTask (self, parsedCmd=None, args=None)
 A variant of the base version that passes a butler argument to the task's constructor. More...
 
- Public Member Functions inherited from lsst.pipe.base.cmdLineTask.TaskRunner
def __init__ (self, TaskClass, parsedCmd, doReturnResults=False)
 Construct a TaskRunner. More...
 
def prepareForMultiProcessing (self)
 
def run (self, parsedCmd)
 Run the task on all targets. More...
 
def makeTask (self, parsedCmd=None, args=None)
 Create a Task instance. More...
 
def precall (self, parsedCmd)
 
def __call__ (self, args)
 Run the Task on a single target. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.pipe.base.cmdLineTask.TaskRunner
def getTargetList (parsedCmd, kwargs)
 Return a list of (dataRef, kwargs) for TaskRunner. More...
 
- Public Attributes inherited from lsst.pipe.base.cmdLineTask.TaskRunner
 TaskClass
 
 doReturnResults
 
 config
 
 log
 
 doRaise
 
 clobberConfig
 
 doBackup
 
 numProcesses
 
 timeout
 
- Static Public Attributes inherited from lsst.pipe.base.cmdLineTask.TaskRunner
int TIMEOUT = 3600*24*30
 

Detailed Description

A TaskRunner for CmdLineTasks that require a 'butler' keyword argument to be passed to their constructor.

Definition at line 415 of file cmdLineTask.py.

Member Function Documentation

◆ makeTask()

def lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner.makeTask (   self,
  parsedCmd = None,
  args = None 
)

A variant of the base version that passes a butler argument to the task's constructor.

Parameters
[in]parsedCmdparsed command-line options, as returned by the argument parser; if specified then args is ignored
[in]argsother arguments; if parsedCmd is None then this must be specified
Exceptions
RuntimeErrorif parsedCmd and args are both None

Definition at line 420 of file cmdLineTask.py.


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