Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

from .formatter import Formatter 

from .utils import slotValuesAreEqual 

from .storageClass import StorageClass 

 

__all__ = ("StoredFileInfo", ) 

 

 

class StoredFileInfo: 

"""Information associated with a stored file in a Datastore. 

 

Parameters 

---------- 

formatter : `str` or `Formatter` 

Full name of formatter to use to read this Dataset or a `Formatter` 

instance. 

path : `str` 

Path to Dataset, relative to `Datastore` root. 

storageClass : `StorageClass` 

`StorageClass` used when writing the file. This can differ from that 

used to read the file if a component is being requested from 

a concrete composite. 

 

See Also 

-------- 

StorageInfo 

""" 

 

__eq__ = slotValuesAreEqual 

__slots__ = ("_formatter", "_path", "_storageClass", "_checksum", "_size") 

 

def __init__(self, formatter, path, storageClass, checksum=None, size=None): 

assert isinstance(formatter, str) or isinstance(formatter, Formatter) 

if isinstance(formatter, Formatter): 

formatter = formatter.name() 

self._formatter = formatter 

assert isinstance(path, str) 

self._path = path 

assert isinstance(storageClass, StorageClass) 

self._storageClass = storageClass 

assert checksum is None or isinstance(checksum, str) 

self._checksum = checksum 

assert size is None or isinstance(size, int) 

self._size = size 

 

@property 

def formatter(self): 

"""Full name of formatter (`str`). 

""" 

return self._formatter 

 

@property 

def path(self): 

"""Path to Dataset (`str`). 

""" 

return self._path 

 

@property 

def storageClass(self): 

"""StorageClass used (`StorageClass`). 

""" 

return self._storageClass 

 

@property 

def checksum(self): 

"""Checksum (`str`). 

""" 

return self._checksum 

 

@property 

def size(self): 

"""Size of stored object in bytes (`int`). 

""" 

return self._size 

 

def __repr__(self): 

return f'{type(self).__qualname__}(path="{self.path}", formatter="{self.formatter}"' \ 

f' size={self.size}, checksum="{self.checksum}", storageClass="{self.storageClass.name}")'