style/docs: finish and document #2142

nedbat · nedbat · commit fe9d227addd9 · 2026-03-08T16:34:48.000-04:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -23,8 +23,13 @@ upgrading your version of coverage.py.
 Unreleased
 ----------
 
-Nothing yet.
+- Fix: the markdown-formatted coverage report didn't fully escape special
+  characters in file paths (`issue 2141`_). This would be very unlikely to
+  cause a problem, but now it's done properly, thanks to `Ellie Ayla
+  <pull 2142_>`_.
 
+.. _issue 2141: https://github.com/coveragepy/coveragepy/issues/2141
+.. _pull 2142: https://github.com/coveragepy/coveragepy/pull/2142
 
 .. start-releases
 
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -84,6 +84,7 @@ Edgar Ramírez Mondragón
 Eduardo Schettino
 Edward Loper
 Eli Skeggs
+Ellie Ayla
 Emil Madsen
 Éric Larivière
 Federico Bond
diff --git a/coverage/report.py b/coverage/report.py
@@ -5,9 +5,9 @@
 
 from __future__ import annotations
 
+import string
 import sys
 from collections.abc import Iterable
-from string import punctuation
 from typing import IO, TYPE_CHECKING, Any
 
 from coverage.exceptions import ConfigError, NoDataError
@@ -20,14 +20,14 @@
 if TYPE_CHECKING:
     from coverage import Coverage
 
-ESCAPE_PUNCTUATION_TABLE = "".maketrans(
-    {char: f"\\{char}" for char in punctuation if char not in ".,/-"}
+MARKDOWN_ESCAPES = str.maketrans(
+    {char: f"\\{char}" for char in string.punctuation if char not in ".,/-"}
 )
 
 
 def escape_markdown(text: str) -> str:
     """Prefix all characters meaningful in markdown tables with backslashes."""
-    return text.translate(ESCAPE_PUNCTUATION_TABLE)
+    return text.translate(MARKDOWN_ESCAPES)
 
 
 class SummaryReporter:
diff --git a/tests/coveragetest.py b/tests/coveragetest.py
@@ -126,7 +126,11 @@ def start_import_stop(
         return mod
 
     def get_report(
-        self, cov: Coverage, squeeze: bool = True, output_format: str | None = None, **kwargs: Any
+        self,
+        cov: Coverage,
+        squeeze: bool = True,
+        output_format: str | None = None,
+        **kwargs: Any,
     ) -> str:
         """Get the report from `cov`, and canonicalize it."""
         repout = io.StringIO()
diff --git a/tests/test_report.py b/tests/test_report.py
@@ -905,7 +905,7 @@ def test_report_with_chdir(self) -> None:
                 id="cross-platform-punctuation",
             ),
             pytest.param(
-                "\\",  # seperate only to make test failure messages easy to read
+                "\\",  # separate only to make test failure messages easy to read
                 set("\\"),
                 "/",  # munged to forward slash by get_report
                 id="backslash-untouched",
