Coverage for python/lsst/daf/butler/cli/cmd/commands.py : 87%

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 ..opt import dataset_type_option, directory_argument, repo_argument, run_option, transfer_option
25from ..utils import split_commas, cli_handle_exception, typeStrAcceptsMultiple
26from ...script import butlerImport, createRepo, configDump, configValidate
29# The conversion from the import command name to the butler_import function
30# name for subcommand lookup is implemented in the cli/butler.py, in
31# funcNameToCmdName and cmdNameToFuncName. If name changes are made here they
32# must be reflected in that location. If this becomes a common pattern a better
33# mechanism should be implemented.
34@click.command("import")
35@repo_argument(required=True, help=repo_argument.will_create_repo)
36@directory_argument(required=True)
37@transfer_option()
38@run_option(required=True)
39@click.option("--export-file",
40 help="Name for the file that contains database information associated with the exported "
41 "datasets. If this is not an absolute path, does not exist in the current working "
42 "directory, and --dir is provided, it is assumed to be in that directory. Defaults "
43 "to \"export.yaml\".",
44 type=click.File('r'))
45def butler_import(*args, **kwargs):
46 """Import data into a butler repository."""
47 cli_handle_exception(butlerImport, *args, **kwargs)
50@click.command()
51@repo_argument(help=repo_argument.will_create_repo)
52@click.option("--seed-config", help="Path to an existing YAML config file to apply (on top of defaults).")
53@click.option("--standalone", is_flag=True, help="Include all defaults in the config file in the repo, "
54 "insulating the repo from changes in package defaults.")
55@click.option("--override", is_flag=True, help="Allow values in the supplied config to override all "
56 "repo settings.")
57@click.option("--outfile", "-f", default=None, type=str, help="Name of output file to receive repository "
58 "configuration. Default is to write butler.yaml into the specified repo.")
59def create(*args, **kwargs):
60 """Create an empty Gen3 Butler repository."""
61 cli_handle_exception(createRepo, *args, **kwargs)
64@click.command()
65@repo_argument(required=True)
66@click.option("--subset", "-s", type=str,
67 help="Subset of a configuration to report. This can be any key in the hierarchy such as "
68 "'.datastore.root' where the leading '.' specified the delimiter for the hierarchy.")
69@click.option("--searchpath", "-p", type=str, multiple=True, callback=split_commas,
70 metavar=typeStrAcceptsMultiple,
71 help="Additional search paths to use for configuration overrides")
72@click.option("--file", "outfile", type=click.File("w"), default="-",
73 help="Print the (possibly-expanded) configuration for a repository to a file, or to stdout "
74 "by default.")
75def config_dump(*args, **kwargs):
76 """Dump either a subset or full Butler configuration to standard output."""
77 cli_handle_exception(configDump, *args, **kwargs)
80@click.command()
81@repo_argument(required=True)
82@click.option("--quiet", "-q", is_flag=True, help="Do not report individual failures.")
83@dataset_type_option(help="Specific DatasetType(s) to validate.")
84@click.option("--ignore", "-i", type=str, multiple=True, callback=split_commas,
85 metavar=typeStrAcceptsMultiple,
86 help="DatasetType(s) to ignore for validation.")
87def config_validate(*args, **kwargs):
88 """Validate the configuration files for a Gen3 Butler repository."""
89 cli_handle_exception(configValidate, *args, **kwargs)