Coverage for python / lsst / pipe / base / quantum_graph / aggregator / _structs.py: 96%

1# This file is part of pipe_base. 

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__ = ("IngestRequest", "ScanReport") 

31 

32import dataclasses 

33import uuid 

34 

35from lsst.daf.butler import DatasetRef 

36from lsst.daf.butler.datastore.record_data import DatastoreRecordData 

37 

38from .._common import DatastoreName 

39from .._provenance import ProvenanceQuantumScanStatus 

40 

41 

42@dataclasses.dataclass 

43class ScanReport: 

44 """Minimal information needed about a completed scan by the supervisor.""" 

45 

46 quantum_id: uuid.UUID 

47 """Unique ID of the quantum.""" 

48 

49 status: ProvenanceQuantumScanStatus 

50 """Combined status of the scan and the execution of the quantum.""" 

51 

52 

53@dataclasses.dataclass 

54class IngestRequest: 

55 """A request to ingest datasets produced by a single quantum.""" 

56 

57 producer_id: uuid.UUID 

58 """ID of the quantum that produced these datasets.""" 

59 

60 refs: list[DatasetRef] 

61 """Registry information about the datasets.""" 

62 

63 records: dict[DatastoreName, DatastoreRecordData] 

64 """Datastore information about the datasets.""" 

65 

66 def __bool__(self) -> bool: 

67 return bool(self.refs or self.records)