opt.instrument.instrument_parameter Class Reference

Public Member Functions
def	__init__ (self, help=defaultHelp, metavar=None, multiple=False, parameterType=ParameterType.OPTION, required=False)
def	__call__ (self, f)

Public Attributes
	callback
	help
	metavar
	multiple
	parameterType
	required

Static Public Attributes
string	defaultHelp = "The name or fully-qualified class name of an instrument."
tuple	optionFlags = ("-i", "--instrument")
string	optionKey = "instrument"

Detailed Description

Definition at line 28 of file instrument.py.

Constructor & Destructor Documentation

__init__()

def opt.instrument.instrument_parameter.__init__	(		self,
			help = defaultHelp,
			metavar = None,
			multiple = False,
			parameterType = ParameterType.OPTION,
			required = False
	)

Definition at line 34 of file instrument.py.

    def __init__(self, help=defaultHelp, metavar=None, multiple=False, parameterType=ParameterType.OPTION,
                 required=False):
        self.callback = split_commas if multiple else None
        self.help = help
        self.metavar = metavar
        self.multiple = multiple
        self.parameterType = parameterType
        self.required = required
 

Member Function Documentation

__call__()

def opt.instrument.instrument_parameter.__call__	(		self,
			f
	)

Definition at line 43 of file instrument.py.

    def __call__(self, f):
        if self.parameterType == ParameterType.OPTION:
            return click.option(*self.optionFlags, cls=MWOption,
                                callback=self.callback,
                                help=self.help,
                                metavar=self.metavar,
                                multiple=self.multiple,
                                required=self.required)(f)
        if self.parameterType == ParameterType.ARGUMENT:
            f.__doc__ = addArgumentHelp(f.__doc__, self.help)
            return click.argument("instrument", cls=MWArgument,
                                  callback=self.callback,
                                  nargs=-1 if self.multiple else 1,
                                  required=self.required)(f)

Member Data Documentation

callback

opt.instrument.instrument_parameter.callback

Definition at line 35 of file instrument.py.

defaultHelp

string opt.instrument.instrument_parameter.defaultHelp = "The name or fully-qualified class name of an instrument."

static

Definition at line 30 of file instrument.py.

help

opt.instrument.instrument_parameter.help

Definition at line 36 of file instrument.py.

metavar

opt.instrument.instrument_parameter.metavar

Definition at line 37 of file instrument.py.

multiple

opt.instrument.instrument_parameter.multiple

Definition at line 38 of file instrument.py.

optionFlags

tuple opt.instrument.instrument_parameter.optionFlags = ("-i", "--instrument")

static

Definition at line 31 of file instrument.py.

optionKey

string opt.instrument.instrument_parameter.optionKey = "instrument"

static

Definition at line 32 of file instrument.py.

parameterType

opt.instrument.instrument_parameter.parameterType

Definition at line 39 of file instrument.py.

required

opt.instrument.instrument_parameter.required

Definition at line 40 of file instrument.py.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/obs_base/20.0.0-28-gb33ccd1+1ae6d82017/python/lsst/obs/base/cli/opt/instrument.py