Coverage for python/lsst/daf/butler/cli/opt/config_file.py : 53%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of daf_butler.
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/>.
23import click
25from ..utils import MWOption, split_commas
28class config_file_option: # noqa: N801
29 """A decorator that adds a config-file option to a click command.
31 Parameters
32 ----------
33 help : `str`, optional
34 The help text to use for the option.
35 metavar : `str`, optional
36 How the type is represented in the help page.
37 multiple : `bool`, optional
38 If true, multiple instances of the option may be passed in on the
39 command line, by default False.
40 required : bool, optional
41 If True, the option is required to be passed in on the command line, by
42 default False.
43 type : a python type or a `click.ParamType`, optional
44 The type that should be used for the value. Python types will be
45 converted into a `click.ParamType` automatically if supported.
46 """
48 defaultHelp = "Path to a pex config override to be included after the Instrument config overrides are " \
49 "applied."
50 optionFlags = ("-C", "--config-file")
51 optionKey = "config_file"
53 def __init__(self, help=defaultHelp, metavar=None, multiple=False, required=False, type=None):
54 self.callback = split_commas if multiple else None
55 self.help = help
56 self.metavar = metavar
57 self.multiple = multiple
58 self.required = required
59 self.type = type
61 def __call__(self, f):
62 return click.option(*self.optionFlags, cls=MWOption,
63 callback=self.callback,
64 help=self.help,
65 metavar=self.metavar,
66 multiple=self.multiple,
67 required=self.required,
68 type=self.type)(f)