Add Statement and Branch coverage columns to index.html report #2085

Ryuta1005 · 2025-11-13T04:39:09Z

Summary

This PR adds two new columns — Statement Coverage and Branch Coverage — to the HTML coverage report layout.
These columns appear only when branch coverage is enabled (using the --branch option).
The goal is to provide a concrete basis for discussion in Issue #2081.
If these two columns are considered useful, this change could be merged as-is.

Changes

Added Statement Coverage and Branch Coverage columns to the main HTML index report (visible only when --branch is enabled).
No functional or behavioral changes to coverage calculation logic.
The excluded column remains unchanged for now (to be discussed in Issue Discussion: HTML coverage report layout (Statement/Branch columns and excluded column) #2081).

Preview

Before

After

Related Issue

Discussion base: #2081

…branches-metrics

Ryuta1005 · 2025-11-15T16:02:44Z

Note about the py314t / py315t CI jobs:

On macOS CI, both py314t and py315t are currently red due to failures in:

tests/test_concurrency.py::test_coverage_stop_in_threads

For example:

assert has_started_coverage == [t.ident]
E       assert [] == [6126907392]

and:

assert has_stopped_coverage == [t.ident]
E       assert [] == [6192033792]

This looks like a timing / threading issue specific to the free-threaded (nogil) builds and the tracer, rather than something caused by the HTML report changes in this PR.

Locally, I ran:

make test

with py313t, py314t, and py315t available via pyenv, and all test environments (including the t builds) passed:

py314t: OK (...)
py315t: OK (...)
congratulations :)

If it would be helpful, I’m happy to open a separate issue to track the test_coverage_stop_in_threads behavior on free-threaded builds, but I kept this PR focused on the HTML layout only.

nedbat · 2025-11-15T23:24:16Z

This looks like a timing / threading issue specific to the free-threaded (nogil) builds

Yes, those tests are usually ok, but occasionally fail. An improvement would be welcome if you know what to do about them.

coverage/results.py

nedbat · 2025-11-16T02:04:37Z

Can you add some testing in test_results.py? We don't need separate tests for each property, but they should be covered by some test in there.

nedbat · 2025-11-16T02:12:24Z

I like the way this is going. I'd like to work on the CSS styling once it lands.

…nts and ratio_branches

Ryuta1005 · 2025-11-16T05:48:41Z

Can you add some testing in test_results.py? We don't need separate tests for each property, but they should be covered by some test in there.

Added tests in this commit:46105c6

Ryuta1005 · 2025-11-16T05:57:45Z

I've addressed the feedback so far (naming + tests),
and the PR is now ready for further review.

I’ve also removed the draft status.

nedbat · 2025-11-16T11:03:29Z

Also, I wonder if we should add these new Results properties to the JSON report? I guess that could be a second PR.

Ryuta1005 · 2025-11-16T12:32:21Z

Thanks! Yes, I agree — adding these new Results properties to the JSON report would be useful.

Once this PR is merged, I can open a follow-up PR for the JSON report.

nedbat · 2025-11-16T13:19:15Z

coverage/results.py

        """Return numerator/denominator for branch coverage."""
        return self.n_executed_branches, self.n_branches

+    def _percent(self, numerator: int, denominator: int) -> float:


Great, this was what I was thinking.

nedbat · 2025-11-16T13:22:19Z

coverage/results.py

+        numerator, denominator = self.ratio_covered
+        if self.n_statements == 0:
+            return 100.0
+        return self._percent(numerator, denominator)


I think we can make this simpler because if n_statements is zero, so is the denominator:
return self._percent(*self.ratio_covered). The star syntax will also simplify the other two pc_* properties.

Thanks! Addressed in this commit: 8e88313

nedbat · 2025-11-16T13:34:41Z

coverage/htmlfiles/coverage_html.js

    const table_body_rows = table.querySelectorAll("tbody tr");
    const no_rows = document.getElementById("no_rows");

+    const header_row = table.tHead ? table.tHead.rows[table.tHead.rows.length - 1] : table.rows[0];


Why are we conditionalizing on tHead and tFoot? When won't the table have a head or a foot?

Thanks! I've removed the unnecessary conditionalizing as suggested.

…ex table

nedbat · 2025-11-16T20:49:40Z

Thanks for all this, I'll merge this and make some adjustments. Let me know what name I should use to credit you in the changelog and contributors files.

nedbat · 2025-11-16T21:42:41Z

After my styling tweaks it looks like this:

Ryuta1005 · 2025-11-16T23:15:40Z

Thank you so much!
It’s an honor to be included.

Please credit me as: Ryuta Otsuka.

nedbat · 2025-11-18T11:38:01Z

This is now released as part of coverage 7.12.0.

feat: add Statement and Branch coverage columns to index.html report

02c1236

Ryuta1005 mentioned this pull request Nov 13, 2025

Discussion: HTML coverage report layout (Statement/Branch columns and excluded column) #2081

Closed

Ryuta1005 and others added 2 commits November 15, 2025 23:10

Merge remote-tracking branch 'upstream/main' into feature/htmlreport-…

b248072

…branches-metrics

chore: update HTML gold files after layout changes

fdc6a86

nedbat reviewed Nov 16, 2025

View reviewed changes

coverage/results.py Outdated Show resolved Hide resolved

Ryuta1005 added 2 commits November 16, 2025 13:44

refactor: rename statements_ratio and branches_ratio to ratio_stateme…

1321a8c

…nts and ratio_branches

test: cover ratio_statements and ratio_branches in Numbers tests

46105c6

Ryuta1005 changed the title ~~[Draft] Add Statement and Branch coverage columns to index.html report~~ Add Statement and Branch coverage columns to index.html report Nov 16, 2025

refactor: unify percent calculation in Numbers using a shared helper

d5706fe

nedbat reviewed Nov 16, 2025

View reviewed changes

refactor: simplify pc_ properties using argument unpacking*

8e88313

nedbat reviewed Nov 16, 2025

View reviewed changes

refactor: remove unnecessary tHead/tFoot conditionalizing in HTML ind…

28b9dff

…ex table

nedbat merged commit 4abe253 into coveragepy:main Nov 16, 2025
44 checks passed

nedbat added a commit that referenced this pull request Nov 16, 2025

style(html): tweak the styling for the new stmt/branch stats #2085

8320b74

nedbat added a commit that referenced this pull request Nov 16, 2025

docs: thanks, Ryuta Otsuka #2085

fff5e59

This was referenced Nov 17, 2025

Add Statement and Branch coverage fields to JSON report #2089

Closed

Add Statement and Branch coverage fields to JSON report #2090

Merged

github-actions bot mentioned this pull request Nov 19, 2025

Bump coverage from 7.11.3 to 7.12.0 senzing-garage/senzing-databricks#27

Merged

Uh oh!

Add Statement and Branch coverage columns to index.html report #2085

Add Statement and Branch coverage columns to index.html report #2085

Conversation

Ryuta1005 commented Nov 13, 2025

Summary

Changes

Preview

Before

After

Related Issue

Uh oh!

Ryuta1005 commented Nov 15, 2025

Uh oh!

nedbat commented Nov 15, 2025

Uh oh!

Uh oh!

nedbat commented Nov 16, 2025

Uh oh!

nedbat commented Nov 16, 2025

Uh oh!

Ryuta1005 commented Nov 16, 2025

Uh oh!

Ryuta1005 commented Nov 16, 2025

Uh oh!

nedbat commented Nov 16, 2025

Uh oh!

Ryuta1005 commented Nov 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nedbat Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

nedbat Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

Ryuta1005 Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

nedbat Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

Ryuta1005 Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

nedbat commented Nov 16, 2025

Uh oh!

Uh oh!

nedbat commented Nov 16, 2025

Uh oh!

Ryuta1005 commented Nov 16, 2025

Uh oh!

nedbat commented Nov 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Ryuta1005 commented Nov 16, 2025 •

edited

Loading