Coverage for python / lsst / daf / butler / script / _associate.py: 64%

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 

28 

29import itertools 

30from collections.abc import Iterable 

31 

32from .._butler import Butler 

33from .._collection_type import CollectionType 

34from .queryDatasets import QueryDatasets 

35 

36 

37def associate( 

38 repo: str, 

39 collection: str, 

40 dataset_type: Iterable[str], 

41 collections: Iterable[str], 

42 where: str, 

43 find_first: bool, 

44 limit: int, 

45) -> None: 

46 """Add existing datasets to a CHAINED collection. 

47 

48 Parameters 

49 ---------- 

50 repo : `str` 

51 The Butler repository location. 

52 collection : `str` 

53 Name of the tagged collection to place datasets. 

54 dataset_type : `~collections.abc.Iterable` of `str` 

55 Names of dataset types. 

56 collections : `~collections.abc.Iterable` 

57 Collections to use in the query. 

58 where : `str` 

59 Query string. 

60 find_first : `bool` 

61 Whether to find the first match or not. 

62 limit : `int` 

63 Limit the number of results to be returned. A value of 0 means 

64 unlimited. A negative value is used to specify a cap where a warning 

65 is issued if that cap is hit. 

66 """ 

67 with Butler.from_config(repo, writeable=True, without_datastore=True) as butler: 

68 butler.collections.register(collection, CollectionType.TAGGED) 

69 

70 results = QueryDatasets( 

71 butler=butler, 

72 glob=dataset_type, 

73 collections=collections, 

74 where=where, 

75 find_first=find_first, 

76 limit=limit, 

77 order_by=(), 

78 show_uri=False, 

79 ) 

80 

81 butler.registry.associate(collection, itertools.chain(*results.getDatasets()))