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

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

 

""" 

Configuration classes specific to the Butler 

""" 

 

__all__ = ("ButlerConfig",) 

 

import os.path 

import posixpath 

 

from .core import ( 

ButlerURI, 

CompositesConfig, 

Config, 

DatastoreConfig, 

DimensionConfig, 

RepoTransferFormatConfig, 

StorageClassConfig, 

) 

from .registry import RegistryConfig 

 

CONFIG_COMPONENT_CLASSES = (RegistryConfig, StorageClassConfig, 

DatastoreConfig, CompositesConfig, DimensionConfig, 

RepoTransferFormatConfig) 

 

 

class ButlerConfig(Config): 

"""Contains the configuration for a `Butler` 

 

The configuration is read and merged with default configurations for 

the particular classes. The defaults are read according to the rules 

outlined in `ConfigSubset`. Each component of the configuration associated 

with a configuration class reads its own defaults. 

 

Parameters 

---------- 

other : `str`, `Config`, optional 

Path to butler configuration YAML file or a directory containing a 

"butler.yaml" file. If `None` the butler will 

be configured based entirely on defaults read from the environment 

or from ``searchPaths``. 

No defaults will be read if a `ButlerConfig` is supplied directly. 

searchPaths : `list` or `tuple`, optional 

Explicit additional paths to search for defaults. They should 

be supplied in priority order. These paths have higher priority 

than those read from the environment in 

`ConfigSubset.defaultSearchPaths()`. They are only read if ``other`` 

refers to a configuration file or directory. 

""" 

 

def __init__(self, other=None, searchPaths=None): 

 

self.configDir = None 

 

# If this is already a ButlerConfig we assume that defaults 

# have already been loaded. 

if other is not None and isinstance(other, ButlerConfig): 

super().__init__(other) 

# Ensure that the configuration directory propagates 

self.configDir = other.configDir 

return 

 

if isinstance(other, str): 

uri = ButlerURI(other) 

if uri.scheme == "file" or not uri.scheme: 

if os.path.isdir(uri.ospath): 

other = os.path.join(uri.ospath, "butler.yaml") 

elif uri.scheme == "s3": 

head, filename = posixpath.split(uri.path) 

if "." not in filename: 

uri.updateFile("butler.yaml") 

other = uri.geturl() 

else: 

raise ValueError(f"Unrecognized URI scheme: {uri.scheme}") 

 

# Create an empty config for us to populate 

super().__init__() 

 

# Read the supplied config so that we can work out which other 

# defaults to use. 

butlerConfig = Config(other) 

 

configFile = butlerConfig.configFile 

if configFile is not None: 

self.configDir = os.path.dirname(os.path.abspath(configFile)) 

 

# A Butler config contains defaults defined by each of the component 

# configuration classes. We ask each of them to apply defaults to 

# the values we have been supplied by the user. 

for configClass in CONFIG_COMPONENT_CLASSES: 

# Only send the parent config if the child 

# config component is present (otherwise it assumes that the 

# keys from other components are part of the child) 

localOverrides = None 

if configClass.component in butlerConfig: 

localOverrides = butlerConfig 

config = configClass(localOverrides, searchPaths=searchPaths) 

# Re-attach it using the global namespace 

self.update({configClass.component: config}) 

# Remove the key from the butlerConfig since we have already 

# merged that information. 

if configClass.component in butlerConfig: 

del butlerConfig[configClass.component] 

 

# Now that we have all the defaults we can merge the externally 

# provided config into the defaults. 

# Not needed if there is never information in a butler config file 

# not present in component configurations 

self.update(butlerConfig)