lsst.ctrl.pool  21.0.0-3-gf9d8b05+cb30300d2e
Public Member Functions | List of all members
lsst.ctrl.pool.parallel.BatchArgumentParser Class Reference
Inheritance diagram for lsst.ctrl.pool.parallel.BatchArgumentParser:

Public Member Functions

def __init__ (self, parent=None, *args, **kwargs)
 
def parse_args (self, config=None, args=None, namespace=None, **kwargs)
 
def makeBatch (self, args)
 
def format_help (self)
 
def format_usage (self)
 

Detailed Description

An argument parser to get relevant parameters for batch submission

We want to be able to display the help for a 'parent' ArgumentParser
along with the batch-specific options we introduce in this class, but
we don't want to swallow the parent (i.e., ArgumentParser(parents=[parent]))
because we want to save the list of arguments that this particular
BatchArgumentParser doesn't parse, so they can be passed on to a different
program (though we also want to parse them to check that they can be parsed).

Definition at line 298 of file parallel.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.ctrl.pool.parallel.BatchArgumentParser.__init__ (   self,
  parent = None,
args,
**  kwargs 
)

Definition at line 309 of file parallel.py.

Member Function Documentation

◆ format_help()

def lsst.ctrl.pool.parallel.BatchArgumentParser.format_help (   self)

Definition at line 378 of file parallel.py.

◆ format_usage()

def lsst.ctrl.pool.parallel.BatchArgumentParser.format_usage (   self)

Definition at line 399 of file parallel.py.

◆ makeBatch()

def lsst.ctrl.pool.parallel.BatchArgumentParser.makeBatch (   self,
  args 
)
Create a Batch object from the command-line arguments

Definition at line 353 of file parallel.py.

◆ parse_args()

def lsst.ctrl.pool.parallel.BatchArgumentParser.parse_args (   self,
  config = None,
  args = None,
  namespace = None,
**  kwargs 
)

Definition at line 340 of file parallel.py.


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