diff options
Diffstat (limited to 'tools/patman/settings.py')
| -rw-r--r-- | tools/patman/settings.py | 101 |
1 files changed, 64 insertions, 37 deletions
diff --git a/tools/patman/settings.py b/tools/patman/settings.py index 903d6fc..636983e 100644 --- a/tools/patman/settings.py +++ b/tools/patman/settings.py @@ -1,18 +1,18 @@ # SPDX-License-Identifier: GPL-2.0+ # Copyright (c) 2011 The Chromium OS Authors. +# Copyright (c) 2022 Maxim Cournoyer <maxim.cournoyer@savoirfairelinux.com> # try: import configparser as ConfigParser -except: +except Exception: import ConfigParser import argparse import os import re -from patman import command -from patman import tools +from patman import gitutil """Default settings per-project. @@ -32,7 +32,8 @@ _default_settings = { }, } -class _ProjectConfigParser(ConfigParser.SafeConfigParser): + +class _ProjectConfigParser(ConfigParser.ConfigParser): """ConfigParser that handles projects. There are two main goals of this class: @@ -83,14 +84,14 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser): def __init__(self, project_name): """Construct _ProjectConfigParser. - In addition to standard SafeConfigParser initialization, this also loads - project defaults. + In addition to standard ConfigParser initialization, this also + loads project defaults. Args: project_name: The name of the project. """ self._project_name = project_name - ConfigParser.SafeConfigParser.__init__(self) + ConfigParser.ConfigParser.__init__(self) # Update the project settings in the config based on # the _default_settings global. @@ -102,31 +103,31 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser): self.set(project_settings, setting_name, setting_value) def get(self, section, option, *args, **kwargs): - """Extend SafeConfigParser to try project_section before section. + """Extend ConfigParser to try project_section before section. Args: - See SafeConfigParser. + See ConfigParser. Returns: - See SafeConfigParser. + See ConfigParser. """ try: - val = ConfigParser.SafeConfigParser.get( + val = ConfigParser.ConfigParser.get( self, "%s_%s" % (self._project_name, section), option, *args, **kwargs ) except (ConfigParser.NoSectionError, ConfigParser.NoOptionError): - val = ConfigParser.SafeConfigParser.get( + val = ConfigParser.ConfigParser.get( self, section, option, *args, **kwargs ) return val def items(self, section, *args, **kwargs): - """Extend SafeConfigParser to add project_section to section. + """Extend ConfigParser to add project_section to section. Args: - See SafeConfigParser. + See ConfigParser. Returns: - See SafeConfigParser. + See ConfigParser. """ project_items = [] has_project_section = False @@ -134,7 +135,7 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser): # Get items from the project section try: - project_items = ConfigParser.SafeConfigParser.items( + project_items = ConfigParser.ConfigParser.items( self, "%s_%s" % (self._project_name, section), *args, **kwargs ) has_project_section = True @@ -143,7 +144,7 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser): # Get top-level items try: - top_items = ConfigParser.SafeConfigParser.items( + top_items = ConfigParser.ConfigParser.items( self, section, *args, **kwargs ) except ConfigParser.NoSectionError: @@ -155,6 +156,7 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser): item_dict.update(project_items) return {(item, val) for item, val in item_dict.items()} + def ReadGitAliases(fname): """Read a git alias file. This is in the form used by git: @@ -170,7 +172,7 @@ def ReadGitAliases(fname): print("Warning: Cannot find alias file '%s'" % fname) return - re_line = re.compile('alias\s+(\S+)\s+(.*)') + re_line = re.compile(r'alias\s+(\S+)\s+(.*)') for line in fd.readlines(): line = line.strip() if not line or line[0] == '#': @@ -190,7 +192,8 @@ def ReadGitAliases(fname): fd.close() -def CreatePatmanConfigFile(gitutil, config_fname): + +def CreatePatmanConfigFile(config_fname): """Creates a config file under $(HOME)/.patman if it can't find one. Args: @@ -200,12 +203,12 @@ def CreatePatmanConfigFile(gitutil, config_fname): None """ name = gitutil.get_default_user_name() - if name == None: + if name is None: name = input("Enter name: ") email = gitutil.get_default_user_email() - if email == None: + if email is None: email = input("Enter email: ") try: @@ -220,7 +223,8 @@ me: %s <%s> [bounces] nxp = Zhikang Zhang <zhikang.zhang@nxp.com> ''' % (name, email), file=f) - f.close(); + f.close() + def _UpdateDefaults(main_parser, config): """Update the given OptionParser defaults based on config. @@ -242,8 +246,8 @@ def _UpdateDefaults(main_parser, config): # Find all the parsers and subparsers parsers = [main_parser] parsers += [subparser for action in main_parser._actions - if isinstance(action, argparse._SubParsersAction) - for _, subparser in action.choices.items()] + if isinstance(action, argparse._SubParsersAction) + for _, subparser in action.choices.items()] # Collect the defaults from each parser defaults = {} @@ -270,8 +274,9 @@ def _UpdateDefaults(main_parser, config): # Set all the defaults and manually propagate them to subparsers main_parser.set_defaults(**defaults) for parser, pdefs in zip(parsers, parser_defaults): - parser.set_defaults(**{ k: v for k, v in defaults.items() - if k in pdefs }) + parser.set_defaults(**{k: v for k, v in defaults.items() + if k in pdefs}) + def _ReadAliasFile(fname): """Read in the U-Boot git alias file if it exists. @@ -298,6 +303,7 @@ def _ReadAliasFile(fname): if bad_line: print(bad_line) + def _ReadBouncesFile(fname): """Read in the bounces file if it exists @@ -311,6 +317,7 @@ def _ReadBouncesFile(fname): continue bounces.add(line.strip()) + def GetItems(config, section): """Get the items from a section of the config. @@ -323,31 +330,50 @@ def GetItems(config, section): """ try: return config.items(section) - except ConfigParser.NoSectionError as e: + except ConfigParser.NoSectionError: return [] - except: - raise -def Setup(gitutil, parser, project_name, config_fname=''): + +def Setup(parser, project_name, config_fname=None): """Set up the settings module by reading config files. + Unless `config_fname` is specified, a `.patman` config file local + to the git repository is consulted, followed by the global + `$HOME/.patman`. If none exists, the later is created. Values + defined in the local config file take precedence over those + defined in the global one. + Args: - parser: The parser to update + parser: The parser to update. project_name: Name of project that we're working on; we'll look for sections named "project_section" as well. - config_fname: Config filename to read ('' for default) + config_fname: Config filename to read. An error is raised if it + does not exist. """ # First read the git alias file if available _ReadAliasFile('doc/git-mailrc') config = _ProjectConfigParser(project_name) - if config_fname == '': + + if config_fname and not os.path.exists(config_fname): + raise Exception(f'provided {config_fname} does not exist') + + if not config_fname: config_fname = '%s/.patman' % os.getenv('HOME') + has_config = os.path.exists(config_fname) + + git_local_config_fname = os.path.join(gitutil.get_top_level(), '.patman') + has_git_local_config = os.path.exists(git_local_config_fname) - if not os.path.exists(config_fname): - print("No config file found ~/.patman\nCreating one...\n") - CreatePatmanConfigFile(gitutil, config_fname) + # Read the git local config last, so that its values override + # those of the global config, if any. + if has_config: + config.read(config_fname) + if has_git_local_config: + config.read(git_local_config_fname) - config.read(config_fname) + if not (has_config or has_git_local_config): + print("No config file found.\nCreating ~/.patman...\n") + CreatePatmanConfigFile(config_fname) for name, value in GetItems(config, 'alias'): alias[name] = value.split(',') @@ -358,6 +384,7 @@ def Setup(gitutil, parser, project_name, config_fname=''): _UpdateDefaults(parser, config) + # These are the aliases we understand, indexed by alias. Each member is a list. alias = {} bounces = set() |