Skip to content

Commit d849b25

Browse files
nedbatnedbat
committed
docs: latest sample HTML report
1 parent 3ab15f4 commit d849b25

13 files changed

+469
-173
lines changed

‎doc/sample_html/coverage_html.js

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ function checkVisible(element) {
2525
return !(rect.bottom < viewTop || rect.top >= viewBottom);
2626
}
2727

28+
function on_click(sel, fn) {
29+
const elt = document.querySelector(sel);
30+
if (elt) {
31+
elt.addEventListener("click", fn);
32+
}
33+
}
34+
2835
// Helpers for table sorting
2936
function getCellValue(row, column = 0) {
3037
const cell = row.cells[column]
@@ -193,6 +200,11 @@ coverage.index_ready = function () {
193200
direction: th.getAttribute("aria-sort"),
194201
}));
195202
});
203+
204+
on_click(".button_prev_file", coverage.to_prev_file);
205+
on_click(".button_next_file", coverage.to_next_file);
206+
207+
on_click(".button_show_hide_help", coverage.show_hide_help);
196208
};
197209

198210
// -- pyfile stuff --
@@ -209,12 +221,6 @@ coverage.pyfile_ready = function () {
209221
coverage.set_sel(0);
210222
}
211223

212-
const on_click = function(sel, fn) {
213-
const elt = document.querySelector(sel);
214-
if (elt) {
215-
elt.addEventListener("click", fn);
216-
}
217-
}
218224
on_click(".button_toggle_run", coverage.toggle_lines);
219225
on_click(".button_toggle_mis", coverage.toggle_lines);
220226
on_click(".button_toggle_exc", coverage.toggle_lines);
@@ -225,6 +231,12 @@ coverage.pyfile_ready = function () {
225231
on_click(".button_top_of_page", coverage.to_top);
226232
on_click(".button_first_chunk", coverage.to_first_chunk);
227233

234+
on_click(".button_prev_file", coverage.to_prev_file);
235+
on_click(".button_next_file", coverage.to_next_file);
236+
on_click(".button_to_index", coverage.to_index);
237+
238+
on_click(".button_show_hide_help", coverage.show_hide_help);
239+
228240
coverage.filters = undefined;
229241
try {
230242
coverage.filters = localStorage.getItem(coverage.LINE_FILTERS_STORAGE);
@@ -299,6 +311,23 @@ coverage.to_first_chunk = function () {
299311
coverage.to_next_chunk();
300312
};
301313

314+
coverage.to_prev_file = function () {
315+
window.location = document.getElementById("prevFileLink").href;
316+
}
317+
318+
coverage.to_next_file = function () {
319+
window.location = document.getElementById("nextFileLink").href;
320+
}
321+
322+
coverage.to_index = function () {
323+
location.href = document.getElementById("indexLink").href;
324+
}
325+
326+
coverage.show_hide_help = function () {
327+
const helpCheck = document.getElementById("help_panel_state")
328+
helpCheck.checked = !helpCheck.checked;
329+
}
330+
302331
// Return a string indicating what kind of chunk this line belongs to,
303332
// or null if not a chunk.
304333
coverage.chunk_indicator = function (line_elt) {

‎doc/sample_html/d_7b071bdc2a35fa80___init___py.html

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
<html>
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5-
<meta http-equiv="X-UA-Compatible" content="IE=emulateIE7" />
65
<title>Coverage for cogapp/__init__.py: 100.00%</title>
76
<link rel="icon" sizes="32x32" href="favicon_32.png">
87
<link rel="stylesheet" href="style.css" type="text/css">
@@ -15,47 +14,71 @@ <h1>
1514
<span class="text">Coverage for </span><b>cogapp/__init__.py</b>:
1615
<span class="pc_cov">100.00%</span>
1716
</h1>
18-
<div id="help_panel_wrapper">
17+
<aside id="help_panel_wrapper">
1918
<input id="help_panel_state" type="checkbox">
2019
<label for="help_panel_state">
2120
<img id="keyboard_icon" src="keybd_closed.png" alt="Show/hide keyboard shortcuts" />
2221
</label>
2322
<div id="help_panel">
2423
<p class="legend">Shortcuts on this page</p>
25-
<div>
26-
<p class="keyhelp">
24+
<div class="keyhelp">
25+
<p>
2726
<kbd>r</kbd>
2827
<kbd>m</kbd>
2928
<kbd>x</kbd>
3029
<kbd>p</kbd>
3130
&nbsp; toggle line displays
3231
</p>
33-
<p class="keyhelp">
32+
<p>
3433
<kbd>j</kbd>
35-
<kbd>k</kbd> &nbsp; next/prev highlighted chunk
34+
<kbd>k</kbd>
35+
&nbsp; next/prev highlighted chunk
3636
</p>
37-
<p class="keyhelp">
37+
<p>
3838
<kbd>0</kbd> &nbsp; (zero) top of page
3939
</p>
40-
<p class="keyhelp">
40+
<p>
4141
<kbd>1</kbd> &nbsp; (one) first highlighted chunk
4242
</p>
43+
<p>
44+
<kbd>[</kbd>
45+
<kbd>]</kbd>
46+
&nbsp; prev/next file
47+
</p>
48+
<p>
49+
<kbd>u</kbd> &nbsp; up to the index
50+
</p>
51+
<p>
52+
<kbd>?</kbd> &nbsp; show/hide this help
53+
</p>
4354
</div>
4455
</div>
45-
</div>
56+
</aside>
4657
<h2>
4758
<span class="text">2 statements &nbsp;</span>
4859
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">2<span class="text"> run</span></button>
4960
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">0<span class="text"> missing</span></button>
5061
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
5162
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">0<span class="text"> partial</span></button>
5263
</h2>
53-
<div style="display: none;">
54-
<button type="button" class="button_next_chunk" data-shortcut="j">Next highlighted chunk</button>
55-
<button type="button" class="button_prev_chunk" data-shortcut="k">Previous highlighted chunk</button>
56-
<button type="button" class="button_top_of_page" data-shortcut="0">Goto top of page</button>
57-
<button type="button" class="button_first_chunk" data-shortcut="1">Goto first highlighted chunk</button>
58-
</div>
64+
<p class="text">
65+
<a id="prevFileLink" class="nav" href="index.html">&#xab; prev</a> &nbsp; &nbsp;
66+
<a id="indexLink" class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
67+
<a id="nextFileLink" class="nav" href="d_7b071bdc2a35fa80___main___py.html">&#xbb; next</a>
68+
&nbsp; &nbsp; &nbsp;
69+
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.4</a>,
70+
created at 2022-05-22 18:22 -0400
71+
</p>
72+
<aside class="hidden">
73+
<button type="button" class="button_next_chunk" data-shortcut="j"/>
74+
<button type="button" class="button_prev_chunk" data-shortcut="k"/>
75+
<button type="button" class="button_top_of_page" data-shortcut="0"/>
76+
<button type="button" class="button_first_chunk" data-shortcut="1"/>
77+
<button type="button" class="button_prev_file" data-shortcut="["/>
78+
<button type="button" class="button_next_file" data-shortcut="]"/>
79+
<button type="button" class="button_to_index" data-shortcut="u"/>
80+
<button type="button" class="button_show_hide_help" data-shortcut="?"/>
81+
</aside>
5982
</div>
6083
</header>
6184
<main id="source">
@@ -72,8 +95,12 @@ <h2>
7295
<footer>
7396
<div class="content">
7497
<p>
75-
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.3.3</a>,
76-
created at 2022-05-12 19:35 -0400
98+
<a id="prevFileLink" class="nav" href="index.html">&#xab; prev</a> &nbsp; &nbsp;
99+
<a id="indexLink" class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
100+
<a id="nextFileLink" class="nav" href="d_7b071bdc2a35fa80___main___py.html">&#xbb; next</a>
101+
&nbsp; &nbsp; &nbsp;
102+
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.4</a>,
103+
created at 2022-05-22 18:22 -0400
77104
</p>
78105
</div>
79106
</footer>

‎doc/sample_html/d_7b071bdc2a35fa80___main___py.html

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
<html>
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5-
<meta http-equiv="X-UA-Compatible" content="IE=emulateIE7" />
65
<title>Coverage for cogapp/__main__.py: 0.00%</title>
76
<link rel="icon" sizes="32x32" href="favicon_32.png">
87
<link rel="stylesheet" href="style.css" type="text/css">
@@ -15,47 +14,71 @@ <h1>
1514
<span class="text">Coverage for </span><b>cogapp/__main__.py</b>:
1615
<span class="pc_cov">0.00%</span>
1716
</h1>
18-
<div id="help_panel_wrapper">
17+
<aside id="help_panel_wrapper">
1918
<input id="help_panel_state" type="checkbox">
2019
<label for="help_panel_state">
2120
<img id="keyboard_icon" src="keybd_closed.png" alt="Show/hide keyboard shortcuts" />
2221
</label>
2322
<div id="help_panel">
2423
<p class="legend">Shortcuts on this page</p>
25-
<div>
26-
<p class="keyhelp">
24+
<div class="keyhelp">
25+
<p>
2726
<kbd>r</kbd>
2827
<kbd>m</kbd>
2928
<kbd>x</kbd>
3029
<kbd>p</kbd>
3130
&nbsp; toggle line displays
3231
</p>
33-
<p class="keyhelp">
32+
<p>
3433
<kbd>j</kbd>
35-
<kbd>k</kbd> &nbsp; next/prev highlighted chunk
34+
<kbd>k</kbd>
35+
&nbsp; next/prev highlighted chunk
3636
</p>
37-
<p class="keyhelp">
37+
<p>
3838
<kbd>0</kbd> &nbsp; (zero) top of page
3939
</p>
40-
<p class="keyhelp">
40+
<p>
4141
<kbd>1</kbd> &nbsp; (one) first highlighted chunk
4242
</p>
43+
<p>
44+
<kbd>[</kbd>
45+
<kbd>]</kbd>
46+
&nbsp; prev/next file
47+
</p>
48+
<p>
49+
<kbd>u</kbd> &nbsp; up to the index
50+
</p>
51+
<p>
52+
<kbd>?</kbd> &nbsp; show/hide this help
53+
</p>
4354
</div>
4455
</div>
45-
</div>
56+
</aside>
4657
<h2>
4758
<span class="text">3 statements &nbsp;</span>
4859
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">0<span class="text"> run</span></button>
4960
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">3<span class="text"> missing</span></button>
5061
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
5162
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">0<span class="text"> partial</span></button>
5263
</h2>
53-
<div style="display: none;">
54-
<button type="button" class="button_next_chunk" data-shortcut="j">Next highlighted chunk</button>
55-
<button type="button" class="button_prev_chunk" data-shortcut="k">Previous highlighted chunk</button>
56-
<button type="button" class="button_top_of_page" data-shortcut="0">Goto top of page</button>
57-
<button type="button" class="button_first_chunk" data-shortcut="1">Goto first highlighted chunk</button>
58-
</div>
64+
<p class="text">
65+
<a id="prevFileLink" class="nav" href="d_7b071bdc2a35fa80___init___py.html">&#xab; prev</a> &nbsp; &nbsp;
66+
<a id="indexLink" class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
67+
<a id="nextFileLink" class="nav" href="d_7b071bdc2a35fa80_backward_py.html">&#xbb; next</a>
68+
&nbsp; &nbsp; &nbsp;
69+
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.4</a>,
70+
created at 2022-05-22 18:22 -0400
71+
</p>
72+
<aside class="hidden">
73+
<button type="button" class="button_next_chunk" data-shortcut="j"/>
74+
<button type="button" class="button_prev_chunk" data-shortcut="k"/>
75+
<button type="button" class="button_top_of_page" data-shortcut="0"/>
76+
<button type="button" class="button_first_chunk" data-shortcut="1"/>
77+
<button type="button" class="button_prev_file" data-shortcut="["/>
78+
<button type="button" class="button_next_file" data-shortcut="]"/>
79+
<button type="button" class="button_to_index" data-shortcut="u"/>
80+
<button type="button" class="button_show_hide_help" data-shortcut="?"/>
81+
</aside>
5982
</div>
6083
</header>
6184
<main id="source">
@@ -68,8 +91,12 @@ <h2>
6891
<footer>
6992
<div class="content">
7093
<p>
71-
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.3.3</a>,
72-
created at 2022-05-12 19:35 -0400
94+
<a id="prevFileLink" class="nav" href="d_7b071bdc2a35fa80___init___py.html">&#xab; prev</a> &nbsp; &nbsp;
95+
<a id="indexLink" class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
96+
<a id="nextFileLink" class="nav" href="d_7b071bdc2a35fa80_backward_py.html">&#xbb; next</a>
97+
&nbsp; &nbsp; &nbsp;
98+
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.4</a>,
99+
created at 2022-05-22 18:22 -0400
73100
</p>
74101
</div>
75102
</footer>

0 commit comments

Comments
 (0)