Support .coveragerc.toml for configuration

CHANGES.rst

@@ -45,6 +45,9 @@ Version 7.10.7 — 2025-09-21
   LCOV reports could take far too long due to some quadratic behavior when
   creating the function and class index pages.  This is now fixed, closing
   `issue 2048`_.  Thanks to Daniel Diniz for help diagnosing the problem.
+- New feature: coverage.py now supports :file:`.coveragerc.toml` configuration files.
+  These files use TOML syntax and take priority over :file:`pyproject.toml` but lower
+  priority than :file:`.coveragerc` files.
 
 - Most warnings and a few errors now have links to a page in the docs
   explaining the specific message.  Closes `issue 1921`_.

CONTRIBUTORS.txt

@@ -187,6 +187,7 @@ Nils Kattenbeck
 Noel O'Boyle
 Oleg Höfling
 Oleh Krehel
+Olena Yefymenko
 Olivier Grisel
 Ori Avtalion
 Pablo Carballo

coverage/config.py

@@ -644,6 +644,7 @@ def config_files_to_try(config_file: bool | str) -> list[tuple[str, bool, bool]]
     assert isinstance(config_file, str)
     files_to_try = [
         (config_file, True, specified_file),
+        (".coveragerc.toml", True, False),
         ("setup.cfg", False, False),
         ("tox.ini", False, False),
         ("pyproject.toml", False, False),

doc/cog_helpers.py

@@ -93,7 +93,7 @@ def show_configs(ini, toml):
     print(".. tabs::\n")
     for name, syntax, text in [
         (".coveragerc", "ini", ini),
-        ("pyproject.toml", "toml", toml),
+        (".coveragerc.toml or pyproject.toml", "toml", toml),
         ("setup.cfg or tox.ini", "ini", ini2),
     ]:
         print(f"    .. code-tab:: {syntax}")

doc/config.rst

@@ -39,7 +39,7 @@ environment variable.
 
 If ``.coveragerc`` doesn't exist and another file hasn't been specified, then
 coverage.py will look for settings in other common configuration files, in this
-order: setup.cfg, tox.ini, or pyproject.toml.  The first file found with
+order: :file:`.coveragerc.toml`, :file:`setup.cfg`, :file:`tox.ini`, or :file:`pyproject.toml`.  The first file found with
 coverage.py settings will be used and other files won't be consulted.
 
 Coverage.py will read from "pyproject.toml" if TOML support is available,
@@ -199,7 +199,7 @@ Here's a sample configuration file, in each syntax:
         directory = coverage_html_report
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.run]
         branch = true
@@ -257,7 +257,7 @@ Here's a sample configuration file, in each syntax:
         [coverage:html]
         directory = coverage_html_report
 
-.. [[[end]]] (sum: HU1Z62mvRK)
+.. [[[end]]] (sum: FvgoIIyfXR)
 
 
 The specific configuration settings are described below.  Many sections and
@@ -598,7 +598,7 @@ equivalent when combining data from different machines:
             c:\myproj\src
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.paths]
         source = [
@@ -616,7 +616,7 @@ equivalent when combining data from different machines:
             /jenkins/build/*/src
             c:\myproj\src
 
-.. [[[end]]] (sum: oHSl8SGiMT)
+.. [[[end]]] (sum: bV+PjKu+HS)
 
 
 The names of the entries ("source" in this example) are ignored, you may choose

doc/contexts.rst

@@ -97,7 +97,7 @@ The ``[run] dynamic_context`` setting has only one option now.  Set it to
         dynamic_context = test_function
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.run]
         dynamic_context = "test_function"
@@ -108,7 +108,7 @@ The ``[run] dynamic_context`` setting has only one option now.  Set it to
         [coverage:run]
         dynamic_context = test_function
 
-.. [[[end]]] (sum: dZTDYjHw71)
+.. [[[end]]] (sum: Hn9VZdxp00)
 
 Each test function you run will be considered a separate dynamic context, and
 coverage data will be segregated for each.  A test function is any function

doc/excluding.rst

@@ -145,7 +145,7 @@ all of them by adding a regex to the exclusion list:
             def __repr__
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.report]
         exclude_also = [
@@ -159,7 +159,7 @@ all of them by adding a regex to the exclusion list:
         exclude_also =
             def __repr__
 
-.. [[[end]]] (sum: 8+cOvxKPvv)
+.. [[[end]]] (sum: QqurBI2O5i)
 
 For example, here's a list of exclusions I've used:
 
@@ -216,7 +216,7 @@ For example, here's a list of exclusions I've used:
             @(abc\.)?abstractmethod
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.report]
         exclude_also = [
@@ -248,7 +248,7 @@ For example, here's a list of exclusions I've used:
             class .*\bProtocol\):
             @(abc\.)?abstractmethod
 
-.. [[[end]]] (sum: ZQsgnt0nES)
+.. [[[end]]] (sum: z5MhXz2dFm)
 
 The :ref:`config_report_exclude_also` option adds regexes to the built-in
 default list so that you can add your own exclusions.  The older
@@ -319,7 +319,7 @@ Here are some examples:
             \A(?s:.*# pragma: exclude file.*)\Z
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.report]
         exclude_also = [
@@ -343,7 +343,7 @@ Here are some examples:
             ; 3. A pragma comment that excludes an entire file:
             \A(?s:.*# pragma: exclude file.*)\Z
 
-.. [[[end]]] (sum: xG6Bmtmh06)
+.. [[[end]]] (sum: 3EupeurnDP)
 
 The first regex matches a specific except line followed by a specific function
 call.  Both lines must be present for the exclusion to take effect. Note that

doc/messages.rst

@@ -187,7 +187,7 @@ file:
         disable_warnings = no-data-collected
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.run]
         disable_warnings = ["no-data-collected"]
@@ -198,4 +198,4 @@ file:
         [coverage:run]
         disable_warnings = no-data-collected
 
-.. [[[end]]] (sum: SJKFvPoXO2)
+.. [[[end]]] (sum: lZkA6+wMrL)

doc/plugins.rst

@@ -72,7 +72,7 @@ a coverage.py plug-in called ``something.plugin``.
                something.plugin
 
        .. code-tab:: toml
-           :caption: pyproject.toml
+           :caption: .coveragerc.toml or pyproject.toml
 
            [tool.coverage.run]
            plugins = [ "something.plugin" ]
@@ -84,7 +84,7 @@ a coverage.py plug-in called ``something.plugin``.
            plugins =
                something.plugin
 
-   .. [[[end]]] (sum: boZjI9S8MZ)
+   .. [[[end]]] (sum: 7iXDMHhoLG)
 
 #. If the plug-in needs its own configuration, you can add those settings in
    the .coveragerc file in a section named for the plug-in:
@@ -114,7 +114,7 @@ a coverage.py plug-in called ``something.plugin``.
            option2 = abc.foo
 
        .. code-tab:: toml
-           :caption: pyproject.toml
+           :caption: .coveragerc.toml or pyproject.toml
 
            [tool.coverage.something.plugin]
            option1 = true
@@ -127,7 +127,7 @@ a coverage.py plug-in called ``something.plugin``.
            option1 = True
            option2 = abc.foo
 
-   .. [[[end]]] (sum: tpARXb5/bH)
+   .. [[[end]]] (sum: QeURQmX7B1)
 
    Check the documentation for the plug-in for details on the options it takes.
 

doc/source.rst

@@ -115,7 +115,7 @@ current directory:
             utils/tirefire.py
 
     .. code-tab:: toml
-        :caption: pyproject.toml
+        :caption: .coveragerc.toml or pyproject.toml
 
         [tool.coverage.run]
         omit = [
@@ -139,7 +139,7 @@ current directory:
             # omit this single file
             utils/tirefire.py
 
-.. [[[end]]] (sum: hK0nQ8wMeg)
+.. [[[end]]] (sum: 6pS//9tCe4)
 
 The ``source``, ``include``, and ``omit`` values all work together to determine
 the source that will be measured.