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

# 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/>. 

 

"""Support for reading and writing composite objects.""" 

 

__all__ = ("CompositesConfig", "CompositesMap") 

 

import logging 

 

from .config import ConfigSubset 

from .datasets import DatasetType 

from .storageClass import StorageClass 

 

log = logging.getLogger(__name__) 

 

 

class CompositesConfig(ConfigSubset): 

component = "composites" 

requiredKeys = ("default", "storageClasses") 

defaultConfigFile = "composites.yaml" 

 

def validate(self): 

"""Validate entries have the correct type.""" 

super().validate() 

for n in ("storageClasses", "datasetTypes"): 

for k in self[n]: 

key = f"{n}.{k}" 

if not isinstance(self[key], bool): 

raise ValueError(f"CompositesConfig: Key {key} is not a Boolean") 

 

 

class CompositesMap: 

"""Determine whether a specific datasetType or StorageClass should be 

disassembled. 

 

Parameters 

---------- 

config : `str`, `ButlerConfig`, or `CompositesConfig` 

Configuration to control composites disassembly. 

""" 

 

def __init__(self, config): 

61 ↛ 63line 61 didn't jump to line 63, because the condition on line 61 was never false if not isinstance(config, type(self)): 

config = CompositesConfig(config) 

assert isinstance(config, CompositesConfig) 

self.config = config 

 

def doDisassembly(self, entity): 

"""Given some choices, indicate whether the entity should be 

disassembled. 

 

Parameters 

---------- 

entity : `StorageClass` or `DatasetType` 

Thing to test against the configuration. The ``name`` property 

is used to determine a match. A `DatasetType` will first check 

its name, before checking its `StorageClass`. If there are no 

matches the default will be returned. If the associated 

`StorageClass` is not a composite, will always return `False`. 

 

Returns 

------- 

disassemble : `bool` 

Returns `True` if disassembly should occur; `False` otherwise. 

""" 

components = None 

datasetTypeName = None 

storageClassName = None 

if isinstance(entity, DatasetType): 

datasetTypeName = entity.name 

storageClassName = entity.storageClass.name 

components = entity.storageClass.components 

elif isinstance(entity, StorageClass): 

storageClassName = entity.name 

components = entity.components 

else: 

raise ValueError(f"Unexpected argument: {entity:!r}") 

 

# We know for a fact this is not a composite 

if not components: 

log.debug("%s will not be disassembled (not a composite)", entity) 

return False 

 

matchName = "{} (via default)".format(entity) 

disassemble = self.config["default"] 

 

if datasetTypeName is not None and datasetTypeName in self.config["datasetTypes"]: 

disassemble = self.config[f"datasetTypes.{datasetTypeName}"] 

matchName = datasetTypeName 

108 ↛ 112line 108 didn't jump to line 112, because the condition on line 108 was never false elif storageClassName is not None and storageClassName in self.config["storageClasses"]: 

disassemble = self.config[f"storageClasses.{storageClassName}"] 

matchName = storageClassName 

 

log.debug("%s will%s be disassembled", matchName, "" if disassemble else " not") 

return disassemble