Support `.coveragerc.toml` for configuration #1952

OlenaYefymenko · 2025-04-15T23:38:00Z

This patch provides a new configuration — .coveragerc.toml . Considering that many projects have switched to toml configurations, this change offers a more flexible approach to manage coverage settings.

Resolves #1643

OlenaYefymenko · 2025-04-15T23:41:17Z

coverage/config.py

+        (".coveragerc.toml", True, False),
        ("setup.cfg", False, False),


Is the priority of the new config properly determined in the config_files_to_try function?

Looks good.

OlenaYefymenko · 2025-04-15T23:41:54Z

tests/test_config.py

+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.
+        self.make_file(filename, """\


Is the parameterization implemented appropriately, similar to pyproject.toml?

OlenaYefymenko · 2025-04-15T23:43:02Z

tests/test_config.py

+    def test_coveragerc_toml_priority(self) -> None:
+        """Test that .coveragerc.toml has priority over pyproject.toml."""


Is testing priority only over pyproject.toml in the test_coveragerc_toml_priority test sufficient?

OlenaYefymenko · 2025-04-15T23:48:44Z

@nedbat,
I've opened PR with the improvements, but I have a few doubts about my implementation. I've added comments in the code. I'd really appreciate your feedback on whether this approach works well.
Thank you!

nedbat

One change needed.

nedbat · 2025-04-16T11:17:38Z

coverage/config.py

+        (".coveragerc.toml", True, False),
        ("setup.cfg", False, False),


Looks good.

nedbat · 2025-04-16T11:17:57Z

tests/test_config.py

+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.
+        self.make_file(filename, """\


nedbat · 2025-04-16T11:18:37Z

tests/test_config.py

+    def test_coveragerc_toml_priority(self) -> None:
+        """Test that .coveragerc.toml has priority over pyproject.toml."""


nedbat · 2025-04-16T11:19:00Z

tests/test_config.py

            # A toml file!
            [tool.coverage]
            run.parallel = true
            """)
        with mock.patch.object(coverage.tomlconfig, "has_tomllib", False):
-            msg = "Can't read 'pyproject.toml' without TOML support"
+            msg = "Can't read '{filename}' without TOML support"


Looks like tests are failing because this needs to be an f-string.

Thank you. I will fix this error in the next commits. I run tox with version 3.12 locally, and I didn't see this error.

nedbat · 2025-04-16T11:20:12Z

Thanks for doing this. There are some other changes needed. Let me know which you want to do, and which I should do:

Update the documentation
Add an entry to CHANGES.rst
Add your name to CONTRIBUTORS.txt

OlenaYefymenko · 2025-04-17T22:32:36Z

Thanks for doing this. There are some other changes needed. Let me know which you want to do, and which I should do:

Update the documentation

Add an entry to CHANGES.rst

Add your name to CONTRIBUTORS.txt

Yes, I will add the changes

tests/test_config.py

doc/config.rst

webknjaz

Plz revert all the formatting changes. I marked some, find the rest.

doc/config.rst

tests/test_config.py

This patch provides a new configuration option for coverage.py. Considering that many projects have switched to toml configurations, this change offers a more flexible approach to manage coverage settings.

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

Adds a new test to verify behavior when TOML support is unavailable.

list for new `.coveragerc.toml` configuration file support.

… docs

webknjaz · 2025-09-01T23:12:47Z

CHANGES.rst

+.. _pull 1952: https://github.com/nedbat/coveragepy/pull/1952
+
+
+.. start-releases


Invalid conflict resolution?

webknjaz · 2025-09-01T23:13:25Z

doc/config.rst

@@ -136,6 +139,7 @@ Here's a sample configuration file, in each syntax:
            [html]
            directory = coverage_html_report
            """,
+


Stray edit?

webknjaz · 2025-09-01T23:15:10Z

tests/test_config.py

-            """\
+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename: str) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.


Suggested change

# A pyproject.toml and coveragerc.toml will be read into the configuration.

# A pyproject.toml and .coveragerc.toml will be read into the configuration.

webknjaz · 2025-09-01T23:16:04Z

tests/test_config.py

-    def test_toml_parse_errors(self, bad_config: str, msg: str) -> None:
+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    @pytest.mark.parametrize("bad_config, msg", [
+        ("[tool.coverage.run]\ntimid = \"maybe?\"\n", r"maybe[?]"),


A lot of reformatting?

webknjaz · 2025-09-01T23:16:28Z

tests/test_config.py

@@ -458,7 +443,7 @@ def expanduser(s: str) -> str:
        assert cov.config.lcov_output == "/Users/me/lcov/~foo.lcov"
        assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
        assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
-        assert cov.config.paths == {"mapping": ["/Users/me/src", "/Users/joe/source"]}
+        assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']}


webknjaz · 2025-09-01T23:17:30Z

tests/test_config.py

-        self.make_file(
-            "pyproject.toml",
-            """\
+        self.make_file("pyproject.toml", """\


webknjaz · 2025-09-01T23:17:44Z

tests/test_config.py


-class SerializeConfigTest(CoverageTest):


OlenaYefymenko commented Apr 15, 2025

View reviewed changes

nedbat changed the title ~~🌐 Support .coveragerc.toml for configuration~~ Support .coveragerc.toml for configuration Apr 16, 2025

nedbat requested changes Apr 16, 2025

View reviewed changes

webknjaz reviewed Apr 18, 2025

View reviewed changes

tests/test_config.py Outdated Show resolved Hide resolved

tests/test_config.py Outdated Show resolved Hide resolved

Elenore23 approved these changes May 7, 2025

View reviewed changes

OlenaYefymenko marked this pull request as draft May 7, 2025 21:32

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 4018790 to 673b0c0 Compare June 15, 2025 23:16

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 673b0c0 to c584e0d Compare July 20, 2025 13:52

OlenaYefymenko commented Jul 20, 2025

View reviewed changes

doc/config.rst Outdated Show resolved Hide resolved

webknjaz reviewed Aug 18, 2025

View reviewed changes

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 6bee75f to 7565729 Compare August 18, 2025 22:17

OlenaYefymenko and others added 8 commits September 1, 2025 01:06

Support .coveragerc.toml for configuration

21b5748

This patch provides a new configuration option for coverage.py. Considering that many projects have switched to toml configurations, this change offers a more flexible approach to manage coverage settings.

Add f-string for error message

d8be467

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

This patch parametrizes tests for configuration files.

40608ea

Adds a new test to verify behavior when TOML support is unavailable.

Fix linter issues

74fcd88

Update documentation, changelog, and contributors

020cf77

list for new `.coveragerc.toml` configuration file support.

Add the new config parameter for show_configs function and update the…

7619dfd

… docs

Make the formatting changes

b66b7bf

Resolve doc8 line length violations in documentation

2558209

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 7565729 to 2558209 Compare August 31, 2025 22:19

webknjaz reviewed Sep 1, 2025

View reviewed changes

webknjaz mentioned this pull request Sep 16, 2025

A bunch of CTracer selection (and other) tests fail on Fedora-based dev envs #2050

Open

		(".coveragerc.toml", True, False),
		("setup.cfg", False, False),

		def test_coveragerc_toml_priority(self) -> None:
		"""Test that .coveragerc.toml has priority over pyproject.toml."""

		.. _pull 1952: https://github.com/nedbat/coveragepy/pull/1952


		.. start-releases

	# A pyproject.toml and coveragerc.toml will be read into the configuration.
	# A pyproject.toml and .coveragerc.toml will be read into the configuration.


		class SerializeConfigTest(CoverageTest):

Uh oh!

Support .coveragerc.toml for configuration #1952

Are you sure you want to change the base?

Support .coveragerc.toml for configuration #1952

Uh oh!

Conversation

OlenaYefymenko commented Apr 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OlenaYefymenko commented Apr 15, 2025

Uh oh!

nedbat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nedbat commented Apr 16, 2025

Uh oh!

OlenaYefymenko commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

webknjaz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Support `.coveragerc.toml` for configuration #1952

Support `.coveragerc.toml` for configuration #1952

OlenaYefymenko commented Apr 17, 2025 •

edited

Loading