coverage 7.6.7__cp311-cp311-win_amd64.whl → 7.11.1__cp311-cp311-win_amd64.whl

coverage/html.py

@@ -13,26 +13,30 @@ import json
 import os
 import re
 import string
-
-from dataclasses import dataclass, field
-from typing import Any, TYPE_CHECKING
 from collections.abc import Iterable
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, Any
 
 import coverage
 from coverage.data import CoverageData, add_data_to_hash
 from coverage.exceptions import NoDataError
 from coverage.files import flat_rootname
 from coverage.misc import (
-    ensure_dir, file_be_gone, Hasher, isolate_module, format_local_datetime,
-    human_sorted, plural, stdout_link,
+    Hasher,
+    ensure_dir,
+    file_be_gone,
+    format_local_datetime,
+    human_sorted,
+    isolate_module,
+    plural,
+    stdout_link,
 )
 from coverage.report_core import get_analysis_to_report
-from coverage.results import Analysis, Numbers
+from coverage.results import Analysis, AnalysisNarrower, Numbers
 from coverage.templite import Templite
 from coverage.types import TLineNo, TMorf
 from coverage.version import __url__
 
-
 if TYPE_CHECKING:
     from coverage import Coverage
     from coverage.plugins import FileReporter
@@ -42,8 +46,7 @@ os = isolate_module(os)
 
 
 def data_filename(fname: str) -> str:
-    """Return the path to an "htmlfiles" data file of ours.
-    """
+    """Return the path to an "htmlfiles" data file of ours."""
     static_dir = os.path.join(os.path.dirname(__file__), "htmlfiles")
     static_filename = os.path.join(static_dir, fname)
     return static_filename
@@ -51,7 +54,7 @@ def data_filename(fname: str) -> str:
 
 def read_data(fname: str) -> str:
     """Return the contents of a data file of ours."""
-    with open(data_filename(fname)) as data_file:
+    with open(data_filename(fname), encoding="utf-8") as data_file:
         return data_file.read()
 
 
@@ -65,6 +68,7 @@ def write_html(fname: str, html: str) -> None:
 @dataclass
 class LineData:
     """The data for each source line of HTML output."""
+
     tokens: list[tuple[str, str]]
     number: TLineNo
     category: str
@@ -83,6 +87,7 @@ class LineData:
 @dataclass
 class FileData:
     """The data for each source file of HTML output."""
+
     relative_filename: str
     nums: Numbers
     lines: list[LineData]
@@ -91,6 +96,7 @@ class FileData:
 @dataclass
 class IndexItem:
     """Information for each index entry, to render an index page."""
+
     url: str = ""
     file: str = ""
     description: str = ""
@@ -100,6 +106,7 @@ class IndexItem:
 @dataclass
 class IndexPage:
     """Data for each index page."""
+
     noun: str
     plural: str
     filename: str
@@ -137,10 +144,14 @@ class HtmlDataGeneration:
             contexts_by_lineno = self.data.contexts_by_lineno(analysis.filename)
 
         lines = []
+        branch_stats = analysis.branch_stats()
+        multiline_map = {}
+        if hasattr(fr, "multiline_map"):
+            multiline_map = fr.multiline_map()
 
         for lineno, tokens in enumerate(fr.source_token_lines(), start=1):
             # Figure out how to mark this line.
-            category = ""
+            category = category2 = ""
             short_annotations = []
             long_annotations = []
 
@@ -150,14 +161,36 @@ class HtmlDataGeneration:
                 category = "mis"
             elif self.has_arcs and lineno in missing_branch_arcs:
                 category = "par"
-                for b in missing_branch_arcs[lineno]:
-                    if b < 0:
-                        short_annotations.append("exit")
-                    else:
-                        short_annotations.append(str(b))
-                    long_annotations.append(fr.missing_arc_description(lineno, b, arcs_executed))
+                mba = missing_branch_arcs[lineno]
+                if len(mba) == branch_stats[lineno][0]:
+                    # None of the branches were taken from this line.
+                    short_annotations.append("anywhere")
+                    long_annotations.append(
+                        f"line {lineno} didn't jump anywhere: it always raised an exception."
+                    )
+                else:
+                    for b in missing_branch_arcs[lineno]:
+                        if b < 0:
+                            short_annotations.append("exit")
+                        else:
+                            short_annotations.append(str(b))
+                        long_annotations.append(
+                            fr.missing_arc_description(lineno, b, arcs_executed)
+                        )
             elif lineno in analysis.statements:
                 category = "run"
+            elif first_line := multiline_map.get(lineno):
+                if first_line in analysis.excluded:
+                    category2 = "exc2"
+                elif first_line in analysis.missing:
+                    category2 = "mis2"
+                elif self.has_arcs and first_line in missing_branch_arcs:
+                    category2 = "par2"
+                # I don't understand why this last condition is marked as
+                # partial.  If I add an else with an exception, the exception
+                # is raised.
+                elif first_line in analysis.statements:  # pragma: part covered
+                    category2 = "run2"
 
             contexts = []
             contexts_label = ""
@@ -170,16 +203,18 @@ class HtmlDataGeneration:
                     contexts_label = f"{len(contexts)} ctx"
                     context_list = contexts
 
-            lines.append(LineData(
-                tokens=tokens,
-                number=lineno,
-                category=category,
-                contexts=contexts,
-                contexts_label=contexts_label,
-                context_list=context_list,
-                short_annotations=short_annotations,
-                long_annotations=long_annotations,
-            ))
+            lines.append(
+                LineData(
+                    tokens=tokens,
+                    number=lineno,
+                    category=category or category2,
+                    contexts=contexts,
+                    contexts_label=contexts_label,
+                    context_list=context_list,
+                    short_annotations=short_annotations,
+                    long_annotations=long_annotations,
+                )
+            )
 
         file_data = FileData(
             relative_filename=fr.relative_filename(),
@@ -192,6 +227,7 @@ class HtmlDataGeneration:
 
 class FileToReport:
     """A file we're considering reporting."""
+
     def __init__(self, fr: FileReporter, analysis: Analysis) -> None:
         self.fr = fr
         self.analysis = analysis
@@ -202,6 +238,7 @@ class FileToReport:
 
 HTML_SAFE = string.ascii_letters + string.digits + "!#$%'()*+,-./:;=?@[]^_`{|}~"
 
+
 @functools.cache
 def encode_int(n: int) -> str:
     """Create a short HTML-safe string from an integer, using HTML_SAFE."""
@@ -277,7 +314,6 @@ class HtmlReporter:
             "escape": escape,
             "pair": pair,
             "len": len,
-
             # Constants for this report.
             "__url__": __url__,
             "__version__": coverage.__version__,
@@ -287,7 +323,6 @@ class HtmlReporter:
             "has_arcs": self.has_arcs,
             "show_contexts": self.config.show_contexts,
             "statics": {},
-
             # Constants for all reports.
             # These css classes determine which lines are highlighted by default.
             "category": {
@@ -295,6 +330,10 @@ class HtmlReporter:
                 "mis": "mis show_mis",
                 "par": "par run show_par",
                 "run": "run",
+                "exc2": "exc exc2 show_exc",
+                "mis2": "mis mis2 show_mis",
+                "par2": "par par2 ru2 show_par",
+                "run2": "run run2",
             },
         }
         self.index_tmpl = Templite(read_data("index.html"), self.template_globals)
@@ -383,7 +422,7 @@ class HtmlReporter:
         dest = copy_with_cache_bust(src, self.directory)
         if not slug:
             slug = os.path.basename(src).replace(".", "_")
-        self.template_globals["statics"][slug] = dest # type: ignore
+        self.template_globals["statics"][slug] = dest  # type: ignore
 
     def make_local_static_report_files(self) -> None:
         """Make local instances of static files for HTML report."""
@@ -401,7 +440,7 @@ class HtmlReporter:
         # .gitignore can't be copied from the source tree because if it was in
         # the source tree, it would stop the static files from being checked in.
         if self.directory_was_empty:
-            with open(os.path.join(self.directory, ".gitignore"), "w") as fgi:
+            with open(os.path.join(self.directory, ".gitignore"), "w", encoding="utf-8") as fgi:
                 fgi.write("# Created by coverage.py\n*\n")
 
     def should_report(self, analysis: Analysis, index_page: IndexPage) -> bool:
@@ -412,8 +451,8 @@ class HtmlReporter:
 
         if self.skip_covered:
             # Don't report on 100% files.
-            no_missing_lines = (nums.n_missing == 0)
-            no_missing_branches = (nums.n_partial_branches == 0)
+            no_missing_lines = (nums.n_missing == 0)  # fmt: skip
+            no_missing_branches = (nums.n_partial_branches == 0)  # fmt: skip
             if no_missing_lines and no_missing_branches:
                 index_page.skipped_covered_count += 1
                 return False
@@ -467,9 +506,8 @@ class HtmlReporter:
                     encode_int(context_codes[c_context]) for c_context in ldata.context_list
                 ]
                 code_width = max(len(ec) for ec in encoded_contexts)
-                ldata.context_str = (
-                    str(code_width)
-                    + "".join(ec.ljust(code_width) for ec in encoded_contexts)
+                ldata.context_str = str(code_width) + "".join(
+                    ec.ljust(code_width) for ec in encoded_contexts
                 )
             else:
                 ldata.context_str = ""
@@ -478,48 +516,45 @@ class HtmlReporter:
                 # 202F is NARROW NO-BREAK SPACE.
                 # 219B is RIGHTWARDS ARROW WITH STROKE.
                 ldata.annotate = ",&nbsp;&nbsp; ".join(
-                    f"{ldata.number}&#x202F;&#x219B;&#x202F;{d}"
-                    for d in ldata.short_annotations
+                    f"{ldata.number}&#x202F;&#x219B;&#x202F;{d}" for d in ldata.short_annotations
                 )
             else:
                 ldata.annotate = None
 
             if ldata.long_annotations:
                 longs = ldata.long_annotations
-                if len(longs) == 1:
-                    ldata.annotate_long = longs[0]
-                else:
-                    ldata.annotate_long = "{:d} missed branches: {}".format(
-                        len(longs),
-                        ", ".join(
-                            f"{num:d}) {ann_long}"
-                            for num, ann_long in enumerate(longs, start=1)
-                        ),
-                    )
+                # A line can only have two branch destinations. If there were
+                # two missing, we would have written one as "always raised."
+                assert len(longs) == 1, (
+                    f"Had long annotations in {ftr.fr.relative_filename()}: {longs}"
+                )
+                ldata.annotate_long = longs[0]
             else:
                 ldata.annotate_long = None
 
             css_classes = []
             if ldata.category:
                 css_classes.append(
-                    self.template_globals["category"][ldata.category],   # type: ignore[index]
+                    self.template_globals["category"][ldata.category],  # type: ignore[index]
                 )
             ldata.css_class = " ".join(css_classes) or "pln"
 
         html_path = os.path.join(self.directory, ftr.html_filename)
-        html = self.source_tmpl.render({
-            **file_data.__dict__,
-            "contexts_json": contexts_json,
-            "prev_html": ftr.prev_html,
-            "next_html": ftr.next_html,
-        })
+        html = self.source_tmpl.render(
+            {
+                **file_data.__dict__,
+                "contexts_json": contexts_json,
+                "prev_html": ftr.prev_html,
+                "next_html": ftr.next_html,
+            }
+        )
         write_html(html_path, html)
 
         # Save this file's information for the index page.
         index_info = IndexItem(
-            url = ftr.html_filename,
-            file = escape(ftr.fr.relative_filename()),
-            nums = ftr.analysis.numbers,
+            url=ftr.html_filename,
+            file=escape(ftr.fr.relative_filename()),
+            nums=ftr.analysis.numbers,
         )
         self.index_pages["file"].summaries.append(index_info)
         self.incr.set_index_info(ftr.rootname, index_info)
@@ -547,39 +582,51 @@ class HtmlReporter:
 
             for noun in region_nouns:
                 page_data = self.index_pages[noun]
-                outside_lines = set(range(1, num_lines + 1))
 
+                outside_lines = set(range(1, num_lines + 1))
                 for region in regions:
                     if region.kind != noun:
                         continue
                     outside_lines -= region.lines
-                    analysis = ftr.analysis.narrow(region.lines)
+
+                narrower = AnalysisNarrower(ftr.analysis)
+                narrower.add_regions(r.lines for r in regions if r.kind == noun)
+                narrower.add_regions([outside_lines])
+
+                for region in regions:
+                    if region.kind != noun:
+                        continue
+                    analysis = narrower.narrow(region.lines)
                     if not self.should_report(analysis, page_data):
                         continue
                     sorting_name = region.name.rpartition(".")[-1].lstrip("_")
-                    page_data.summaries.append(IndexItem(
-                        url=f"{ftr.html_filename}#t{region.start}",
-                        file=escape(ftr.fr.relative_filename()),
-                        description=(
-                            f"<data value='{escape(sorting_name)}'>"
-                            + escape(region.name)
-                            + "</data>"
-                        ),
-                        nums=analysis.numbers,
-                    ))
-
-                analysis = ftr.analysis.narrow(outside_lines)
+                    page_data.summaries.append(
+                        IndexItem(
+                            url=f"{ftr.html_filename}#t{region.start}",
+                            file=escape(ftr.fr.relative_filename()),
+                            description=(
+                                f"<data value='{escape(sorting_name)}'>"
+                                + escape(region.name)
+                                + "</data>"
+                            ),
+                            nums=analysis.numbers,
+                        )
+                    )
+
+                analysis = narrower.narrow(outside_lines)
                 if self.should_report(analysis, page_data):
-                    page_data.summaries.append(IndexItem(
-                        url=ftr.html_filename,
-                        file=escape(ftr.fr.relative_filename()),
-                        description=(
-                            "<data value=''>"
-                            + f"<span class='no-noun'>(no {escape(noun)})</span>"
-                            + "</data>"
-                        ),
-                        nums=analysis.numbers,
-                    ))
+                    page_data.summaries.append(
+                        IndexItem(
+                            url=ftr.html_filename,
+                            file=escape(ftr.fr.relative_filename()),
+                            description=(
+                                "<data value=''>"
+                                + f"<span class='no-noun'>(no {escape(noun)})</span>"
+                                + "</data>"
+                            ),
+                            nums=analysis.numbers,
+                        )
+                    )
 
         for noun, index_page in self.index_pages.items():
             if noun != "file":
@@ -629,6 +676,7 @@ class HtmlReporter:
 @dataclass
 class FileInfo:
     """Summary of the information from last rendering, to avoid duplicate work."""
+
     hash: str = ""
     index: IndexItem = field(default_factory=IndexItem)
 
@@ -699,7 +747,7 @@ class IncrementalChecker:
         """Read the information we stored last time."""
         try:
             status_file = os.path.join(self.directory, self.STATUS_FILE)
-            with open(status_file) as fstatus:
+            with open(status_file, encoding="utf-8") as fstatus:
                 status = json.load(fstatus)
         except (OSError, ValueError):
             # Status file is missing or malformed.
@@ -735,12 +783,9 @@ class IncrementalChecker:
             "format": self.STATUS_FORMAT,
             "version": coverage.__version__,
             "globals": self.globals,
-            "files": {
-                fname: dataclasses.asdict(finfo)
-                for fname, finfo in self.files.items()
-            },
+            "files": {fname: dataclasses.asdict(finfo) for fname, finfo in self.files.items()},
         }
-        with open(status_file, "w") as fout:
+        with open(status_file, "w", encoding="utf-8") as fout:
             json.dump(status_data, fout, separators=(",", ":"))
 
     def check_global_data(self, *data: Any) -> None:
@@ -795,6 +840,7 @@ class IncrementalChecker:
 
 # Helpers for templates and generating HTML
 
+
 def escape(t: str) -> str:
     """HTML-escape the text in `t`.
 

coverage/htmlfiles/style.css

@@ -200,9 +200,9 @@ kbd { border: 1px solid black; border-color: #888 #333 #333 #888; padding: .1em
 
 #source p .t .key { font-weight: bold; line-height: 1px; }
 
-#source p .t .str { color: #0451a5; }
+#source p .t .str, #source p .t .fst { color: #0451a5; }
 
-@media (prefers-color-scheme: dark) { #source p .t .str { color: #9cdcfe; } }
+@media (prefers-color-scheme: dark) { #source p .t .str, #source p .t .fst { color: #9cdcfe; } }
 
 #source p.mis .t { border-left: 0.2em solid #ff0000; }
 
@@ -214,6 +214,16 @@ kbd { border: 1px solid black; border-color: #888 #333 #333 #888; padding: .1em
 
 @media (prefers-color-scheme: dark) { #source p.mis.show_mis .t:hover { background: #532323; } }
 
+#source p.mis.mis2 .t { border-left: 0.2em dotted #ff0000; }
+
+#source p.mis.mis2.show_mis .t { background: #ffeeee; }
+
+@media (prefers-color-scheme: dark) { #source p.mis.mis2.show_mis .t { background: #351b1b; } }
+
+#source p.mis.mis2.show_mis .t:hover { background: #f2d2d2; }
+
+@media (prefers-color-scheme: dark) { #source p.mis.mis2.show_mis .t:hover { background: #532323; } }
+
 #source p.run .t { border-left: 0.2em solid #00dd00; }
 
 #source p.run.show_run .t { background: #dfd; }
@@ -224,6 +234,16 @@ kbd { border: 1px solid black; border-color: #888 #333 #333 #888; padding: .1em
 
 @media (prefers-color-scheme: dark) { #source p.run.show_run .t:hover { background: #404633; } }
 
+#source p.run.run2 .t { border-left: 0.2em dotted #00dd00; }
+
+#source p.run.run2.show_run .t { background: #eeffee; }
+
+@media (prefers-color-scheme: dark) { #source p.run.run2.show_run .t { background: #2b2e24; } }
+
+#source p.run.run2.show_run .t:hover { background: #d2f2d2; }
+
+@media (prefers-color-scheme: dark) { #source p.run.run2.show_run .t:hover { background: #404633; } }
+
 #source p.exc .t { border-left: 0.2em solid #808080; }
 
 #source p.exc.show_exc .t { background: #eee; }
@@ -234,6 +254,16 @@ kbd { border: 1px solid black; border-color: #888 #333 #333 #888; padding: .1em
 
 @media (prefers-color-scheme: dark) { #source p.exc.show_exc .t:hover { background: #3c3c3c; } }
 
+#source p.exc.exc2 .t { border-left: 0.2em dotted #808080; }
+
+#source p.exc.exc2.show_exc .t { background: #f7f7f7; }
+
+@media (prefers-color-scheme: dark) { #source p.exc.exc2.show_exc .t { background: #292929; } }
+
+#source p.exc.exc2.show_exc .t:hover { background: #e2e2e2; }
+
+@media (prefers-color-scheme: dark) { #source p.exc.exc2.show_exc .t:hover { background: #3c3c3c; } }
+
 #source p.par .t { border-left: 0.2em solid #bbbb00; }
 
 #source p.par.show_par .t { background: #ffa; }
@@ -244,6 +274,16 @@ kbd { border: 1px solid black; border-color: #888 #333 #333 #888; padding: .1em
 
 @media (prefers-color-scheme: dark) { #source p.par.show_par .t:hover { background: #6d5d0c; } }
 
+#source p.par.par2 .t { border-left: 0.2em dotted #bbbb00; }
+
+#source p.par.par2.show_par .t { background: #ffffd5; }
+
+@media (prefers-color-scheme: dark) { #source p.par.par2.show_par .t { background: #423a0f; } }
+
+#source p.par.par2.show_par .t:hover { background: #f2f2a2; }
+
+@media (prefers-color-scheme: dark) { #source p.par.par2.show_par .t:hover { background: #6d5d0c; } }
+
 #source p .r { position: absolute; top: 0; right: 2.5em; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; }
 
 #source p .annotate { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; color: #666; padding-right: .5em; }

coverage/htmlfiles/style.scss

@@ -27,6 +27,7 @@ $font-code:               SFMono-Regular, Menlo, Monaco, Consolas, monospace;
 
 $off-button-lighten:      50%;
 $hover-dark-amt:          95%;
+$multi-dim-amt:           50%;
 
 $focus-color:             #007acc;
 
@@ -501,7 +502,7 @@ $border-indicator-width: .2em;
                 font-weight: bold;
                 line-height: 1px;
             }
-            .str {
+            .str, .fst {
                 color: $light-token-str;
                 @include color-dark($dark-token-str);
             }
@@ -521,6 +522,22 @@ $border-indicator-width: .2em;
                     @include background-dark(mix($dark-mis-bg, $dark-fg, $hover-dark-amt));
                 }
             }
+
+            &.mis2 {
+                .t {
+                    border-left: $border-indicator-width dotted $mis-color;
+                }
+
+                &.show_mis .t {
+                    background: mix($light-mis-bg, $light-bg, $multi-dim-amt);
+                    @include background-dark(mix($dark-mis-bg, $dark-bg, $multi-dim-amt));
+
+                    &:hover {
+                        background: mix($light-mis-bg, $light-fg, $hover-dark-amt);
+                        @include background-dark(mix($dark-mis-bg, $dark-fg, $hover-dark-amt));
+                    }
+                }
+            }
         }
 
         &.run {
@@ -537,6 +554,22 @@ $border-indicator-width: .2em;
                     @include background-dark(mix($dark-run-bg, $dark-fg, $hover-dark-amt));
                 }
             }
+
+            &.run2 {
+                .t {
+                    border-left: $border-indicator-width dotted $run-color;
+                }
+
+                &.show_run .t {
+                    background: mix($light-run-bg, $light-bg, $multi-dim-amt);
+                    @include background-dark(mix($dark-run-bg, $dark-bg, $multi-dim-amt));
+
+                    &:hover {
+                        background: mix($light-run-bg, $light-fg, $hover-dark-amt);
+                        @include background-dark(mix($dark-run-bg, $dark-fg, $hover-dark-amt));
+                    }
+                }
+            }
         }
 
         &.exc {
@@ -553,6 +586,22 @@ $border-indicator-width: .2em;
                     @include background-dark(mix($dark-exc-bg, $dark-fg, $hover-dark-amt));
                 }
             }
+
+            &.exc2 {
+                .t {
+                    border-left: $border-indicator-width dotted $exc-color;
+                }
+
+                &.show_exc .t {
+                    background: mix($light-exc-bg, $light-bg, $multi-dim-amt);
+                    @include background-dark(mix($dark-exc-bg, $dark-bg, $multi-dim-amt));
+
+                    &:hover {
+                        background: mix($light-exc-bg, $light-fg, $hover-dark-amt);
+                        @include background-dark(mix($dark-exc-bg, $dark-fg, $hover-dark-amt));
+                    }
+                }
+            }
         }
 
         &.par {
@@ -570,6 +619,21 @@ $border-indicator-width: .2em;
                 }
             }
 
+            &.par2 {
+                .t {
+                    border-left: $border-indicator-width dotted $par-color;
+                }
+
+                &.show_par .t {
+                    background: mix($light-par-bg, $light-bg, $multi-dim-amt);
+                    @include background-dark(mix($dark-par-bg, $dark-bg, $multi-dim-amt));
+
+                    &:hover {
+                        background: mix($light-par-bg, $light-fg, $hover-dark-amt);
+                        @include background-dark(mix($dark-par-bg, $dark-fg, $hover-dark-amt));
+                    }
+                }
+            }
         }
 
         .r {