Coverage for python/lsst/daf/butler/cli/opt/glob.py : 86%

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/>.
22import click
24from ..utils import addArgumentHelp, MWOption, split_commas, ParameterType, textTypeStr
27class glob_parameter: # noqa: N801
28 """Decorator to add an glob option or argument to a click command.
30 Parameters
31 ----------
32 help : `str`, optional
33 The help text to use for the option.
34 multiple : `bool`, optional
35 If True, multiple instances of the option may be passed in on the
36 command line, by default False.
37 parameterType : `ParameterType`, optional
38 Indicates if the decorator should add a `click.Argument` or a
39 `click.Option`, by default ParameterType.OPTION
40 required : bool, optional
41 If True, the option is required to be passed in on the command line, by
42 default False.
43 """
45 defaultHelp = "GLOB is a string to apply to the search."
46 defaultHelpMultiple = "GLOB is one or more strings to apply to the search."
48 def __init__(self, help=defaultHelp, multiple=False, parameterType=ParameterType.OPTION, required=False):
49 self.help = help
50 self.callback = split_commas if multiple else None
51 self.multiple = multiple
52 self.parameterType = parameterType
53 self.required = required
55 if self.help == self.defaultHelp and self.multiple: 55 ↛ exitline 55 didn't return from function '__init__', because the condition on line 55 was never false
56 self.help = self.defaultHelpMultiple
58 def __call__(self, f):
59 if self.parameterType == ParameterType.OPTION: 59 ↛ 60line 59 didn't jump to line 60, because the condition on line 59 was never true
60 return click.option("--glob", cls=MWOption,
61 callback=self.callback,
62 help=self.help,
63 metavar=textTypeStr(self.multiple),
64 multiple=self.multiple,
65 required=self.required)(f)
66 else:
67 f.__doc__ = addArgumentHelp(f.__doc__, self.help)
68 return click.argument("glob",
69 callback=self.callback,
70 metavar="GLOB ..." if self.multiple else "GLOB",
71 nargs=-1 if self.multiple else 1,
72 required=self.required)(f)