Coverage for python/lsst/daf/butler/script/_associate.py: 60%
10 statements
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-16 10:43 +0000
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-16 10:43 +0000
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
31from .._butler import Butler
32from ..registry import CollectionType
33from .queryDatasets import QueryDatasets
36def associate(
37 repo: str,
38 collection: str,
39 dataset_type: Iterable[str],
40 collections: Iterable[str],
41 where: str,
42 find_first: bool,
43) -> None:
44 """Add existing datasets to a CHAINED collection.
46 Parameters
47 ----------
48 repo : `str`
49 The Butler repository location.
50 collection : `str`
51 Name of the tagged collection to place datasets.
52 dataset_type : `~collections.abc.Iterable` of `str`
53 Names of dataset types.
54 collections : `~collections.abc.Iterable`
55 Collections to use in the query.
56 where : `str`
57 Query string.
58 find_first : `bool`
59 Whether to find the first match or not.
60 """
61 butler = Butler.from_config(repo, writeable=True)
63 butler.registry.registerCollection(collection, CollectionType.TAGGED)
65 results = QueryDatasets(
66 butler=butler,
67 glob=dataset_type,
68 collections=collections,
69 where=where,
70 find_first=find_first,
71 show_uri=False,
72 repo=None,
73 )
75 butler.registry.associate(collection, results.getDatasets())