instrument.py

Go to the documentation of this file.

# This file is part of obs_base.
#
# Developed for the LSST Data Management System.
# This product includes software developed by the LSST Project
# (http://www.lsst.org).
# See the COPYRIGHT file at the top-level directory of this distribution
# for details of code ownership.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
import click
 
from lsst.daf.butler.cli.utils import addArgumentHelp, MWArgument, MWOption, ParameterType, split_commas
 
 
class instrument_parameter:  # noqa: N801
 
    defaultHelp = "The name or fully-qualified class name of an instrument."
    optionFlags = ("-i", "--instrument")
    optionKey = "instrument"
 
    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
 
    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)