Merge "Fix/suppress most pylint and gpylint warnings" am: 6ddd85608f

Original change: https://android-review.googlesource.com/c/platform/build/+/1690128

Change-Id: I71253126af3522c2d4fdd3a94f3dcb03d13f4cb0
This commit is contained in:
Chih-hung Hsieh 2021-04-30 01:09:25 +00:00 committed by Automerger Merge Worker
commit 89388a5935
12 changed files with 75 additions and 45 deletions

View File

@ -27,6 +27,7 @@ import sys
def main(): def main():
"""Old main() calls warn.warn."""
os.environ['PYTHONPATH'] = os.path.dirname(os.path.abspath(__file__)) os.environ['PYTHONPATH'] = os.path.dirname(os.path.abspath(__file__))
subprocess.check_call(['/usr/bin/python3', '-m', 'warn.warn'] + sys.argv[1:]) subprocess.check_call(['/usr/bin/python3', '-m', 'warn.warn'] + sys.argv[1:])

View File

@ -17,6 +17,7 @@
def create_pattern(name, pattern=None): def create_pattern(name, pattern=None):
"""Return a tuple of name and warn patten."""
if pattern is not None: if pattern is not None:
return [name, '(^|.*/)' + pattern + '/.*: warning:'] return [name, '(^|.*/)' + pattern + '/.*: warning:']
return [name, '(^|.*/)' + name + '/.*: warning:'] return [name, '(^|.*/)' + name + '/.*: warning:']

View File

@ -8,6 +8,7 @@ unification of the Chrome and Android warn.py.
def create_pattern(pattern): def create_pattern(pattern):
"""Return a tuple of name and warn patten."""
return [pattern, '(^|.*/)' + pattern + '/.*: warning:'] return [pattern, '(^|.*/)' + pattern + '/.*: warning:']

View File

@ -15,10 +15,12 @@
"""Warning patterns for C/C++ compiler, but not clang-tidy.""" """Warning patterns for C/C++ compiler, but not clang-tidy."""
# No need of doc strings for trivial small functions.
# pylint:disable=missing-function-docstring
import re import re
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .severity import Severity from .severity import Severity
@ -56,7 +58,8 @@ def harmless(description, pattern_list):
warn_patterns = [ warn_patterns = [
# pylint:disable=line-too-long,g-inconsistent-quotes # pylint does not recognize g-inconsistent-quotes
# pylint:disable=line-too-long,bad-option-value,g-inconsistent-quotes
medium('Implicit function declaration', medium('Implicit function declaration',
[r".*: warning: implicit declaration of function .+", [r".*: warning: implicit declaration of function .+",
r".*: warning: implicitly declaring library function"]), r".*: warning: implicitly declaring library function"]),
@ -300,7 +303,7 @@ warn_patterns = [
medium('Missing noreturn', medium('Missing noreturn',
[r".*: warning: function '.*' could be declared with attribute 'noreturn'"]), [r".*: warning: function '.*' could be declared with attribute 'noreturn'"]),
medium('User warning', medium('User warning',
[r".*: warning: #warning "".+"""]), [r".*: warning: #warning \".+\""]),
medium('Vexing parsing problem', medium('Vexing parsing problem',
[r".*: warning: empty parentheses interpreted as a function declaration"]), [r".*: warning: empty parentheses interpreted as a function declaration"]),
medium('Dereferencing void*', medium('Dereferencing void*',

View File

@ -15,6 +15,9 @@
"""Emit warning messages to html or csv files.""" """Emit warning messages to html or csv files."""
# Many functions in this module have too many arguments to be refactored.
# pylint:disable=too-many-arguments,missing-function-docstring
# To emit html page of warning messages: # To emit html page of warning messages:
# flags: --byproject, --url, --separator # flags: --byproject, --url, --separator
# Old stuff for static html components: # Old stuff for static html components:
@ -57,11 +60,10 @@ import html
import sys import sys
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .severity import Severity from .severity import Severity
html_head_scripts = """\ HTML_HEAD_SCRIPTS = """\
<script type="text/javascript"> <script type="text/javascript">
function expand(id) { function expand(id) {
var e = document.getElementById(id); var e = document.getElementById(id);
@ -113,7 +115,7 @@ def html_big(param):
def dump_html_prologue(title, writer, warn_patterns, project_names): def dump_html_prologue(title, writer, warn_patterns, project_names):
writer('<html>\n<head>') writer('<html>\n<head>')
writer('<title>' + title + '</title>') writer('<title>' + title + '</title>')
writer(html_head_scripts) writer(HTML_HEAD_SCRIPTS)
emit_stats_by_project(writer, warn_patterns, project_names) emit_stats_by_project(writer, warn_patterns, project_names)
writer('</head>\n<body>') writer('</head>\n<body>')
writer(html_big(title)) writer(html_big(title))
@ -142,7 +144,7 @@ def create_warnings(warn_patterns, project_names):
2D warnings array where warnings[p][s] is # of warnings in project name p of 2D warnings array where warnings[p][s] is # of warnings in project name p of
severity level s severity level s
""" """
# pylint:disable=g-complex-comprehension # pylint:disable=invalid-name
warnings = {p: {s.value: 0 for s in Severity.levels} for p in project_names} warnings = {p: {s.value: 0 for s in Severity.levels} for p in project_names}
for i in warn_patterns: for i in warn_patterns:
s = i['severity'].value s = i['severity'].value
@ -153,7 +155,6 @@ def create_warnings(warn_patterns, project_names):
def get_total_by_project(warnings, project_names): def get_total_by_project(warnings, project_names):
"""Returns dict, project as key and # warnings for that project as value.""" """Returns dict, project as key and # warnings for that project as value."""
# pylint:disable=g-complex-comprehension
return { return {
p: sum(warnings[p][s.value] for s in Severity.levels) p: sum(warnings[p][s.value] for s in Severity.levels)
for p in project_names for p in project_names
@ -162,7 +163,6 @@ def get_total_by_project(warnings, project_names):
def get_total_by_severity(warnings, project_names): def get_total_by_severity(warnings, project_names):
"""Returns dict, severity as key and # warnings of that severity as value.""" """Returns dict, severity as key and # warnings of that severity as value."""
# pylint:disable=g-complex-comprehension
return { return {
s.value: sum(warnings[p][s.value] for p in project_names) s.value: sum(warnings[p][s.value] for p in project_names)
for s in Severity.levels for s in Severity.levels
@ -235,7 +235,7 @@ def emit_row_counts_per_severity(total_by_severity, stats_header, stats_rows,
writer('<script>') writer('<script>')
emit_const_string_array('StatsHeader', stats_header, writer) emit_const_string_array('StatsHeader', stats_header, writer)
emit_const_object_array('StatsRows', stats_rows, writer) emit_const_object_array('StatsRows', stats_rows, writer)
writer(draw_table_javascript) writer(DRAW_TABLE_JAVASCRIPT)
writer('</script>') writer('</script>')
@ -246,8 +246,8 @@ def emit_stats_by_project(writer, warn_patterns, project_names):
total_by_project = get_total_by_project(warnings, project_names) total_by_project = get_total_by_project(warnings, project_names)
total_by_severity = get_total_by_severity(warnings, project_names) total_by_severity = get_total_by_severity(warnings, project_names)
stats_header = emit_table_header(total_by_severity) stats_header = emit_table_header(total_by_severity)
total_all_projects, stats_rows = \ total_all_projects, stats_rows = emit_row_counts_per_project(
emit_row_counts_per_project(warnings, total_by_project, total_by_severity, project_names) warnings, total_by_project, total_by_severity, project_names)
emit_row_counts_per_severity(total_by_severity, stats_header, stats_rows, emit_row_counts_per_severity(total_by_severity, stats_header, stats_rows,
total_all_projects, writer) total_all_projects, writer)
@ -287,6 +287,7 @@ def dump_stats(writer, warn_patterns):
# id for each warning pattern # id for each warning pattern
# sort by project, severity, warn_id, warning_message # sort by project, severity, warn_id, warning_message
def emit_buttons(writer): def emit_buttons(writer):
"""Write the button elements in HTML."""
writer('<button class="button" onclick="expandCollapse(1);">' writer('<button class="button" onclick="expandCollapse(1);">'
'Expand all warnings</button>\n' 'Expand all warnings</button>\n'
'<button class="button" onclick="expandCollapse(0);">' '<button class="button" onclick="expandCollapse(0);">'
@ -412,7 +413,7 @@ def emit_warning_arrays(writer, warn_patterns):
writer('];') writer('];')
scripts_for_warning_groups = """ SCRIPTS_FOR_WARNING_GROUPS = """
function compareMessages(x1, x2) { // of the same warning type function compareMessages(x1, x2) { // of the same warning type
return (WarningMessages[x1[2]] <= WarningMessages[x2[2]]) ? -1 : 1; return (WarningMessages[x1[2]] <= WarningMessages[x2[2]]) ? -1 : 1;
} }
@ -620,7 +621,7 @@ def emit_js_data(writer, flags, warning_messages, warning_links,
emit_const_html_string_array('WarningLinks', warning_links, writer) emit_const_html_string_array('WarningLinks', warning_links, writer)
draw_table_javascript = """ DRAW_TABLE_JAVASCRIPT = """
google.charts.load('current', {'packages':['table']}); google.charts.load('current', {'packages':['table']});
google.charts.setOnLoadCallback(drawTable); google.charts.setOnLoadCallback(drawTable);
function drawTable() { function drawTable() {
@ -653,7 +654,7 @@ def dump_html(flags, output_stream, warning_messages, warning_links,
writer('\n<script>') writer('\n<script>')
emit_js_data(writer, flags, warning_messages, warning_links, warning_records, emit_js_data(writer, flags, warning_messages, warning_links, warning_records,
warn_patterns, project_names) warn_patterns, project_names)
writer(scripts_for_warning_groups) writer(SCRIPTS_FOR_WARNING_GROUPS)
writer('</script>') writer('</script>')
emit_buttons(writer) emit_buttons(writer)
# Warning messages are grouped by severities or project names. # Warning messages are grouped by severities or project names.

View File

@ -15,8 +15,10 @@
"""Warning patterns for Java compiler tools.""" """Warning patterns for Java compiler tools."""
# No need of doc strings for trivial small functions.
# pylint:disable=missing-function-docstring
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .cpp_warn_patterns import compile_patterns from .cpp_warn_patterns import compile_patterns
from .severity import Severity from .severity import Severity
@ -59,7 +61,8 @@ def low(name, description=None):
warn_patterns = [ warn_patterns = [
# pylint:disable=line-too-long,g-inconsistent-quotes # pylint does not recognize g-inconsistent-quotes
# pylint:disable=line-too-long,bad-option-value,g-inconsistent-quotes
# Warnings from Javac # Warnings from Javac
java_medium('Use of deprecated', java_medium('Use of deprecated',
[r'.*: warning: \[deprecation\] .+', [r'.*: warning: \[deprecation\] .+',

View File

@ -16,12 +16,12 @@
"""Warning patterns for build make tools.""" """Warning patterns for build make tools."""
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .cpp_warn_patterns import compile_patterns from .cpp_warn_patterns import compile_patterns
from .severity import Severity from .severity import Severity
warn_patterns = [ warn_patterns = [
# pylint:disable=line-too-long,g-inconsistent-quotes # pylint does not recognize g-inconsistent-quotes
# pylint:disable=line-too-long,bad-option-value,g-inconsistent-quotes
{'category': 'make', 'severity': Severity.MEDIUM, {'category': 'make', 'severity': Severity.MEDIUM,
'description': 'make: overriding commands/ignoring old commands', 'description': 'make: overriding commands/ignoring old commands',
'patterns': [r".*: warning: overriding commands for target .+", 'patterns': [r".*: warning: overriding commands for target .+",

View File

@ -15,8 +15,10 @@
"""Warning patterns from other tools.""" """Warning patterns from other tools."""
# No need of doc strings for trivial small functions.
# pylint:disable=missing-function-docstring
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .cpp_warn_patterns import compile_patterns from .cpp_warn_patterns import compile_patterns
from .severity import Severity from .severity import Severity
@ -57,7 +59,8 @@ def rust(severity, description, pattern):
warn_patterns = [ warn_patterns = [
# pylint:disable=line-too-long,g-inconsistent-quotes # pylint does not recognize g-inconsistent-quotes
# pylint:disable=line-too-long,bad-option-value,g-inconsistent-quotes
# aapt warnings # aapt warnings
aapt('No comment for public symbol', aapt('No comment for public symbol',
[r".*: warning: No comment for public symbol .+"]), [r".*: warning: No comment for public symbol .+"]),

View File

@ -19,8 +19,9 @@ This file stores definition for class Severity that is used in warn_patterns.
""" """
# pylint:disable=old-style-class # pylint:disable=too-few-public-methods
class SeverityInfo: class SeverityInfo:
"""Class of Severity Info, part of a Severity object."""
def __init__(self, value, color, column_header, header): def __init__(self, value, color, column_header, header):
self.value = value self.value = value
@ -29,7 +30,7 @@ class SeverityInfo:
self.header = header self.header = header
# pylint:disable=old-style-class # pylint:disable=too-few-public-methods
class Severity: class Severity:
"""Class of Severity levels where each level is a SeverityInfo.""" """Class of Severity levels where each level is a SeverityInfo."""

View File

@ -15,8 +15,10 @@
"""Warning patterns for clang-tidy.""" """Warning patterns for clang-tidy."""
# No need of doc strings for trivial small functions.
# pylint:disable=missing-function-docstring
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level
# pylint:disable=g-importing-member
from .cpp_warn_patterns import compile_patterns from .cpp_warn_patterns import compile_patterns
from .severity import Severity from .severity import Severity
@ -39,7 +41,6 @@ def group_tidy_warn_pattern(description):
def analyzer_high(description, patterns): def analyzer_high(description, patterns):
# Important clang analyzer warnings to be fixed ASAP.
return { return {
'category': 'C/C++', 'category': 'C/C++',
'severity': Severity.HIGH, 'severity': Severity.HIGH,
@ -74,7 +75,8 @@ def analyzer_group_check(check):
warn_patterns = [ warn_patterns = [
# pylint:disable=line-too-long,g-inconsistent-quotes # pylint does not recognize g-inconsistent-quotes
# pylint:disable=line-too-long,bad-option-value,g-inconsistent-quotes
group_tidy_warn_pattern('android'), group_tidy_warn_pattern('android'),
simple_tidy_warn_pattern('abseil-string-find-startswith'), simple_tidy_warn_pattern('abseil-string-find-startswith'),
simple_tidy_warn_pattern('bugprone-argument-comment'), simple_tidy_warn_pattern('bugprone-argument-comment'),

View File

@ -20,7 +20,8 @@ import multiprocessing
import signal import signal
import sys import sys
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level,no-name-in-module
# suppress false positive of no-name-in-module warnings
from . import warn_common as common from . import warn_common as common
@ -50,6 +51,7 @@ def classify_warnings(args):
def create_and_launch_subprocesses(num_cpu, classify_warnings_fn, arg_groups, def create_and_launch_subprocesses(num_cpu, classify_warnings_fn, arg_groups,
group_results): group_results):
"""Fork num_cpu processes to classify warnings."""
pool = multiprocessing.Pool(num_cpu) pool = multiprocessing.Pool(num_cpu)
for cpu in range(num_cpu): for cpu in range(num_cpu):
proc_result = pool.map(classify_warnings_fn, arg_groups[cpu]) proc_result = pool.map(classify_warnings_fn, arg_groups[cpu])
@ -59,6 +61,7 @@ def create_and_launch_subprocesses(num_cpu, classify_warnings_fn, arg_groups,
def main(): def main():
"""Old main() calls new common_main."""
use_google3 = False use_google3 = False
common.common_main(use_google3, create_and_launch_subprocesses, common.common_main(use_google3, create_and_launch_subprocesses,
classify_warnings) classify_warnings)

View File

@ -52,8 +52,8 @@ import os
import re import re
import sys import sys
# pylint:disable=relative-beyond-top-level # pylint:disable=relative-beyond-top-level,no-name-in-module
# pylint:disable=g-importing-member # suppress false positive of no-name-in-module warnings
from . import android_project_list from . import android_project_list
from . import chrome_project_list from . import chrome_project_list
from . import cpp_warn_patterns as cpp_patterns from . import cpp_warn_patterns as cpp_patterns
@ -115,6 +115,8 @@ def get_project_names(project_list):
def find_project_index(line, project_patterns): def find_project_index(line, project_patterns):
"""Return the index to the project pattern array."""
# pylint:disable=invalid-name
for i, p in enumerate(project_patterns): for i, p in enumerate(project_patterns):
if p.match(line): if p.match(line):
return i return i
@ -124,30 +126,30 @@ def find_project_index(line, project_patterns):
def classify_one_warning(warning, link, results, project_patterns, def classify_one_warning(warning, link, results, project_patterns,
warn_patterns): warn_patterns):
"""Classify one warning line.""" """Classify one warning line."""
# pylint:disable=invalid-name
for i, w in enumerate(warn_patterns): for i, w in enumerate(warn_patterns):
for cpat in w['compiled_patterns']: for cpat in w['compiled_patterns']:
if cpat.match(warning): if cpat.match(warning):
p = find_project_index(warning, project_patterns) p = find_project_index(warning, project_patterns)
results.append([warning, link, i, p]) results.append([warning, link, i, p])
return return
else: # If we end up here, there was a problem parsing the log
# If we end up here, there was a problem parsing the log # probably caused by 'make -j' mixing the output from
# probably caused by 'make -j' mixing the output from # 2 or more concurrent compiles
# 2 or more concurrent compiles
pass
def remove_prefix(s, sub): def remove_prefix(src, sub):
"""Remove everything before last occurrence of substring sub in string s.""" """Remove everything before last occurrence of substring sub in string src."""
if sub in s: if sub in src:
inc_sub = s.rfind(sub) inc_sub = src.rfind(sub)
return s[inc_sub:] return src[inc_sub:]
return s return src
# TODO(emmavukelj): Don't have any generate_*_cs_link functions call # TODO(emmavukelj): Don't have any generate_*_cs_link functions call
# normalize_path a second time (the first time being in parse_input_file) # normalize_path a second time (the first time being in parse_input_file)
def generate_cs_link(warning_line, flags, android_root=None): def generate_cs_link(warning_line, flags, android_root=None):
"""Try to add code search HTTP URL prefix."""
if flags.platform == 'chrome': if flags.platform == 'chrome':
return generate_chrome_cs_link(warning_line, flags) return generate_chrome_cs_link(warning_line, flags)
if flags.platform == 'android': if flags.platform == 'android':
@ -279,8 +281,7 @@ def normalize_path(path, flags, android_root=None):
if idx >= 0: if idx >= 0:
# remove chrome_root/, we want path relative to that # remove chrome_root/, we want path relative to that
return path[idx + len('chrome_root/'):] return path[idx + len('chrome_root/'):]
else: return path
return path
def normalize_warning_line(line, flags, android_root=None): def normalize_warning_line(line, flags, android_root=None):
@ -309,6 +310,7 @@ def parse_input_file_chrome(infile, flags):
# Remove the duplicated warnings save ~8% of time when parsing # Remove the duplicated warnings save ~8% of time when parsing
# one typical build log than before # one typical build log than before
unique_warnings = dict() unique_warnings = dict()
# pylint:disable=invalid-name
for line in infile: for line in infile:
if warning_pattern.match(line): if warning_pattern.match(line):
normalized_line = normalize_warning_line(line, flags) normalized_line = normalize_warning_line(line, flags)
@ -344,6 +346,7 @@ def add_normalized_line_to_warnings(line, flags, android_root, unique_warnings):
def parse_input_file_android(infile, flags): def parse_input_file_android(infile, flags):
"""Parse Android input file, collect parameters and warning lines.""" """Parse Android input file, collect parameters and warning lines."""
# pylint:disable=too-many-locals,too-many-branches
platform_version = 'unknown' platform_version = 'unknown'
target_product = 'unknown' target_product = 'unknown'
target_variant = 'unknown' target_variant = 'unknown'
@ -393,6 +396,7 @@ def parse_input_file_android(infile, flags):
line, flags, android_root, unique_warnings) line, flags, android_root, unique_warnings)
continue continue
# pylint:disable=invalid-name
if line_counter < 100: if line_counter < 100:
# save a little bit of time by only doing this for the first few lines # save a little bit of time by only doing this for the first few lines
line_counter += 1 line_counter += 1
@ -424,6 +428,7 @@ def parse_input_file_android(infile, flags):
def parse_input_file(infile, flags): def parse_input_file(infile, flags):
"""Parse one input file for chrome or android."""
if flags.platform == 'chrome': if flags.platform == 'chrome':
return parse_input_file_chrome(infile, flags) return parse_input_file_chrome(infile, flags)
if flags.platform == 'android': if flags.platform == 'android':
@ -448,9 +453,12 @@ def get_warn_patterns(platform):
if platform == 'chrome': if platform == 'chrome':
warn_patterns = cpp_patterns.warn_patterns warn_patterns = cpp_patterns.warn_patterns
elif platform == 'android': elif platform == 'android':
warn_patterns = make_patterns.warn_patterns + cpp_patterns.warn_patterns + java_patterns.warn_patterns + tidy_patterns.warn_patterns + other_patterns.warn_patterns warn_patterns = (make_patterns.warn_patterns + cpp_patterns.warn_patterns +
java_patterns.warn_patterns + tidy_patterns.warn_patterns +
other_patterns.warn_patterns)
else: else:
raise Exception('platform name %s is not valid' % platform) raise Exception('platform name %s is not valid' % platform)
# pylint:disable=invalid-name
for w in warn_patterns: for w in warn_patterns:
w['members'] = [] w['members'] = []
# Each warning pattern has a 'projects' dictionary, that # Each warning pattern has a 'projects' dictionary, that
@ -473,6 +481,7 @@ def parallel_classify_warnings(warning_data, args, project_names,
use_google3, create_launch_subprocs_fn, use_google3, create_launch_subprocs_fn,
classify_warnings_fn): classify_warnings_fn):
"""Classify all warning lines with num_cpu parallel processes.""" """Classify all warning lines with num_cpu parallel processes."""
# pylint:disable=too-many-arguments,too-many-locals
num_cpu = args.processes num_cpu = args.processes
group_results = [] group_results = []
@ -531,8 +540,10 @@ def parallel_classify_warnings(warning_data, args, project_names,
def process_log(logfile, flags, project_names, project_patterns, warn_patterns, def process_log(logfile, flags, project_names, project_patterns, warn_patterns,
html_path, use_google3, create_launch_subprocs_fn, html_path, use_google3, create_launch_subprocs_fn,
classify_warnings_fn, logfile_object): classify_warnings_fn, logfile_object):
# pylint: disable=g-doc-args # pylint does not recognize g-doc-*
# pylint: disable=g-doc-return-or-yield # pylint: disable=bad-option-value,g-doc-args
# pylint: disable=bad-option-value,g-doc-return-or-yield
# pylint: disable=too-many-arguments,too-many-locals
"""Function that handles processing of a log. """Function that handles processing of a log.
This is isolated into its own function (rather than just taking place in main) This is isolated into its own function (rather than just taking place in main)