Coverage for python / lsst / daf / butler / datastore / _transfer.py: 100%

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 

30from collections.abc import Iterable 

31from typing import NamedTuple, Protocol, TypeAlias 

32 

33from lsst.resources import ResourcePath 

34 

35from .._dataset_ref import DatasetId, DatasetRef 

36from .stored_file_info import Location, StoredFileInfo 

37 

38__all__ = ("FileTransferMap", "FileTransferRecord", "FileTransferSource") 

39 

40 

41class FileTransferSource(Protocol): 

42 """Protocol for an object that can return information about files that need 

43 to be transferred to copy datasets from one Butler repository to another. 

44 """ 

45 

46 name: str 

47 """A human-readable, descriptive name for this file transfer source.""" 

48 

49 def get_file_info_for_transfer(self, dataset_ids: Iterable[DatasetId]) -> FileTransferMap: 

50 """Given a list of dataset IDs, return all file information associated 

51 with the datasets that can be determined without searching the 

52 filesystem. 

53 

54 Parameters 

55 ---------- 

56 dataset_ids : `~collections.abc.Iterable` [ `DatasetId` ] 

57 List of dataset IDs for which we will retrieve file information. 

58 

59 Returns 

60 ------- 

61 transfer_map : `FileTransferMap` 

62 Dictionary from `DatasetId` to a list of files found for that 

63 dataset. If information about any given dataset IDs could not 

64 be found, the missing IDs are omitted from the dictionary. 

65 """ 

66 

67 def locate_missing_files_for_transfer( 

68 self, refs: Iterable[DatasetRef], artifact_existence: dict[ResourcePath, bool] 

69 ) -> FileTransferMap: 

70 """Given a list of `DatasetRef`, search the filesystem to locate 

71 artifacts associated with the dataset. 

72 

73 Parameters 

74 ---------- 

75 refs : `~collections.abc.Iterable` of `DatasetRef` 

76 The datasets to be checked. 

77 artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`] 

78 Optional mapping of datastore artifact to existence. Updated by 

79 this method with details of all artifacts tested. 

80 

81 Returns 

82 ------- 

83 transfer_map : `FileTransferMap` 

84 Dictionary from `DatasetId` to a list of files found for that 

85 dataset. If information about any given dataset IDs could not 

86 be found, the missing IDs are omitted from the dictionary. 

87 """ 

88 

89 

90class FileTransferRecord(NamedTuple): 

91 """Information needed to transfer a file from one Butler repository to 

92 another. 

93 """ 

94 

95 location: Location 

96 file_info: StoredFileInfo 

97 

98 

99FileTransferMap: TypeAlias = dict[DatasetId, list[FileTransferRecord]] 

100"""A dictionary from `DatasetId` to a list of `FileTransferRecord`, containing 

101the datastore information about a set of files to be transferred. 

102"""