Coverage for python/lsst/daf/butler/_file_dataset.py: 47%
26 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__ = ["FileDataset"]
32from dataclasses import dataclass
33from typing import Any
35from lsst.resources import ResourcePath, ResourcePathExpression
37from ._dataset_ref import DatasetRef
38from ._formatter import FormatterParameter
41@dataclass
42class FileDataset:
43 """A struct that represents a dataset exported to a file.
45 Parameters
46 ----------
47 path : `lsst.resources.ResourcePath` or `str`
48 Path to the dataset (`lsst.resources.ResourcePath` or `str`).
50 If the dataset was exported with ``transfer=None`` (i.e. in-place),
51 this is relative to the datastore root (only datastores that have a
52 well-defined root in the local filesystem can be expected to support
53 in-place exports). Otherwise this is relative to the directory passed
54 to `Datastore.export`.
55 refs : `list` [ `DatasetRef` ]
56 Registry information about the dataset.
57 formatter : `Formatter` or `str` or `None`, optional
58 A `Formatter` class or fully-qualified name.
59 """
61 __slots__ = ("refs", "path", "formatter")
63 refs: list[DatasetRef]
64 path: str | ResourcePath
65 formatter: FormatterParameter | None
67 def __init__(
68 self,
69 path: ResourcePathExpression,
70 refs: DatasetRef | list[DatasetRef],
71 *,
72 formatter: FormatterParameter | None = None,
73 ):
74 # Do not want to store all possible options supported by ResourcePath
75 # so force a conversion for the non-str parameters.
76 self.path = path if isinstance(path, str) else ResourcePath(path, forceAbsolute=False)
77 if isinstance(refs, DatasetRef):
78 refs = [refs]
79 runs = {ref.run for ref in refs}
80 if len(runs) != 1:
81 raise ValueError(f"Supplied refs must all share the same run. Got: {runs}")
82 self.refs = refs
83 self.formatter = formatter
85 def __lt__(self, other: Any) -> bool:
86 # Sort on path alone
87 if not isinstance(other, type(self)):
88 return NotImplemented
89 return str(self.path) < str(other.path)