1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
#!/usr/bin/env python3
# coding=utf-8
#
# Copyright (C) 2019 Martin Owens
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA.
#
"""
Add pylint scores to html coverage report html.
This would be done deeper in coverage (as a plugin) but that functionality isn't available.
"""
import os
import re
import sys
from pylint import lint
from pylint.reporters.text import TextReporter
DIR = os.path.dirname(__file__)
REX = re.compile(r"<tr\ class=\"file\"\>.+?\">([^<]+\.py).+?\<\/tr\>")
ARGS = ["--rcfile=" + os.path.join(DIR, "..", ".pylintrc")]
stdout = sys.stdout
class WritableObject(object):
"""dummy output stream for pylint"""
def __init__(self):
self.content = []
def write(self, line):
"dummy write"
self.content.append(line)
def read(self):
"dummy read"
return self.content
def run_pylint(fname):
"run pylint on the given file"
pylint_output = WritableObject()
# Pipe lint errors to devnull
temp, sys.stderr = sys.stderr, open(os.devnull, "w", encoding="utf-8")
try:
lint.Run([fname] + ARGS, reporter=TextReporter(pylint_output), exit=False)
except Exception: # pylint: disable=broad-except
return None
sys.stderr = temp
for output in pylint_output.read():
rates = re.findall(r"rated at (\-?[\d\.]+)", output)
for rate in rates:
return float(rate)
if " rated " in output:
print(f"FAIL: {output}")
return None
def add_lint(fname):
"""
Parse index.html and append in the needed pylint score for this file.
"""
# Read in index file and strip out html whitespace (for easier rex'ing)
with open(fname, "r", encoding="utf-8") as fhl:
html = re.sub(r"\>\s+\<", "><", fhl.read())
# Keep a tab on how much we've inserted into the html
adjust = 0
scores = []
for match in REX.finditer(html):
score = add_lint_one(match.groups()[0])
scores.append(score)
(start, end) = match.span()
start += adjust
end += adjust
old_content = html[start:end]
new_content = old_content[:-5] + f"<td>{score}</td></tr>"
html = html[:start] + new_content + html[end:]
adjust += len(new_content) - len(old_content)
total = sum(scores) / len(scores)
html = html.replace("coverage</th>", "coverage</th><th>pylint</th>")
html = html.replace("</tr></tfoot>", f"<td>{total:.2f}</td></tr></tfoot>")
with open(fname, "w") as fhl:
fhl.write(html)
def add_lint_one(py_file):
score = run_pylint(py_file)
if score is None:
score = -11.0
return score
if __name__ == "__main__":
if len(sys.argv) == 2 and sys.argv[-1].endswith(".html"):
for filename in sys.argv[1:]:
if os.path.isfile(filename):
add_lint(filename)
else:
for my_py_file in sys.argv[1:]:
score = add_lint_one(my_py_file)
print(f"{score},{my_py_file}")
|
