Deduplicate deprecation warnings for v0.2.0 release #9764
Merged
Conversation
This file contains 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
charliermarsh
commented
Feb 1, 2024
| @@ -1447,8 +1453,9 @@ fn warn_about_deprecated_top_level_lint_options(top_level_options: &LintCommonOp | |||
| .map(|option| format!("- '{option}' -> 'lint.{option}'")) | |||
| .join("\n "); | |||
|
|
|||
| warn_user!( | |||
| "The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:\n {options_mapping}\n\n", | |||
There was a problem hiding this comment.
The two trailing newlines at the end here looked odd to me in practice.
charliermarsh
force-pushed
the
charlie/warn
branch
from
45cc8aa
to
bf532d7
Compare
snowsignal
approved these changes
Feb 1, 2024
| @@ -34,6 +35,26 @@ macro_rules! warn_user_once_by_id { | |||
| }; | |||
| } | |||
|
|
|||
| pub static MESSAGES: Lazy<Mutex<FxHashSet<String>>> = Lazy::new(Mutex::default); | |||
There was a problem hiding this comment.
A small nit for clarity.
Suggested change
| pub static MESSAGES: Lazy<Mutex<FxHashSet<String>>> = Lazy::new(Mutex::default); | |
| pub static PREVIOUS_MESSAGES: Lazy<Mutex<FxHashSet<String>>> = Lazy::new(Mutex::default); |
|
MichaReiser
reviewed
Feb 2, 2024
| warn_about_deprecated_top_level_lint_options(&options.lint_top_level.0); | ||
| /// Convert the [`Options`] read from the given [`Path`] into a [`Configuration`]. | ||
| pub fn from_options(options: Options, path: &Path, project_root: &Path) -> Result<Self> { | ||
| warn_about_deprecated_top_level_lint_options(&options.lint_top_level.0, path); |
There was a problem hiding this comment.
Do we know why we call this method twice for every configuration ?
There was a problem hiding this comment.
Presumedly because we call it once at the very start of Ruff to find the "default configuration", and then once when we visited it as part of the directory of files we're analyzing. (We should fix that -- it's not "incorrect" but it is inefficient.)
There was a problem hiding this comment.
...and we didn't catch this in the tests because we pass --config which bypasses the discovery
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.
Summary
Adds an additional warning macro (we should consolidate these later) that shows a warning once based on the content of the warning itself. This is less efficient than
warn_user_once!andwarn_user_by_id!, but this is so expensive that it doesn't matter at all.Applies this macro to the various warnings for the v0.2.0 release, and also includes the filename in said warnings, so the FastAPI case is now: