Coverage for python/lsst/daf/butler/script/butlerImport.py: 45%
9 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-15 02:03 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-15 02:03 -0700
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 software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
27from __future__ import annotations
29from collections.abc import Iterable
30from typing import TextIO
32from .._butler import Butler
35def butlerImport(
36 repo: str,
37 directory: str | None,
38 export_file: str | TextIO | None,
39 transfer: str | None,
40 skip_dimensions: Iterable[str] | None,
41) -> None:
42 """Import data into a butler repository.
44 Parameters
45 ----------
46 repo : `str`
47 URI to the location of the repo or URI to a config file describing the
48 repo and its location.
49 directory : `str`, or None
50 Directory containing dataset files. If `None`, all file paths must be
51 absolute.
52 export_file : `TextIO`, or None
53 Name for the file that contains database information associated with
54 the exported datasets. If this is not an absolute path, does not exist
55 in the current working directory, and `directory` is not `None`, it is
56 assumed to be in `directory`. Defaults to "export.{format}".
57 transfer : `str`, or None
58 The external data transfer type.
59 skip_dimensions : `list`, or `None`
60 Dimensions that should be skipped.
61 """
62 butler = Butler.from_config(repo, writeable=True)
64 if skip_dimensions is not None:
65 skip_dimensions = set(skip_dimensions)
67 butler.import_(
68 directory=directory,
69 filename=export_file,
70 transfer=transfer,
71 format="yaml",
72 skip_dimensions=skip_dimensions,
73 )