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# 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 program is free software: you can redistribute it and/or modify 

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

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

12# (at your option) any later version. 

13# 

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

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

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

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

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

21 

22""" 

23Configuration classes specific to the Butler 

24""" 

25 

26__all__ = ("ButlerConfig",) 

27 

28import os.path 

29 

30from .core import ( 

31 ButlerURI, 

32 Config, 

33 DatastoreConfig, 

34 DimensionConfig, 

35 RepoTransferFormatConfig, 

36 StorageClassConfig, 

37) 

38from .registry import RegistryConfig 

39 

40CONFIG_COMPONENT_CLASSES = (RegistryConfig, StorageClassConfig, 

41 DatastoreConfig, DimensionConfig, 

42 RepoTransferFormatConfig) 

43 

44 

45class ButlerConfig(Config): 

46 """Contains the configuration for a `Butler` 

47 

48 The configuration is read and merged with default configurations for 

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

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

51 with a configuration class reads its own defaults. 

52 

53 Parameters 

54 ---------- 

55 other : `str`, `Config`, optional 

56 Path to butler configuration YAML file or a directory containing a 

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

58 be configured based entirely on defaults read from the environment 

59 or from ``searchPaths``. 

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

61 searchPaths : `list` or `tuple`, optional 

62 Explicit additional paths to search for defaults. They should 

63 be supplied in priority order. These paths have higher priority 

64 than those read from the environment in 

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

66 refers to a configuration file or directory. 

67 """ 

68 

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

70 

71 self.configDir = None 

72 

73 # If this is already a ButlerConfig we assume that defaults 

74 # have already been loaded. 

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

76 super().__init__(other) 

77 # Ensure that the configuration directory propagates 

78 self.configDir = other.configDir 

79 return 

80 

81 if isinstance(other, str): 

82 uri = ButlerURI(other) 

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

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

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

86 elif uri.scheme == "s3": 

87 if not uri.dirLike and "." not in uri.basename(): 

88 uri = ButlerURI(other, forceDirectory=True) 

89 uri.updateFile("butler.yaml") 

90 other = uri.geturl() 

91 else: 

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

93 

94 # Create an empty config for us to populate 

95 super().__init__() 

96 

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

98 # defaults to use. 

99 butlerConfig = Config(other) 

100 

101 configFile = butlerConfig.configFile 

102 if configFile is not None: 

103 uri = ButlerURI(configFile) 

104 if uri.scheme == "s3": 

105 uri.updateFile("") 

106 self.configDir = uri.geturl() 

107 else: 

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

109 

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

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

112 # the values we have been supplied by the user. 

113 for configClass in CONFIG_COMPONENT_CLASSES: 

114 # Only send the parent config if the child 

115 # config component is present (otherwise it assumes that the 

116 # keys from other components are part of the child) 

117 localOverrides = None 

118 if configClass.component in butlerConfig: 

119 localOverrides = butlerConfig 

120 config = configClass(localOverrides, searchPaths=searchPaths) 

121 # Re-attach it using the global namespace 

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

123 # Remove the key from the butlerConfig since we have already 

124 # merged that information. 

125 if configClass.component in butlerConfig: 

126 del butlerConfig[configClass.component] 

127 

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

129 # provided config into the defaults. 

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

131 # not present in component configurations 

132 self.update(butlerConfig)