Coverage for python/lsst/daf/butler/cli/opt/verbose.py : 100%

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
23from ..utils import MWOption
26class verbose_option: # noqa: N801
27 """Decorator to add a verbose option to a click command.
29 Parameters
30 ----------
31 help : `str`, optional
32 The help text to use for the option.
33 required : bool, optional
34 If True, the option is required to be passed in on the command line, by
35 default False.
36 """
38 defaultHelp = "Increase verbosity."
40 def __init__(self, help=defaultHelp, required=False):
41 self.help = help
42 self.required = required
44 def __call__(self, f):
45 return click.option("-v", "--verbose", cls=MWOption,
46 required=self.required,
47 is_flag=True,
48 help=self.help)(f)