219 properly handle other ruff configuration files#398
Merged
nathanjmcdougall merged 33 commits intomainfrom Mar 16, 2025
Merged
219 properly handle other ruff configuration files#398nathanjmcdougall merged 33 commits intomainfrom
nathanjmcdougall merged 33 commits intomainfrom
Conversation
Rename `PyProject` -> `Pyproject` for consistency
… more generalized
CodSpeed Performance ReportMerging #398 will not alter performanceComparing Summary
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #398 +/- ##
==========================================
+ Coverage 98.15% 98.39% +0.23%
==========================================
Files 72 69 -3
Lines 3095 3113 +18
==========================================
+ Hits 3038 3063 +25
+ Misses 57 50 -7 ☔ View full report in Codecov by Sentry. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the handling of TOML configuration files by introducing a new context manager (files_manager) to consolidate access to various TOML managers and by removing legacy pyproject.toml helper modules. Key changes include:
- Introducing files_manager in src/usethis/_config_file.py and corresponding classes (DotRuffTOMLManager and RuffTOMLManager) for managing TOML files.
- Replacing all direct usages of PyprojectTOMLManager with files_manager across modules, tests, and CLI interfaces.
- Removing legacy modules (e.g. the pyproject_toml core and Ruff rules helpers) that are no longer required.
Reviewed Changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/usethis/_config_file.py | Adds a new files_manager context manager and TOML manager classes for handling .ruff.toml and ruff.toml. |
| src/usethis/integrations/file/toml/io.py | Refactors the base TOML file manager to use a unified property (self.path) and adds extra helper methods. |
| tests/usethis/_core/test_core_ci.py | Replaces direct PyprojectTOMLManager usage with files_manager in tests. |
| Various files under src/usethis/_interface/ | Updates CLI command context managers to use files_manager instead of PyprojectTOMLManager. |
| Other integration files (sonarqube, uv, deps, etc.) | Update accesses to TOML configuration values using the new files_manager and remove legacy code. |
| pyproject.toml | Updates layers and module lists to reflect the removal of legacy components. |
Comments suppressed due to low confidence (1)
src/usethis/_config_file.py:15
- [nitpick] The files_manager context manager yields nothing, which may be confusing for consumers expecting to work with an instance or a composite manager. Consider yielding a meaningful composite object (or documenting that it serves only to initialize multiple managers) to clarify its intended use.
def files_manager() -> Iterator[None]:
nathanjmcdougall
deleted the
219-properly-handle-other-ruff-configuration-files
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lots of TODOs still to go but it's time to see how performance is affected.