Coverage for python/lsst/daf/butler/cli/opt/transfer.py : 88%

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
24from ..utils import MWOption
27class transfer_option: # noqa: N801
28 """A decorator to add a transfer option to a click.Command.
30 Parameters
31 ----------
32 help : `str`, optional
33 The help text to use for the option.
34 required : bool, optional
35 If True, the option is required to be passed in on the command line, by
36 default False.
37 """
39 choices = ["auto", "link", "symlink", "hardlink", "copy", "move", "relsymlink"]
40 defaultHelp = "The external data transfer mode."
42 def __init__(self, help=defaultHelp, required=False):
43 self.help = help
44 self.required = required
46 def __call__(self, f):
47 kwargs = dict(help=self.help,
48 type=click.Choice(self.choices, case_sensitive=False))
49 # If the option is required, do not provide a default value (it
50 # prevents the CLI execution from failing if the option is not
51 # provided).
52 if self.required: 52 ↛ 53line 52 didn't jump to line 53, because the condition on line 52 was never true
53 kwargs["required"] = True
54 else:
55 kwargs["default"] = "auto"
56 return click.option("-t", "--transfer", cls=MWOption, **kwargs)(f)