1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2011 The Chromium OS Authors.
6 import configparser as ConfigParser
14 from patman import gitutil
16 """Default settings per-project.
18 These are used by _ProjectConfigParser. Settings names should match
19 the "dest" of the option parser from patman.py.
24 "process_tags": "False",
25 "check_patch_use_tree": "True",
28 "process_tags": "False",
29 "add_signoff": "False",
30 "check_patch": "False",
35 class _ProjectConfigParser(ConfigParser.ConfigParser):
36 """ConfigParser that handles projects.
38 There are two main goals of this class:
39 - Load project-specific default settings.
40 - Merge general default settings/aliases with project-specific ones.
42 # Sample config used for tests below...
43 >>> from io import StringIO
44 >>> sample_config = '''
46 ... me: Peter P. <likesspiders@example.com>
47 ... enemies: Evil <evil@example.com>
50 ... enemies: Green G. <ugly@example.com>
53 ... enemies: Doc O. <pus@example.com>
59 # Check to make sure that bogus project gets general alias.
60 >>> config = _ProjectConfigParser("zzz")
61 >>> config.readfp(StringIO(sample_config))
62 >>> str(config.get("alias", "enemies"))
63 'Evil <evil@example.com>'
65 # Check to make sure that alias gets overridden by project.
66 >>> config = _ProjectConfigParser("sm")
67 >>> config.readfp(StringIO(sample_config))
68 >>> str(config.get("alias", "enemies"))
69 'Green G. <ugly@example.com>'
71 # Check to make sure that settings get merged with project.
72 >>> config = _ProjectConfigParser("linux")
73 >>> config.readfp(StringIO(sample_config))
74 >>> sorted((str(a), str(b)) for (a, b) in config.items("settings"))
75 [('am_hero', 'True'), ('check_patch_use_tree', 'True'), ('process_tags', 'False')]
77 # Check to make sure that settings works with unknown project.
78 >>> config = _ProjectConfigParser("unknown")
79 >>> config.readfp(StringIO(sample_config))
80 >>> sorted((str(a), str(b)) for (a, b) in config.items("settings"))
83 def __init__(self, project_name):
84 """Construct _ProjectConfigParser.
86 In addition to standard ConfigParser initialization, this also
87 loads project defaults.
90 project_name: The name of the project.
92 self._project_name = project_name
93 ConfigParser.ConfigParser.__init__(self)
95 # Update the project settings in the config based on
96 # the _default_settings global.
97 project_settings = "%s_settings" % project_name
98 if not self.has_section(project_settings):
99 self.add_section(project_settings)
100 project_defaults = _default_settings.get(project_name, {})
101 for setting_name, setting_value in project_defaults.items():
102 self.set(project_settings, setting_name, setting_value)
104 def get(self, section, option, *args, **kwargs):
105 """Extend ConfigParser to try project_section before section.
113 val = ConfigParser.ConfigParser.get(
114 self, "%s_%s" % (self._project_name, section), option,
117 except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
118 val = ConfigParser.ConfigParser.get(
119 self, section, option, *args, **kwargs
123 def items(self, section, *args, **kwargs):
124 """Extend ConfigParser to add project_section to section.
132 has_project_section = False
135 # Get items from the project section
137 project_items = ConfigParser.ConfigParser.items(
138 self, "%s_%s" % (self._project_name, section), *args, **kwargs
140 has_project_section = True
141 except ConfigParser.NoSectionError:
144 # Get top-level items
146 top_items = ConfigParser.ConfigParser.items(
147 self, section, *args, **kwargs
149 except ConfigParser.NoSectionError:
150 # If neither section exists raise the error on...
151 if not has_project_section:
154 item_dict = dict(top_items)
155 item_dict.update(project_items)
156 return {(item, val) for item, val in item_dict.items()}
159 def ReadGitAliases(fname):
160 """Read a git alias file. This is in the form used by git:
162 alias uboot u-boot@lists.denx.de
163 alias wd Wolfgang Denk <wd@denx.de>
166 fname: Filename to read
169 fd = open(fname, 'r', encoding='utf-8')
171 print("Warning: Cannot find alias file '%s'" % fname)
174 re_line = re.compile(r'alias\s+(\S+)\s+(.*)')
175 for line in fd.readlines():
177 if not line or line[0] == '#':
180 m = re_line.match(line)
182 print("Warning: Alias file line '%s' not understood" % line)
185 list = alias.get(m.group(1), [])
186 for item in m.group(2).split(','):
190 alias[m.group(1)] = list
195 def CreatePatmanConfigFile(config_fname):
196 """Creates a config file under $(HOME)/.patman if it can't find one.
199 config_fname: Default config filename i.e., $(HOME)/.patman
204 name = gitutil.get_default_user_name()
206 name = input("Enter name: ")
208 email = gitutil.get_default_user_email()
211 email = input("Enter email: ")
214 f = open(config_fname, 'w')
216 print("Couldn't create patman config file\n")
223 nxp = Zhikang Zhang <zhikang.zhang@nxp.com>
224 ''' % (name, email), file=f)
228 def _UpdateDefaults(main_parser, config):
229 """Update the given OptionParser defaults based on config.
231 We'll walk through all of the settings from all parsers.
232 For each setting we'll look for a default in the option parser.
233 If it's found we'll update the option parser default.
235 The idea here is that the .patman file should be able to update
236 defaults but that command line flags should still have the final
240 parser: An instance of an ArgumentParser whose defaults will be
242 config: An instance of _ProjectConfigParser that we will query
245 # Find all the parsers and subparsers
246 parsers = [main_parser]
247 parsers += [subparser for action in main_parser._actions
248 if isinstance(action, argparse._SubParsersAction)
249 for _, subparser in action.choices.items()]
251 # Collect the defaults from each parser
254 for parser in parsers:
255 pdefs = parser.parse_known_args()[0]
256 parser_defaults.append(pdefs)
257 defaults.update(vars(pdefs))
259 # Go through the settings and collect defaults
260 for name, val in config.items('settings'):
262 default_val = defaults[name]
263 if isinstance(default_val, bool):
264 val = config.getboolean('settings', name)
265 elif isinstance(default_val, int):
266 val = config.getint('settings', name)
267 elif isinstance(default_val, str):
268 val = config.get('settings', name)
271 print("WARNING: Unknown setting %s" % name)
273 # Set all the defaults and manually propagate them to subparsers
274 main_parser.set_defaults(**defaults)
275 for parser, pdefs in zip(parsers, parser_defaults):
276 parser.set_defaults(**{k: v for k, v in defaults.items()
280 def _ReadAliasFile(fname):
281 """Read in the U-Boot git alias file if it exists.
284 fname: Filename to read.
286 if os.path.exists(fname):
288 with open(fname, encoding='utf-8') as fd:
293 if not line or line.startswith('#'):
295 words = line.split(None, 2)
296 if len(words) < 3 or words[0] != 'alias':
298 bad_line = "%s:%d:Invalid line '%s'" % (fname, linenum,
301 alias[words[1]] = [s.strip() for s in words[2].split(',')]
306 def _ReadBouncesFile(fname):
307 """Read in the bounces file if it exists
310 fname: Filename to read.
312 if os.path.exists(fname):
313 with open(fname) as fd:
315 if line.startswith('#'):
317 bounces.add(line.strip())
320 def GetItems(config, section):
321 """Get the items from a section of the config.
324 config: _ProjectConfigParser object containing settings
325 section: name of section to retrieve
328 List of (name, value) tuples for the section
331 return config.items(section)
332 except ConfigParser.NoSectionError:
336 def Setup(parser, project_name, config_fname=''):
337 """Set up the settings module by reading config files.
340 parser: The parser to update
341 project_name: Name of project that we're working on; we'll look
342 for sections named "project_section" as well.
343 config_fname: Config filename to read ('' for default)
345 # First read the git alias file if available
346 _ReadAliasFile('doc/git-mailrc')
347 config = _ProjectConfigParser(project_name)
348 if config_fname == '':
349 config_fname = '%s/.patman' % os.getenv('HOME')
351 if not os.path.exists(config_fname):
352 print("No config file found ~/.patman\nCreating one...\n")
353 CreatePatmanConfigFile(config_fname)
355 config.read(config_fname)
357 for name, value in GetItems(config, 'alias'):
358 alias[name] = value.split(',')
360 _ReadBouncesFile('doc/bounces')
361 for name, value in GetItems(config, 'bounces'):
364 _UpdateDefaults(parser, config)
367 # These are the aliases we understand, indexed by alias. Each member is a list.
371 if __name__ == "__main__":