From 1dda54c8467ed567aae2c0d8ae79b0c4b3ab5ada Mon Sep 17 00:00:00 2001 From: Nathan McDougall Date: Tue, 23 Dec 2025 20:47:11 +1300 Subject: [PATCH] Use consistent naming for "Dot" Config Managers --- src/usethis/_config_file.py | 12 ++++++------ src/usethis/_tool/impl/codespell.py | 6 +++--- src/usethis/_tool/impl/coverage_py.py | 10 +++++----- tests/usethis/_tool/impl/test_coverage_py.py | 4 ++-- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/usethis/_config_file.py b/src/usethis/_config_file.py index 88b779bf..f25805ad 100644 --- a/src/usethis/_config_file.py +++ b/src/usethis/_config_file.py @@ -20,9 +20,9 @@ def files_manager() -> Iterator[None]: with ( PyprojectTOMLManager(), SetupCFGManager(), - CodespellRCManager(), - CoverageRCManager(), - CoverageRCTOMLManager(), + DotCodespellRCManager(), + DotCoverageRCManager(), + DotCoverageRCTOMLManager(), DotRuffTOMLManager(), DotPytestINIManager(), DotImportLinterManager(), @@ -35,7 +35,7 @@ def files_manager() -> Iterator[None]: yield -class CodespellRCManager(INIFileManager): +class DotCodespellRCManager(INIFileManager): """Class to manage the .codespellrc file.""" @property @@ -43,7 +43,7 @@ def relative_path(self) -> Path: return Path(".codespellrc") -class CoverageRCManager(INIFileManager): +class DotCoverageRCManager(INIFileManager): """Class to manage the .coveragerc file.""" @property @@ -51,7 +51,7 @@ def relative_path(self) -> Path: return Path(".coveragerc") -class CoverageRCTOMLManager(TOMLFileManager): +class DotCoverageRCTOMLManager(TOMLFileManager): """Class to manage the .coveragerc.toml file.""" @property diff --git a/src/usethis/_tool/impl/codespell.py b/src/usethis/_tool/impl/codespell.py index 5c37eb58..c69f4ea0 100644 --- a/src/usethis/_tool/impl/codespell.py +++ b/src/usethis/_tool/impl/codespell.py @@ -6,7 +6,7 @@ from typing_extensions import assert_never from usethis._config import usethis_config -from usethis._config_file import CodespellRCManager +from usethis._config_file import DotCodespellRCManager from usethis._console import how_print from usethis._integrations.backend.dispatch import get_backend from usethis._integrations.backend.uv.used import is_uv_used @@ -66,14 +66,14 @@ def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]: def preferred_file_manager(self) -> KeyValueFileManager: if (usethis_config.cpd() / "pyproject.toml").exists(): return PyprojectTOMLManager() - return CodespellRCManager() + return DotCodespellRCManager() def get_config_spec(self) -> ConfigSpec: # https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file return ConfigSpec.from_flat( file_managers=[ - CodespellRCManager(), + DotCodespellRCManager(), SetupCFGManager(), PyprojectTOMLManager(), ], diff --git a/src/usethis/_tool/impl/coverage_py.py b/src/usethis/_tool/impl/coverage_py.py index 5673a6c8..7e05d55f 100644 --- a/src/usethis/_tool/impl/coverage_py.py +++ b/src/usethis/_tool/impl/coverage_py.py @@ -7,8 +7,8 @@ from usethis._config import usethis_config from usethis._config_file import ( - CoverageRCManager, - CoverageRCTOMLManager, + DotCoverageRCManager, + DotCoverageRCTOMLManager, ToxINIManager, ) from usethis._console import how_print @@ -71,7 +71,7 @@ def get_test_deps(self, *, unconditional: bool = False) -> list[Dependency]: def preferred_file_manager(self) -> KeyValueFileManager: if (usethis_config.cpd() / "pyproject.toml").exists(): return PyprojectTOMLManager() - return CoverageRCManager() + return DotCoverageRCManager() def get_config_spec(self) -> ConfigSpec: # https://coverage.readthedocs.io/en/latest/config.html#configuration-reference @@ -94,8 +94,8 @@ def _get_source(): return ConfigSpec.from_flat( file_managers=[ - CoverageRCManager(), - CoverageRCTOMLManager(), + DotCoverageRCManager(), + DotCoverageRCTOMLManager(), SetupCFGManager(), ToxINIManager(), PyprojectTOMLManager(), diff --git a/tests/usethis/_tool/impl/test_coverage_py.py b/tests/usethis/_tool/impl/test_coverage_py.py index d0da0fc0..ceff3d2f 100644 --- a/tests/usethis/_tool/impl/test_coverage_py.py +++ b/tests/usethis/_tool/impl/test_coverage_py.py @@ -1,6 +1,6 @@ from pathlib import Path -from usethis._config_file import CoverageRCTOMLManager, files_manager +from usethis._config_file import DotCoverageRCTOMLManager, files_manager from usethis._integrations.file.pyproject_toml.io_ import PyprojectTOMLManager from usethis._test import change_cwd from usethis._tool.impl.coverage_py import CoveragePyTool @@ -85,7 +85,7 @@ def test_coveragerc_toml_preferred_over_pyproject_toml(self, tmp_path: Path): # Assert - config should be added to .coveragerc.toml with change_cwd(tmp_path), files_manager(): - assert ["run"] in CoverageRCTOMLManager() + assert ["run"] in DotCoverageRCTOMLManager() content = (tmp_path / ".coveragerc.toml").read_text() assert "[run]" in content assert "[report]" in content