Coverage for python/lsst/daf/butler/cli/opt/options.py : 63%

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 functools import partial
26from ..utils import MWOptionDecorator, split_commas, split_kv, unwrap, yaml_presets
27from lsst.daf.butler.registry import CollectionType
30class CollectionTypeCallback:
32 collectionTypes = CollectionType.__members__.keys()
34 @staticmethod
35 def makeCollectionTypes(context, param, value):
36 if not value:
37 # Click seems to demand that the default be an empty tuple, rather
38 # than a sentinal like None. The behavior that we want is that
39 # not passing this option at all passes all collection types, while
40 # passing it uses only the passed collection types. That works
41 # fine for now, since there's no command-line option to subtract
42 # collection types, and hence the only way to get an empty tuple
43 # is as the default.
44 return tuple(CollectionType.all())
45 result = []
46 for item in split_commas(context, param, value):
47 item = item.upper()
48 try:
49 result.append(CollectionType.__members__[item])
50 except KeyError:
51 raise KeyError(f"{item} is not a valid CollectionType.") from None
52 return tuple(result)
55collection_type_option = MWOptionDecorator("--collection-type",
56 callback=CollectionTypeCallback.makeCollectionTypes,
57 multiple=True,
58 help="If provided, only list collections of this type.",
59 type=click.Choice(CollectionTypeCallback.collectionTypes,
60 case_sensitive=False))
63collections_option = MWOptionDecorator("--collections",
64 help=unwrap("""One or more expressions that fully or partially identify
65 the collections to search for datasets. If not provided all
66 datasets are returned."""),
67 multiple=True,
68 callback=split_commas)
71components_option = MWOptionDecorator("--components/--no-components",
72 default=None,
73 help=unwrap("""For --components, apply all expression patterns to
74 component dataset type names as well. For --no-components,
75 never apply patterns to components. Default (where neither
76 is specified) is to apply patterns to components only if
77 their parent datasets were not matched by the expression.
78 Fully-specified component datasets (`str` or `DatasetType`
79 instances) are always included."""))
82config_option = MWOptionDecorator("-c", "--config",
83 callback=split_kv,
84 help="Config override, as a key-value pair.",
85 metavar="TEXT=TEXT",
86 multiple=True)
89config_file_option = MWOptionDecorator("-C", "--config-file",
90 help=unwrap("""Path to a pex config override to be included after the
91 Instrument config overrides are applied."""))
94dataset_type_option = MWOptionDecorator("-d", "--dataset-type",
95 callback=split_commas,
96 help="Specific DatasetType(s) to validate.",
97 multiple=True)
100datasets_option = MWOptionDecorator("--datasets")
103logLevelChoices = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
104log_level_option = MWOptionDecorator("--log-level",
105 callback=partial(split_kv,
106 choice=click.Choice(logLevelChoices,
107 case_sensitive=False),
108 normalize=True,
109 unseparated_okay=True,
110 add_to_default=True),
111 help="The logging level. "
112 f"Supported levels are [{'|'.join(logLevelChoices)}]",
113 is_eager=True,
114 metavar="LEVEL|COMPONENT=LEVEL",
115 multiple=True)
118long_log_option = MWOptionDecorator("--long-log",
119 help="Make log messages appear in long format.",
120 is_flag=True)
123options_file_option = MWOptionDecorator("--options-file", "-@",
124 expose_value=False, # This option should not be forwarded
125 help=unwrap("""URI to YAML file containing overrides
126 of command line options. The YAML should be organized
127 as a hierarchy with subcommand names at the top
128 level options for that subcommand below."""),
129 callback=yaml_presets)
132processes_option = MWOptionDecorator("-j", "--processes",
133 default=1,
134 help="Number of processes to use.",
135 type=click.IntRange(min=1))
138regex_option = MWOptionDecorator("--regex")
141run_option = MWOptionDecorator("--output-run",
142 help="The name of the run datasets should be output to.")
145transfer_option = MWOptionDecorator("-t", "--transfer",
146 default="auto", # set to `None` if using `required=True`
147 help="The external data transfer mode.",
148 type=click.Choice(["auto", "link", "symlink", "hardlink", "copy", "move",
149 "relsymlink", "direct"],
150 case_sensitive=False))
153verbose_option = MWOptionDecorator("-v", "--verbose",
154 help="Increase verbosity.",
155 is_flag=True)
158where_option = MWOptionDecorator("--where",
159 help="A string expression similar to a SQL WHERE clause.")