From 6733eb82a085cad68528468e7c047029cfc2c6f7 Mon Sep 17 00:00:00 2001 From: Olena Date: Wed, 16 Apr 2025 02:04:00 +0300 Subject: [PATCH 1/4] Support `.coveragerc.toml` for configuration 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. --- coverage/config.py | 1 + tests/test_config.py | 107 ++++++++++++++++++++++++++----------------- 2 files changed, 67 insertions(+), 41 deletions(-) diff --git a/coverage/config.py b/coverage/config.py index 94831e070..75a20de3d 100644 --- a/coverage/config.py +++ b/coverage/config.py @@ -571,6 +571,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), diff --git a/tests/test_config.py b/tests/test_config.py index 190a27b1c..8e9a53fa5 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -64,9 +64,10 @@ def test_named_config_file(self, file_class: FilePathType) -> None: assert not cov.config.branch assert cov.config.data_file == "delete.me" - def test_toml_config_file(self) -> None: - # A pyproject.toml file will be read into the configuration. - self.make_file("pyproject.toml", """\ + @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, """\ # This is just a bogus toml file for testing. [tool.somethingelse] authors = ["Joe D'Ávila "] @@ -94,9 +95,10 @@ def test_toml_config_file(self) -> None: assert cov.config.fail_under == 90.5 assert cov.config.get_plugin_options("plugins.a_plugin") == {"hello": "world"} - def test_toml_ints_can_be_floats(self) -> None: + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_toml_ints_can_be_floats(self, filename) -> None: # Test that our class doesn't reject integers when loading floats - self.make_file("pyproject.toml", """\ + self.make_file(filename, """\ # This is just a bogus toml file for testing. [tool.coverage.report] fail_under = 90 @@ -205,7 +207,8 @@ def test_parse_errors(self, bad_config: str, msg: str) -> None: self.make_file(".coveragerc", bad_config) with pytest.raises(ConfigError, match=msg): coverage.Coverage() - + + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) @pytest.mark.parametrize("bad_config, msg", [ ("[tool.coverage.run]\ntimid = \"maybe?\"\n", r"maybe[?]"), ("[tool.coverage.run\n", None), @@ -223,9 +226,9 @@ def test_parse_errors(self, bad_config: str, msg: str) -> None: ("[tool.coverage.report]\nprecision=1.23", "not an integer"), ('[tool.coverage.report]\nfail_under="s"', "couldn't convert to a float"), ]) - def test_toml_parse_errors(self, bad_config: str, msg: str) -> None: + def test_toml_parse_errors(self, filename, bad_config: str, msg: str) -> None: # Im-parsable values raise ConfigError, with details. - self.make_file("pyproject.toml", bad_config) + self.make_file(filename, bad_config) with pytest.raises(ConfigError, match=msg): coverage.Coverage() @@ -251,9 +254,10 @@ def test_environment_vars_in_config(self) -> None: assert cov.config.branch is True assert cov.config.exclude_list == ["the_$one", "anotherZZZ", "xZZZy", "xy", "huh${X}what"] - def test_environment_vars_in_toml_config(self) -> None: + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_environment_vars_in_toml_config(self, filename) -> None: # Config files can have $envvars in them. - self.make_file("pyproject.toml", """\ + self.make_file(filename, """\ [tool.coverage.run] data_file = "$DATA_FILE.fooey" branch = "$BRANCH" @@ -325,9 +329,10 @@ def expanduser(s: str) -> str: assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"] assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']} - def test_tilde_in_toml_config(self) -> None: + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_tilde_in_toml_config(self, filename) -> None: # Config entries that are file paths can be tilde-expanded. - self.make_file("pyproject.toml", """\ + self.make_file(filename, """\ [tool.coverage.run] data_file = "~/data.file" @@ -441,22 +446,14 @@ def test_unknown_option(self) -> None: msg = r"Unrecognized option '\[run\] xyzzy=' in config file .coveragerc" with pytest.warns(CoverageWarning, match=msg): _ = coverage.Coverage() - - def test_unknown_option_toml(self) -> None: - self.make_file("pyproject.toml", """\ + + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_unknown_option_toml(self, filename) -> None: + self.make_file(filename, """\ [tool.coverage.run] xyzzy = 17 """) - msg = r"Unrecognized option '\[tool.coverage.run\] xyzzy=' in config file pyproject.toml" - with pytest.warns(CoverageWarning, match=msg): - _ = coverage.Coverage() - - def test_misplaced_option(self) -> None: - self.make_file(".coveragerc", """\ - [report] - branch = True - """) - msg = r"Unrecognized option '\[report\] branch=' in config file .coveragerc" + msg = f"Unrecognized option '\\[tool.coverage.run\\] xyzzy=' in config file {filename}" with pytest.warns(CoverageWarning, match=msg): _ = coverage.Coverage() @@ -468,7 +465,7 @@ def test_unknown_option_in_other_ini_file(self) -> None: msg = r"Unrecognized option '\[coverage:run\] huh=' in config file setup.cfg" with pytest.warns(CoverageWarning, match=msg): _ = coverage.Coverage() - + def test_exceptions_from_missing_things(self) -> None: self.make_file("config.ini", """\ [run] @@ -481,8 +478,10 @@ def test_exceptions_from_missing_things(self) -> None: with pytest.raises(ConfigError, match="No option 'foo' in section: 'xyzzy'"): config.get("xyzzy", "foo") - def test_exclude_also(self) -> None: - self.make_file("pyproject.toml", """\ + + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_exclude_also(self, filename) -> None: + self.make_file(filename, """\ [tool.coverage.report] exclude_also = ["foobar", "raise .*Error"] """) @@ -775,35 +774,39 @@ def test_no_toml_installed_explicit_toml(self) -> None: coverage.Coverage(config_file="cov.toml") @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - def test_no_toml_installed_pyproject_toml(self) -> None: - # Can't have coverage config in pyproject.toml without toml installed. - self.make_file("pyproject.toml", """\ + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_no_toml_installed_pyproject_toml(self, filename) -> None: + # Can't have coverage config in pyproject.toml and .coveragerc.toml without toml installed. + self.make_file(filename, """\ # A toml file! [tool.coverage.run] xyzzy = 17 """) 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" with pytest.raises(ConfigError, match=msg): coverage.Coverage() @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - def test_no_toml_installed_pyproject_toml_shorter_syntax(self) -> None: + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_no_toml_installed_pyproject_toml_shorter_syntax(self, filename) -> None: # Can't have coverage config in pyproject.toml without toml installed. - self.make_file("pyproject.toml", """\ + self.make_file(filename, """\ # 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" with pytest.raises(ConfigError, match=msg): coverage.Coverage() + @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - def test_no_toml_installed_pyproject_no_coverage(self) -> None: + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_no_toml_installed_pyproject_no_coverage(self, filename) -> None: # It's ok to have non-coverage pyproject.toml without toml installed. - self.make_file("pyproject.toml", """\ + self.make_file(filename, """\ # A toml file! [tool.something] xyzzy = 17 @@ -814,17 +817,39 @@ def test_no_toml_installed_pyproject_no_coverage(self) -> None: assert not cov.config.timid assert not cov.config.branch assert cov.config.data_file == ".coverage" - - def test_exceptions_from_missing_toml_things(self) -> None: - self.make_file("pyproject.toml", """\ + + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) + def test_exceptions_from_missing_toml_things(self, filename) -> None: + self.make_file(filename, """\ [tool.coverage.run] branch = true """) config = TomlConfigParser(False) - config.read("pyproject.toml") + config.read(filename) with pytest.raises(ConfigError, match="No section: 'xyzzy'"): config.options("xyzzy") with pytest.raises(ConfigError, match="No section: 'xyzzy'"): config.get("xyzzy", "foo") with pytest.raises(ConfigError, match="No option 'foo' in section: 'tool.coverage.run'"): config.get("run", "foo") + + def test_coveragerc_toml_priority(self) -> None: + """Test that .coveragerc.toml has priority over pyproject.toml.""" + self.make_file(".coveragerc.toml", """\ + [tool.coverage.run] + timid = true + data_file = ".toml-data.dat" + branch = true + """) + + self.make_file("pyproject.toml", """\ + [tool.coverage.run] + timid = false + data_file = "pyproject-data.dat" + branch = false + """) + cov = coverage.Coverage() + + assert cov.config.timid is True + assert cov.config.data_file == ".toml-data.dat" + assert cov.config.branch is True From 38e73d996cf92ce9dfef094868886bd4e7ff8ce8 Mon Sep 17 00:00:00 2001 From: Olena <107187316+OlenaYefymenko@users.noreply.github.com> Date: Fri, 18 Apr 2025 23:59:10 +0300 Subject: [PATCH 2/4] Add f-string for error message MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) --- tests/test_config.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_config.py b/tests/test_config.py index 8e9a53fa5..635a643b8 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -783,7 +783,7 @@ def test_no_toml_installed_pyproject_toml(self, filename) -> None: xyzzy = 17 """) with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): - msg = "Can't read '{filename}' without TOML support" + msg = f"Can't read '{filename}' without TOML support" with pytest.raises(ConfigError, match=msg): coverage.Coverage() @@ -797,7 +797,7 @@ def test_no_toml_installed_pyproject_toml_shorter_syntax(self, filename) -> None run.parallel = true """) with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): - msg = "Can't read '{filename}' without TOML support" + msg = f"Can't read '{filename}' without TOML support" with pytest.raises(ConfigError, match=msg): coverage.Coverage() From 578ee6c0aaf962ec1fb0d01685721aa55fdb809c Mon Sep 17 00:00:00 2001 From: Olena Date: Fri, 6 Jun 2025 01:56:25 +0300 Subject: [PATCH 3/4] This patch parametrizes tests for configuration files. Adds a new test to verify behavior when TOML support is unavailable. --- tests/test_config.py | 46 +++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/tests/test_config.py b/tests/test_config.py index 635a643b8..123606ff8 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -774,39 +774,35 @@ def test_no_toml_installed_explicit_toml(self) -> None: coverage.Coverage(config_file="cov.toml") @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_no_toml_installed_pyproject_toml(self, filename) -> None: - # Can't have coverage config in pyproject.toml and .coveragerc.toml without toml installed. - self.make_file(filename, """\ + def test_no_toml_installed_pyproject_toml(self) -> None: + # Can't have coverage config in pyproject.toml without toml installed. + self.make_file("pyproject.toml", """\ # A toml file! [tool.coverage.run] xyzzy = 17 """) with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): - msg = f"Can't read '{filename}' without TOML support" + msg = "Can't read 'pyproject.toml' without TOML support" with pytest.raises(ConfigError, match=msg): coverage.Coverage() @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_no_toml_installed_pyproject_toml_shorter_syntax(self, filename) -> None: + def test_no_toml_installed_pyproject_toml_shorter_syntax(self) -> None: # Can't have coverage config in pyproject.toml without toml installed. - self.make_file(filename, """\ + self.make_file("pyproject.toml", """\ # A toml file! [tool.coverage] run.parallel = true """) with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): - msg = f"Can't read '{filename}' without TOML support" + msg = "Can't read 'pyproject.toml' without TOML support" with pytest.raises(ConfigError, match=msg): coverage.Coverage() - @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") - @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_no_toml_installed_pyproject_no_coverage(self, filename) -> None: + def test_no_toml_installed_pyproject_no_coverage(self) -> None: # It's ok to have non-coverage pyproject.toml without toml installed. - self.make_file(filename, """\ + self.make_file("pyproject.toml", """\ # A toml file! [tool.something] xyzzy = 17 @@ -853,3 +849,27 @@ def test_coveragerc_toml_priority(self) -> None: assert cov.config.timid is True assert cov.config.data_file == ".toml-data.dat" assert cov.config.branch is True + + + @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") + def test_toml_file_exists_but_no_toml_support(self) -> None: + """Test behavior when .coveragerc.toml exists but TOML support is missing.""" + self.make_file(".coveragerc.toml", """\ + [tool.coverage.run] + timid = true + data_file = ".toml-data.dat" + """) + + with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): + msg = "Can't read '.coveragerc.toml' without TOML support" + with pytest.raises(ConfigError, match=msg): + coverage.Coverage(config_file=".coveragerc.toml") + self.make_file(".coveragerc", """\ + [run] + timid = false + data_file = .ini-data.dat + """) + + cov = coverage.Coverage() + assert not cov.config.timid + assert cov.config.data_file == ".ini-data.dat" From 40187901368653562eb4098af4e1aee79b79dd15 Mon Sep 17 00:00:00 2001 From: Olena Date: Fri, 6 Jun 2025 02:44:43 +0300 Subject: [PATCH 4/4] Fix linter issues --- tests/test_config.py | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/tests/test_config.py b/tests/test_config.py index 123606ff8..1d4d09335 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -65,7 +65,7 @@ def test_named_config_file(self, file_class: FilePathType) -> None: assert cov.config.data_file == "delete.me" @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_toml_config_file(self, filename) -> None: + def test_toml_config_file(self, filename: str) -> None: # A pyproject.toml and coveragerc.toml will be read into the configuration. self.make_file(filename, """\ # This is just a bogus toml file for testing. @@ -96,7 +96,7 @@ def test_toml_config_file(self, filename) -> None: assert cov.config.get_plugin_options("plugins.a_plugin") == {"hello": "world"} @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_toml_ints_can_be_floats(self, filename) -> None: + def test_toml_ints_can_be_floats(self, filename: str) -> None: # Test that our class doesn't reject integers when loading floats self.make_file(filename, """\ # This is just a bogus toml file for testing. @@ -207,7 +207,7 @@ def test_parse_errors(self, bad_config: str, msg: str) -> None: self.make_file(".coveragerc", bad_config) with pytest.raises(ConfigError, match=msg): coverage.Coverage() - + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) @pytest.mark.parametrize("bad_config, msg", [ ("[tool.coverage.run]\ntimid = \"maybe?\"\n", r"maybe[?]"), @@ -226,7 +226,7 @@ def test_parse_errors(self, bad_config: str, msg: str) -> None: ("[tool.coverage.report]\nprecision=1.23", "not an integer"), ('[tool.coverage.report]\nfail_under="s"', "couldn't convert to a float"), ]) - def test_toml_parse_errors(self, filename, bad_config: str, msg: str) -> None: + def test_toml_parse_errors(self, filename: str, bad_config: str, msg: str) -> None: # Im-parsable values raise ConfigError, with details. self.make_file(filename, bad_config) with pytest.raises(ConfigError, match=msg): @@ -255,7 +255,7 @@ def test_environment_vars_in_config(self) -> None: assert cov.config.exclude_list == ["the_$one", "anotherZZZ", "xZZZy", "xy", "huh${X}what"] @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_environment_vars_in_toml_config(self, filename) -> None: + def test_environment_vars_in_toml_config(self, filename: str) -> None: # Config files can have $envvars in them. self.make_file(filename, """\ [tool.coverage.run] @@ -330,7 +330,7 @@ def expanduser(s: str) -> str: assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']} @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_tilde_in_toml_config(self, filename) -> None: + def test_tilde_in_toml_config(self, filename: str) -> None: # Config entries that are file paths can be tilde-expanded. self.make_file(filename, """\ [tool.coverage.run] @@ -446,9 +446,9 @@ def test_unknown_option(self) -> None: msg = r"Unrecognized option '\[run\] xyzzy=' in config file .coveragerc" with pytest.warns(CoverageWarning, match=msg): _ = coverage.Coverage() - + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_unknown_option_toml(self, filename) -> None: + def test_unknown_option_toml(self, filename: str) -> None: self.make_file(filename, """\ [tool.coverage.run] xyzzy = 17 @@ -465,7 +465,7 @@ def test_unknown_option_in_other_ini_file(self) -> None: msg = r"Unrecognized option '\[coverage:run\] huh=' in config file setup.cfg" with pytest.warns(CoverageWarning, match=msg): _ = coverage.Coverage() - + def test_exceptions_from_missing_things(self) -> None: self.make_file("config.ini", """\ [run] @@ -478,9 +478,9 @@ def test_exceptions_from_missing_things(self) -> None: with pytest.raises(ConfigError, match="No option 'foo' in section: 'xyzzy'"): config.get("xyzzy", "foo") - + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_exclude_also(self, filename) -> None: + def test_exclude_also(self, filename: str) -> None: self.make_file(filename, """\ [tool.coverage.report] exclude_also = ["foobar", "raise .*Error"] @@ -813,9 +813,9 @@ def test_no_toml_installed_pyproject_no_coverage(self) -> None: assert not cov.config.timid assert not cov.config.branch assert cov.config.data_file == ".coverage" - + @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"]) - def test_exceptions_from_missing_toml_things(self, filename) -> None: + def test_exceptions_from_missing_toml_things(self, filename: str) -> None: self.make_file(filename, """\ [tool.coverage.run] branch = true @@ -828,7 +828,7 @@ def test_exceptions_from_missing_toml_things(self, filename) -> None: config.get("xyzzy", "foo") with pytest.raises(ConfigError, match="No option 'foo' in section: 'tool.coverage.run'"): config.get("run", "foo") - + def test_coveragerc_toml_priority(self) -> None: """Test that .coveragerc.toml has priority over pyproject.toml.""" self.make_file(".coveragerc.toml", """\ @@ -837,7 +837,7 @@ def test_coveragerc_toml_priority(self) -> None: data_file = ".toml-data.dat" branch = true """) - + self.make_file("pyproject.toml", """\ [tool.coverage.run] timid = false @@ -845,12 +845,12 @@ def test_coveragerc_toml_priority(self) -> None: branch = false """) cov = coverage.Coverage() - + assert cov.config.timid is True assert cov.config.data_file == ".toml-data.dat" assert cov.config.branch is True - - + + @pytest.mark.skipif(env.PYVERSION >= (3, 11), reason="Python 3.11 has toml in stdlib") def test_toml_file_exists_but_no_toml_support(self) -> None: """Test behavior when .coveragerc.toml exists but TOML support is missing.""" @@ -859,7 +859,7 @@ def test_toml_file_exists_but_no_toml_support(self) -> None: timid = true data_file = ".toml-data.dat" """) - + with mock.patch.object(coverage.tomlconfig, "has_tomllib", False): msg = "Can't read '.coveragerc.toml' without TOML support" with pytest.raises(ConfigError, match=msg): @@ -869,7 +869,7 @@ def test_toml_file_exists_but_no_toml_support(self) -> None: timid = false data_file = .ini-data.dat """) - + cov = coverage.Coverage() assert not cov.config.timid assert cov.config.data_file == ".ini-data.dat"