Coverage for python/lsst/daf/butler/_dataset_association.py: 65%

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/>. 

27 

28from __future__ import annotations 

29 

30__all__ = ("DatasetAssociation",) 

31 

32from collections.abc import Iterator 

33from dataclasses import dataclass 

34from typing import TYPE_CHECKING, Any 

35 

36from ._dataset_ref import DatasetRef 

37from ._dataset_type import DatasetType 

38from ._timespan import Timespan 

39 

40if TYPE_CHECKING: 

41 from .queries._general_query_results import GeneralQueryResults 

42 

43 

44@dataclass(frozen=True, eq=True) 

45class DatasetAssociation: 

46 """Class representing the membership of a dataset in a single collection. 

47 

48 One dataset is associated with one collection, possibly including 

49 a timespan. 

50 """ 

51 

52 __slots__ = ("ref", "collection", "timespan") 

53 

54 ref: DatasetRef 

55 """Resolved reference to a dataset (`DatasetRef`). 

56 """ 

57 

58 collection: str 

59 """Name of a collection (`str`). 

60 """ 

61 

62 timespan: Timespan | None 

63 """Validity range of the dataset if this is a `~CollectionType.CALIBRATION` 

64 collection (`Timespan` or `None`). 

65 """ 

66 

67 @classmethod 

68 def from_query_result( 

69 cls, result: GeneralQueryResults, dataset_type: DatasetType 

70 ) -> Iterator[DatasetAssociation]: 

71 """Construct dataset associations from the result of general query. 

72 

73 Parameters 

74 ---------- 

75 result : `~lsst.daf.butler.queries.GeneralQueryResults` 

76 General query result returned by 

77 `Query.general <lsst.daf.butler.queries.Query.general>` method. The 

78 result has to include "dataset_id", "run", "collection", and 

79 "timespan" dataset fields for ``dataset_type``. 

80 dataset_type : `DatasetType` 

81 Dataset type, query has to include this dataset type. 

82 """ 

83 timespan_key = f"{dataset_type.name}.timespan" 

84 collection_key = f"{dataset_type.name}.collection" 

85 for _, refs, row_dict in result.iter_tuples(dataset_type): 

86 yield DatasetAssociation(refs[0], row_dict[collection_key], row_dict[timespan_key]) 

87 

88 def __lt__(self, other: Any) -> bool: 

89 # Allow sorting of associations 

90 if not isinstance(other, type(self)): 

91 return NotImplemented 

92 

93 return (self.ref, self.collection, self.timespan) < (other.ref, other.collection, other.timespan)