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

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, MWPath, split_commas, split_kv, unwrap, yaml_presets
27from lsst.daf.butler.registry import CollectionType
30class CollectionTypeCallback:
32 collectionTypes = tuple(collectionType.name for collectionType in CollectionType.all())
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())
46 return tuple(CollectionType.from_name(item) for item in split_commas(context, param, value))
49collection_type_option = MWOptionDecorator("--collection-type",
50 callback=CollectionTypeCallback.makeCollectionTypes,
51 multiple=True,
52 help="If provided, only list collections of this type.",
53 type=click.Choice(CollectionTypeCallback.collectionTypes,
54 case_sensitive=False))
57collections_option = MWOptionDecorator("--collections",
58 help=unwrap("""One or more expressions that fully or partially identify
59 the collections to search for datasets. If not provided all
60 datasets are returned."""),
61 multiple=True,
62 callback=split_commas)
65components_option = MWOptionDecorator("--components/--no-components",
66 default=None,
67 help=unwrap("""For --components, apply all expression patterns to
68 component dataset type names as well. For --no-components,
69 never apply patterns to components. Default (where neither
70 is specified) is to apply patterns to components only if
71 their parent datasets were not matched by the expression.
72 Fully-specified component datasets (`str` or `DatasetType`
73 instances) are always included."""))
76config_option = MWOptionDecorator("-c", "--config",
77 callback=split_kv,
78 help="Config override, as a key-value pair.",
79 metavar="TEXT=TEXT",
80 multiple=True)
83config_file_option = MWOptionDecorator("-C", "--config-file",
84 help=unwrap("""Path to a pex config override to be included after the
85 Instrument config overrides are applied."""))
88dataset_type_option = MWOptionDecorator("-d", "--dataset-type",
89 callback=split_commas,
90 help="Specific DatasetType(s) to validate.",
91 multiple=True)
94datasets_option = MWOptionDecorator("--datasets")
97logLevelChoices = ["CRITICAL", "ERROR", "WARNING", "INFO", "VERBOSE", "DEBUG"]
98log_level_option = MWOptionDecorator("--log-level",
99 callback=partial(split_kv,
100 choice=click.Choice(logLevelChoices,
101 case_sensitive=False),
102 normalize=True,
103 unseparated_okay=True,
104 add_to_default=True),
105 help="The logging level. "
106 f"Supported levels are [{'|'.join(logLevelChoices)}]",
107 is_eager=True,
108 metavar="LEVEL|COMPONENT=LEVEL",
109 multiple=True)
112long_log_option = MWOptionDecorator("--long-log",
113 help="Make log messages appear in long format.",
114 is_flag=True)
116log_file_option = MWOptionDecorator("--log-file",
117 default=None,
118 multiple=True,
119 callback=split_commas,
120 type=MWPath(file_okay=True, dir_okay=False, writable=True),
121 help="File(s) to write log messages. If the path ends with '.json' then"
122 " JSON log records will be written, else formatted text log records"
123 " will be written. This file can exist and records will be appended.")
125log_tty_option = MWOptionDecorator("--log-tty/--no-log-tty",
126 default=True,
127 help="Log to terminal (default). If false logging to terminal is"
128 " disabled.")
130options_file_option = MWOptionDecorator("--options-file", "-@",
131 expose_value=False, # This option should not be forwarded
132 help=unwrap("""URI to YAML file containing overrides
133 of command line options. The YAML should be organized
134 as a hierarchy with subcommand names at the top
135 level options for that subcommand below."""),
136 callback=yaml_presets)
139processes_option = MWOptionDecorator("-j", "--processes",
140 default=1,
141 help="Number of processes to use.",
142 type=click.IntRange(min=1))
145regex_option = MWOptionDecorator("--regex")
148run_option = MWOptionDecorator("--output-run",
149 help="The name of the run datasets should be output to.")
152transfer_option = MWOptionDecorator("-t", "--transfer",
153 default="auto", # set to `None` if using `required=True`
154 help="The external data transfer mode.",
155 type=click.Choice(["auto", "link", "symlink", "hardlink", "copy", "move",
156 "relsymlink", "direct"],
157 case_sensitive=False))
160verbose_option = MWOptionDecorator("-v", "--verbose",
161 help="Increase verbosity.",
162 is_flag=True)
165where_option = MWOptionDecorator("--where",
166 help="A string expression similar to a SQL WHERE clause.")