Coverage for python/lsst/daf/butler/core/datasets/association.py: 77%

18 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-07-21 09:55 +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 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/>. 

21 

22from __future__ import annotations 

23 

24from dataclasses import dataclass 

25from typing import Any 

26 

27from ..timespan import Timespan 

28from .ref import DatasetRef 

29 

30 

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

32class DatasetAssociation: 

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

34 

35 One dataset is associated with one collection, possibly including 

36 a timespan. 

37 """ 

38 

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

40 

41 ref: DatasetRef 

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

43 """ 

44 

45 collection: str 

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

47 """ 

48 

49 timespan: Timespan | None 

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

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

52 """ 

53 

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

55 # Allow sorting of associations 

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

57 return NotImplemented 

58 

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