lsst.obs.base  19.0.0-79-gada4096
instrument.py
Go to the documentation of this file.
1 # This file is part of obs_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 
22 
23 import click
24 
25 from lsst.daf.butler.cli.utils import addArgumentHelp, ParameterType
26 
27 
28 class instrument_parameter: # noqa: N801
29 
30  defaultHelp = "The name or fully-qualified class name of an instrument."
31 
32  def __init__(self, parameterType=ParameterType.OPTION, required=False, help=defaultHelp, multiple=False):
33  self.parameterType = parameterType
34  self.required = required
35  self.help = help
36  self.multiple = multiple
37 
38  def __call__(self, f):
39  if self.parameterType == ParameterType.OPTION:
40  return click.option("-i", "--instrument",
41  required=self.required,
42  help=self.help,
43  multiple=self.multiple)(f)
44  if self.parameterType == ParameterType.ARGUMENT:
45  f.__doc__ = addArgumentHelp(f.__doc__, self.help)
46  return click.argument("instrument",
47  required=self.required,
48  nargs=-1 if self.multiple else 1,
49  metavar="INSTRUMENT ..." if self.multiple else "INSTRUMENT")(f)
opt.instrument.instrument_parameter.help
help
Definition: instrument.py:35
opt.instrument.instrument_parameter.parameterType
parameterType
Definition: instrument.py:33
opt.instrument.instrument_parameter.__init__
def __init__(self, parameterType=ParameterType.OPTION, required=False, help=defaultHelp, multiple=False)
Definition: instrument.py:32
opt.instrument.instrument_parameter.__call__
def __call__(self, f)
Definition: instrument.py:38
opt.instrument.instrument_parameter.required
required
Definition: instrument.py:34
opt.instrument.instrument_parameter.multiple
multiple
Definition: instrument.py:36
opt.instrument.instrument_parameter
Definition: instrument.py:28