colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moveconfig: Fix some pylint errors

Browse Source 
There are over 200 errors in this file. Fix some of them, starting at the
beginning of the file. Future work can continue this effort.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
2021-12-18 14:54:35 -07:00
committed by Tom Rini
parent 37f815cad0
commit 91197aa696
1 changed files with 109 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
tools/moveconfig.py
View File

@@ -13,6 +13,7 @@ See doc/develop/moveconfig.rst for documentation.
from argparse import ArgumentParser from argparse import ArgumentParser
import asteval import asteval
import collections import collections
from contextlib import ExitStack
import copy import copy
import difflib import difflib
import doctest import doctest
@@ -93,14 +94,14 @@ SIZES = {
### helper functions ### ### helper functions ###
def check_top_directory(): def check_top_directory():
"""Exit if we are not at the top of source directory.""" """Exit if we are not at the top of source directory."""
for f in ('README', 'Licenses'): for fname in 'README', 'Licenses':
if not os.path.exists(f): if not os.path.exists(fname):
sys.exit('Please run at the top of source directory.') sys.exit('Please run at the top of source directory.')
def check_clean_directory(): def check_clean_directory():
"""Exit if the source tree is not clean.""" """Exit if the source tree is not clean."""
for f in ('.config', 'include/config'): for fname in '.config', 'include/config':
if os.path.exists(f): if os.path.exists(fname):
sys.exit("source tree is not clean, please run 'make mrproper'") sys.exit("source tree is not clean, please run 'make mrproper'")
def get_make_cmd(): def get_make_cmd():
@@ -110,22 +111,22 @@ def get_make_cmd():
necessarily "make". (for example, "gmake" on FreeBSD). necessarily "make". (for example, "gmake" on FreeBSD).
Returns the most appropriate command name on your system. Returns the most appropriate command name on your system.
""" """
process = subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE) with subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE) as proc:
ret = process.communicate() ret = proc.communicate()
if process.returncode: if proc.returncode:
sys.exit('GNU Make not found') sys.exit('GNU Make not found')
return ret[0].rstrip() return ret[0].rstrip()
def get_matched_defconfig(line): def get_matched_defconfig(line):
"""Get the defconfig files that match a pattern """Get the defconfig files that match a pattern
Args: Args:
line: Path or filename to match, e.g. 'configs/snow_defconfig' or line (str): Path or filename to match, e.g. 'configs/snow_defconfig' or
'k2*_defconfig'. If no directory is provided, 'configs/' is 'k2*_defconfig'. If no directory is provided, 'configs/' is
prepended prepended
Returns: Returns:
a list of matching defconfig files list of str: a list of matching defconfig files
""" """
dirname = os.path.dirname(line) dirname = os.path.dirname(line)
if dirname: if dirname:
@@ -138,38 +139,43 @@ def get_matched_defconfigs(defconfigs_file):
"""Get all the defconfig files that match the patterns in a file. """Get all the defconfig files that match the patterns in a file.
Args: Args:
defconfigs_file: File containing a list of defconfigs to process, or defconfigs_file (str): File containing a list of defconfigs to process,
'-' to read the list from stdin or '-' to read the list from stdin
Returns: Returns:
A list of paths to defconfig files, with no duplicates list of str: A list of paths to defconfig files, with no duplicates
""" """
defconfigs = [] defconfigs = []
if defconfigs_file == '-': with ExitStack() as stack:
fd = sys.stdin if defconfigs_file == '-':
defconfigs_file = 'stdin' inf = sys.stdin
else: defconfigs_file = 'stdin'
fd = open(defconfigs_file) else:
for i, line in enumerate(fd): inf = stack.enter_context(open(defconfigs_file, encoding='utf-8'))
line = line.strip() for i, line in enumerate(inf):
if not line: line = line.strip()
continue # skip blank lines silently if not line:
if ' ' in line: continue # skip blank lines silently
line = line.split(' ')[0] # handle 'git log' input if ' ' in line:
matched = get_matched_defconfig(line) line = line.split(' ')[0] # handle 'git log' input
if not matched: matched = get_matched_defconfig(line)
print("warning: %s:%d: no defconfig matched '%s'" % \ if not matched:
(defconfigs_file, i + 1, line), file=sys.stderr) print(f"warning: {defconfigs_file}:{i + 1}: no defconfig matched '{line}'",
file=sys.stderr)
defconfigs += matched defconfigs += matched
# use set() to drop multiple matching # use set() to drop multiple matching
return [ defconfig[len('configs') + 1:] for defconfig in set(defconfigs) ] return [defconfig[len('configs') + 1:] for defconfig in set(defconfigs)]
def get_all_defconfigs(): def get_all_defconfigs():
"""Get all the defconfig files under the configs/ directory.""" """Get all the defconfig files under the configs/ directory.
Returns:
list of str: List of paths to defconfig files
"""
defconfigs = [] defconfigs = []
for (dirpath, dirnames, filenames) in os.walk('configs'): for (dirpath, _, filenames) in os.walk('configs'):
dirpath = dirpath[len('configs') + 1:] dirpath = dirpath[len('configs') + 1:]
for filename in fnmatch.filter(filenames, '*_defconfig'): for filename in fnmatch.filter(filenames, '*_defconfig'):
defconfigs.append(os.path.join(dirpath, filename)) defconfigs.append(os.path.join(dirpath, filename))
@@ -183,20 +189,18 @@ def color_text(color_enabled, color, string):
# Otherwise, additional whitespace or line-feed might be printed. # Otherwise, additional whitespace or line-feed might be printed.
return '\n'.join([ '\033[' + color + 'm' + s + '\033[0m' if s else '' return '\n'.join([ '\033[' + color + 'm' + s + '\033[0m' if s else ''
for s in string.split('\n') ]) for s in string.split('\n') ])
else: return string
return string
def show_diff(a, b, file_path, color_enabled): def show_diff(alines, blines, file_path, color_enabled):
"""Show unidified diff. """Show unidified diff.
Arguments: Args:
a: A list of lines (before) alines (list of str): A list of lines (before)
b: A list of lines (after) blines (list of str): A list of lines (after)
file_path: Path to the file file_path (str): Path to the file
color_enabled: Display the diff in color color_enabled (bool): Display the diff in color
""" """
diff = difflib.unified_diff(alines, blines,
diff = difflib.unified_diff(a, b,
fromfile=os.path.join('a', file_path), fromfile=os.path.join('a', file_path),
tofile=os.path.join('b', file_path)) tofile=os.path.join('b', file_path))
@@ -208,21 +212,23 @@ def show_diff(a, b, file_path, color_enabled):
else: else:
print(line, end=' ') print(line, end=' ')
def extend_matched_lines(lines, matched, pre_patterns, post_patterns, extend_pre, def extend_matched_lines(lines, matched, pre_patterns, post_patterns,
extend_post): extend_pre, extend_post):
"""Extend matched lines if desired patterns are found before/after already """Extend matched lines if desired patterns are found before/after already
matched lines. matched lines.
Arguments: Args:
lines: A list of lines handled. lines (list of str): list of lines handled.
matched: A list of line numbers that have been already matched. matched (list of int): list of line numbers that have been already
(will be updated by this function) matched (will be updated by this function)
pre_patterns: A list of regular expression that should be matched as pre_patterns (list of re.Pattern): list of regular expression that should
preamble. be matched as preamble
post_patterns: A list of regular expression that should be matched as post_patterns (list of re.Pattern): list of regular expression that should
postamble. be matched as postamble
extend_pre: Add the line number of matched preamble to the matched list. extend_pre (bool): Add the line number of matched preamble to the matched
extend_post: Add the line number of matched postamble to the matched list. list
extend_post (bool): Add the line number of matched postamble to the
matched list
""" """
extended_matched = [] extended_matched = []
@@ -237,15 +243,15 @@ def extend_matched_lines(lines, matched, pre_patterns, post_patterns, extend_pre
if j >= len(lines): if j >= len(lines):
break break
for p in pre_patterns: for pat in pre_patterns:
if p.search(lines[i - 1]): if pat.search(lines[i - 1]):
break break
else: else:
# not matched # not matched
continue continue
for p in post_patterns: for pat in post_patterns:
if p.search(lines[j]): if pat.search(lines[j]):
break break
else: else:
# not matched # not matched
@@ -260,12 +266,20 @@ def extend_matched_lines(lines, matched, pre_patterns, post_patterns, extend_pre
matched.sort() matched.sort()
def confirm(args, prompt): def confirm(args, prompt):
"""Ask the user to confirm something
Args:
args (Namespace ): program arguments
Returns:
bool: True to confirm, False to cancel/stop
"""
if not args.yes: if not args.yes:
while True: while True:
choice = input('{} [y/n]: '.format(prompt)) choice = input(f'{prompt} [y/n]: ')
choice = choice.lower() choice = choice.lower()
print(choice) print(choice)
if choice == 'y' or choice == 'n': if choice in ('y', 'n'):
break break
if choice == 'n': if choice == 'n':
@@ -319,9 +333,9 @@ def read_file(fname, as_lines=True, skip_unicode=False):
def cleanup_empty_blocks(header_path, args): def cleanup_empty_blocks(header_path, args):
"""Clean up empty conditional blocks """Clean up empty conditional blocks
Arguments: Args:
header_path: path to the cleaned file. header_path (str): path to the cleaned file.
args: program arguments args (Namespace): program arguments
""" """
pattern = re.compile(r'^\s*#\s*if.*$\n^\s*#\s*endif.*$\n*', flags=re.M) pattern = re.compile(r'^\s*#\s*if.*$\n^\s*#\s*endif.*$\n*', flags=re.M)
data = read_file(header_path, as_lines=False, skip_unicode=True) data = read_file(header_path, as_lines=False, skip_unicode=True)
@@ -342,11 +356,11 @@ def cleanup_empty_blocks(header_path, args):
def cleanup_one_header(header_path, patterns, args): def cleanup_one_header(header_path, patterns, args):
"""Clean regex-matched lines away from a file. """Clean regex-matched lines away from a file.
Arguments: Args:
header_path: path to the cleaned file. header_path: path to the cleaned file.
patterns: list of regex patterns. Any lines matching to these patterns: list of regex patterns. Any lines matching to these
patterns are deleted. patterns are deleted.
args: program arguments args (Namespace): program arguments
""" """
lines = read_file(header_path, skip_unicode=True) lines = read_file(header_path, skip_unicode=True)
if lines is None: if lines is None:
@@ -401,9 +415,9 @@ def cleanup_one_header(header_path, patterns, args):
def cleanup_headers(configs, args): def cleanup_headers(configs, args):
"""Delete config defines from board headers. """Delete config defines from board headers.
Arguments: Args:
configs: A list of CONFIGs to remove. configs: A list of CONFIGs to remove.
args: program arguments args (Namespace): program arguments
""" """
if not confirm(args, 'Clean up headers?'): if not confirm(args, 'Clean up headers?'):
return return
@@ -430,10 +444,10 @@ def cleanup_headers(configs, args):
def cleanup_one_extra_option(defconfig_path, configs, args): def cleanup_one_extra_option(defconfig_path, configs, args):
"""Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in one defconfig file. """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in one defconfig file.
Arguments: Args:
defconfig_path: path to the cleaned defconfig file. defconfig_path: path to the cleaned defconfig file.
configs: A list of CONFIGs to remove. configs: A list of CONFIGs to remove.
args: program arguments args (Namespace): program arguments
""" """
start = 'CONFIG_SYS_EXTRA_OPTIONS="' start = 'CONFIG_SYS_EXTRA_OPTIONS="'
@@ -476,9 +490,9 @@ def cleanup_one_extra_option(defconfig_path, configs, args):
def cleanup_extra_options(configs, args): def cleanup_extra_options(configs, args):
"""Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in defconfig files. """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in defconfig files.
Arguments: Args:
configs: A list of CONFIGs to remove. configs: A list of CONFIGs to remove.
args: program arguments args (Namespace): program arguments
""" """
if not confirm(args, 'Clean up CONFIG_SYS_EXTRA_OPTIONS?'): if not confirm(args, 'Clean up CONFIG_SYS_EXTRA_OPTIONS?'):
return return
@@ -494,9 +508,9 @@ def cleanup_extra_options(configs, args):
def cleanup_whitelist(configs, args): def cleanup_whitelist(configs, args):
"""Delete config whitelist entries """Delete config whitelist entries
Arguments: Args:
configs: A list of CONFIGs to remove. configs: A list of CONFIGs to remove.
args: program arguments args (Namespace): program arguments
""" """
if not confirm(args, 'Clean up whitelist entries?'): if not confirm(args, 'Clean up whitelist entries?'):
return return
@@ -516,9 +530,9 @@ def find_matching(patterns, line):
def cleanup_readme(configs, args): def cleanup_readme(configs, args):
"""Delete config description in README """Delete config description in README
Arguments: Args:
configs: A list of CONFIGs to remove. configs: A list of CONFIGs to remove.
args: program arguments args (Namespace): program arguments
""" """
if not confirm(args, 'Clean up README?'): if not confirm(args, 'Clean up README?'):
return return
@@ -574,7 +588,7 @@ class Progress:
def __init__(self, total): def __init__(self, total):
"""Create a new progress indicator. """Create a new progress indicator.
Arguments: Args:
total: A number of defconfig files to process. total: A number of defconfig files to process.
""" """
self.current = 0 self.current = 0
@@ -613,9 +627,9 @@ class KconfigParser:
def __init__(self, configs, args, build_dir): def __init__(self, configs, args, build_dir):
"""Create a new parser. """Create a new parser.
Arguments: Args:
configs: A list of CONFIGs to move. configs: A list of CONFIGs to move.
args: program arguments args (Namespace): program arguments
build_dir: Build directory. build_dir: Build directory.
""" """
self.configs = configs self.configs = configs
@@ -660,7 +674,7 @@ class KconfigParser:
defconfig, .config, and include/autoconf.mk in order to decide defconfig, .config, and include/autoconf.mk in order to decide
which action should be taken for this defconfig. which action should be taken for this defconfig.
Arguments: Args:
config: CONFIG name to parse. config: CONFIG name to parse.
dotconfig_lines: lines from the .config file. dotconfig_lines: lines from the .config file.
autoconf_lines: lines from the include/autoconf.mk file. autoconf_lines: lines from the include/autoconf.mk file.
@@ -710,7 +724,7 @@ class KconfigParser:
searching the target options. searching the target options.
Move the config option(s) to the .config as needed. Move the config option(s) to the .config as needed.
Arguments: Args:
defconfig: defconfig name. defconfig: defconfig name.
Returns: Returns:
@@ -771,10 +785,10 @@ class KconfigParser:
log += color_text(self.args.color, log_color, actlog) + '\n' log += color_text(self.args.color, log_color, actlog) + '\n'
with open(self.dotconfig, 'a') as f: with open(self.dotconfig, 'a', encoding='utf-8') as out:
for (action, value) in results: for (action, value) in results:
if action == ACTION_MOVE: if action == ACTION_MOVE:
f.write(value + '\n') out.write(value + '\n')
updated = True updated = True
self.results = results self.results = results
@@ -846,7 +860,7 @@ class Slot:
make_cmd, reference_src_dir, db_queue): make_cmd, reference_src_dir, db_queue):
"""Create a new process slot. """Create a new process slot.
Arguments: Args:
toolchains: Toolchains object containing toolchains. toolchains: Toolchains object containing toolchains.
configs: A list of CONFIGs to move. configs: A list of CONFIGs to move.
args: Program arguments args: Program arguments
@@ -892,7 +906,7 @@ class Slot:
given defconfig and add it to the slot. Just returns False if given defconfig and add it to the slot. Just returns False if
the slot is occupied (i.e. the current subprocess is still running). the slot is occupied (i.e. the current subprocess is still running).
Arguments: Args:
defconfig: defconfig name. defconfig: defconfig name.
Returns: Returns:
@@ -1047,7 +1061,7 @@ class Slot:
def finish(self, success): def finish(self, success):
"""Display log along with progress and go to the idle state. """Display log along with progress and go to the idle state.
Arguments: Args:
success: Should be True when the defconfig was processed success: Should be True when the defconfig was processed
successfully, or False when it fails. successfully, or False when it fails.
""" """
@@ -1088,7 +1102,7 @@ class Slots:
reference_src_dir, db_queue): reference_src_dir, db_queue):
"""Create a new slots controller. """Create a new slots controller.
Arguments: Args:
toolchains: Toolchains object containing toolchains. toolchains: Toolchains object containing toolchains.
configs: A list of CONFIGs to move. configs: A list of CONFIGs to move.
args: Program arguments args: Program arguments
@@ -1109,7 +1123,7 @@ class Slots:
def add(self, defconfig): def add(self, defconfig):
"""Add a new subprocess if a vacant slot is found. """Add a new subprocess if a vacant slot is found.
Arguments: Args:
defconfig: defconfig name to be put into. defconfig: defconfig name to be put into.
Returns: Returns:
@@ -1187,7 +1201,7 @@ class ReferenceSource:
def __init__(self, commit): def __init__(self, commit):
"""Create a reference source directory based on a specified commit. """Create a reference source directory based on a specified commit.
Arguments: Args:
commit: commit to git-clone commit: commit to git-clone
""" """
self.src_dir = tempfile.mkdtemp() self.src_dir = tempfile.mkdtemp()
@@ -1217,7 +1231,7 @@ class ReferenceSource:
def move_config(toolchains, configs, args, db_queue): def move_config(toolchains, configs, args, db_queue):
"""Move config options to defconfig files. """Move config options to defconfig files.
Arguments: Args:
configs: A list of CONFIGs to move. configs: A list of CONFIGs to move.
args: Program arguments args: Program arguments
""" """
@@ -1245,7 +1259,7 @@ def move_config(toolchains, configs, args, db_queue):
progress = Progress(len(defconfigs)) progress = Progress(len(defconfigs))
slots = Slots(toolchains, configs, args, progress, reference_src_dir, slots = Slots(toolchains, configs, args, progress, reference_src_dir,
db_queue) db_queue)
# Main loop to process defconfig files: # Main loop to process defconfig files:
# Add a new subprocess into a vacant slot. # Add a new subprocess into a vacant slot.
@@ -1351,7 +1365,7 @@ IMPLY_FLAGS = {
'non-arch-board': [ 'non-arch-board': [
IMPLY_NON_ARCH_BOARD, IMPLY_NON_ARCH_BOARD,
'Allow Kconfig options outside arch/ and /board/ to imply'], 'Allow Kconfig options outside arch/ and /board/ to imply'],
}; }
def read_database(): def read_database():
@@ -1470,10 +1484,10 @@ def do_imply_config(config_list, add_imply, imply_flags, skip_added,
for imply_config in rest_configs: for imply_config in rest_configs:
if 'ERRATUM' in imply_config: if 'ERRATUM' in imply_config:
continue continue
if not (imply_flags & IMPLY_CMD): if not imply_flags & IMPLY_CMD:
if 'CONFIG_CMD' in imply_config: if 'CONFIG_CMD' in imply_config:
continue continue
if not (imply_flags & IMPLY_TARGET): if not imply_flags & IMPLY_TARGET:
if 'CONFIG_TARGET' in imply_config: if 'CONFIG_TARGET' in imply_config:
continue continue
@@ -1556,7 +1570,7 @@ def do_imply_config(config_list, add_imply, imply_flags, skip_added,
in_arch_board = not sym or (fname.startswith('arch') or in_arch_board = not sym or (fname.startswith('arch') or
fname.startswith('board')) fname.startswith('board'))
if (not in_arch_board and if (not in_arch_board and
not (imply_flags & IMPLY_NON_ARCH_BOARD)): not imply_flags & IMPLY_NON_ARCH_BOARD):
continue continue
if add_imply and (add_imply == 'all' or if add_imply and (add_imply == 'all' or
@@ -1788,7 +1802,7 @@ doc/develop/moveconfig.rst for documentation.'''
subprocess.call(['git', 'commit', '-s', '-m', msg]) subprocess.call(['git', 'commit', '-s', '-m', msg])
if args.build_db: if args.build_db:
with open(CONFIG_DATABASE, 'w') as fd: with open(CONFIG_DATABASE, 'w', encoding='utf-8') as fd:
for defconfig, configs in config_db.items(): for defconfig, configs in config_db.items():
fd.write('%s\n' % defconfig) fd.write('%s\n' % defconfig)
for config in sorted(configs.keys()): for config in sorted(configs.keys()):