Coverage for python/lsst/daf/butler/_dataset_association.py: 78%
19 statements
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-16 10:44 +0000
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-16 10:44 +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/>.
28from __future__ import annotations
30__all__ = ("DatasetAssociation",)
32from dataclasses import dataclass
33from typing import Any
35from ._dataset_ref import DatasetRef
36from ._timespan import Timespan
39@dataclass(frozen=True, eq=True)
40class DatasetAssociation:
41 """Class representing the membership of a dataset in a single collection.
43 One dataset is associated with one collection, possibly including
44 a timespan.
45 """
47 __slots__ = ("ref", "collection", "timespan")
49 ref: DatasetRef
50 """Resolved reference to a dataset (`DatasetRef`).
51 """
53 collection: str
54 """Name of a collection (`str`).
55 """
57 timespan: Timespan | None
58 """Validity range of the dataset if this is a `~CollectionType.CALIBRATION`
59 collection (`Timespan` or `None`).
60 """
62 def __lt__(self, other: Any) -> bool:
63 # Allow sorting of associations
64 if not isinstance(other, type(self)):
65 return NotImplemented
67 return (self.ref, self.collection, self.timespan) < (other.ref, other.collection, other.timespan)