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

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

# 

# LSST Data Management System 

# 

# This product includes software developed by the 

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

# 

# See COPYRIGHT file at the top of the source tree. 

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <https://www.lsstcorp.org/LegalNotices/>. 

# 

from __future__ import print_function, division 

 

__all__ = ['BlobSet'] 

 

from .blob import Blob 

from .jsonmixin import JsonSerializationMixin 

 

 

class BlobSet(JsonSerializationMixin): 

"""A collection of `~lsst.verify.Blob`\ s. 

 

Parameters 

---------- 

blobs : `list` of `lsst.verify.Blob`\ s 

Blobs to include in the set. 

""" 

 

def __init__(self, blobs=None): 

# internal dict of Blobs 

self._items = {} 

# internal mapping of blob names to identifiers 

self._name_map = {} 

 

if blobs is not None: 

for blob in blobs: 

self.insert(blob) 

 

@classmethod 

def deserialize(cls, blobs=None): 

"""Create a BlobSet from a parsed JSON dataset. 

 

Parameters 

---------- 

blobs : `list`, optional 

A list of blob JSON serializations. 

 

Returns 

------- 

instance : `BlobSet` 

A `BlobSet` instance. 

""" 

instance = cls() 

65 ↛ 66line 65 didn't jump to line 66, because the condition on line 65 was never true if blobs is None: 

blobs = [] 

for blob_doc in blobs: 

blob = Blob.deserialize(**blob_doc) 

instance.insert(blob) 

return instance 

 

def __getitem__(self, key): 

try: 

# key may be a blob's name, rather than identifier 

key = self._name_map[key] 

except KeyError: 

pass 

 

return self._items[key] 

 

def __setitem__(self, key, value): 

82 ↛ 83line 82 didn't jump to line 83, because the condition on line 82 was never true if not isinstance(value, Blob): 

message = ('Blob {0} is not a ' 

'lsst.verify.Blob-type') 

raise TypeError(message.format(value)) 

 

if key != value.identifier: 

message = ("Key {0} is inconsistent with the blob's " 

"identifier, {1}") 

raise KeyError(message.format(key, value.identifier)) 

 

self._items[key] = value 

self._name_map[value.name] = key 

 

def __len__(self): 

return len(self._items) 

 

def __contains__(self, key): 

try: 

# key may be a blob's name, rather than identifier 

key = self._name_map[key] 

except KeyError: 

pass 

 

return key in self._items 

 

def __delitem__(self, key): 

try: 

# key may be a blob's name, rather than identifier 

key = self._name_map[key] 

except KeyError: 

pass 

 

del self._items[key] 

 

def __iter__(self): 

for key in self._items: 

yield key 

 

def __eq__(self, other): 

return self._items == other._items 

 

def __ne__(self, other): 

return not self.__eq__(other) 

 

def __str__(self): 

count = len(self) 

if count == 0: 

count_str = 'empty' 

elif count == 1: 

count_str = '1 Blob' 

else: 

count_str = '{count:d} Blobs'.format(count=count) 

return '<BlobSet: {0}>'.format(count_str) 

 

def keys(self): 

"""Get a sequence of blob identifiers, which are keys to the BlobSet. 

 

Returns 

------- 

keys : sequence of `str` 

Sequence of `Blob.identifier`. 

""" 

return self._items.keys() 

 

def items(self): 

"""Iterate over (identifier, `Blob`) pairs in the set. 

 

Yields 

------ 

item : `tuple` 

Tuple containing: 

 

- `Blob.identifier` of the `Blob` (`str`) 

- `Blob` instance 

""" 

for item in self._items.items(): 

yield item 

 

def insert(self, blob): 

"""Insert a blob into the set. 

 

Parameters 

---------- 

blob : `Blob` 

`Blob` to insert into the set. It can be accessed by key from 

the BlobSet through its `Blob.identifier` string. 

""" 

self[blob.identifier] = blob 

 

@property 

def json(self): 

"""A `dict` that can be serialized as JSON.""" 

json_doc = JsonSerializationMixin._jsonify_list( 

[blob for identifier, blob in self.items()] 

) 

return json_doc