Deduplicate deprecation warnings for v0.2.0 release (#9764)

## 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!` and `warn_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: ```text warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in /Users/crmarsh/workspace/fastapi/pyproject.toml: - 'ignore' -> 'lint.ignore' - 'select' -> 'lint.select' - 'isort' -> 'lint.isort' - 'pyupgrade' -> 'lint.pyupgrade' - 'per-file-ignores' -> 'lint.per-file-ignores' ``` --------- Co-authored-by: Zanie <contact@zanie.dev>
astral-sh · Feb 1, 2024 · 06ad687 · 06ad687
1 parent 148b64e
commit 06ad687
Show file tree

Hide file tree

Showing 7 changed files with 133 additions and 66 deletions.
diff --git a/crates/ruff/tests/format.rs b/crates/ruff/tests/format.rs
@@ -508,11 +508,9 @@ if __name__ == '__main__':
         say_hy("dear Ruff contributor")
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
       - 'ignore' -> 'lint.ignore'
-
-
     "###);
     Ok(())
 }
@@ -551,11 +549,9 @@ if __name__ == '__main__':
         say_hy("dear Ruff contributor")
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
       - 'ignore' -> 'lint.ignore'
-
-
     "###);
     Ok(())
 }

diff --git a/crates/ruff/tests/lint.rs b/crates/ruff/tests/lint.rs
@@ -2,6 +2,7 @@
 
 #![cfg(not(target_family = "wasm"))]
 
+use regex::escape;
 use std::fs;
 use std::process::Command;
 use std::str;
@@ -13,6 +14,10 @@ use tempfile::TempDir;
 const BIN_NAME: &str = "ruff";
 const STDIN_BASE_OPTIONS: &[&str] = &["--no-cache", "--output-format", "concise"];
 
+fn tempdir_filter(tempdir: &TempDir) -> String {
+    format!(r"{}\\?/?", escape(tempdir.path().to_str().unwrap()))
+}
+
 #[test]
 fn top_level_options() -> Result<()> {
     let tempdir = TempDir::new()?;
@@ -27,29 +32,32 @@ inline-quotes = "single"
 "#,
     )?;
 
-    assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
-        .args(STDIN_BASE_OPTIONS)
-        .arg("--config")
-        .arg(&ruff_toml)
-        .args(["--stdin-filename", "test.py"])
-        .arg("-")
-        .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    test.py:1:5: Q000 [*] Double quotes found but single quotes preferred
-    test.py:1:5: B005 Using `.strip()` with multi-character strings is misleading
-    test.py:1:19: Q000 [*] Double quotes found but single quotes preferred
-    Found 3 errors.
-    [*] 2 fixable with the `--fix` option.
-
-    ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
-      - 'extend-select' -> 'lint.extend-select'
-      - 'flake8-quotes' -> 'lint.flake8-quotes'
-
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
+        assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
+            .args(STDIN_BASE_OPTIONS)
+            .arg("--config")
+            .arg(&ruff_toml)
+            .args(["--stdin-filename", "test.py"])
+            .arg("-")
+            .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###"
+        success: false
+        exit_code: 1
+        ----- stdout -----
+        test.py:1:5: Q000 [*] Double quotes found but single quotes preferred
+        test.py:1:5: B005 Using `.strip()` with multi-character strings is misleading
+        test.py:1:19: Q000 [*] Double quotes found but single quotes preferred
+        Found 3 errors.
+        [*] 2 fixable with the `--fix` option.
+
+        ----- stderr -----
+        warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`:
+          - 'extend-select' -> 'lint.extend-select'
+          - 'flake8-quotes' -> 'lint.flake8-quotes'
+        "###);
+    });
 
-    "###);
     Ok(())
 }
 
@@ -68,6 +76,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .args(STDIN_BASE_OPTIONS)
         .arg("--config")
@@ -85,6 +96,8 @@ inline-quotes = "single"
 
     ----- stderr -----
     "###);
+    });
+
     Ok(())
 }
 
@@ -103,6 +116,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .args(STDIN_BASE_OPTIONS)
         .arg("--config")
@@ -119,11 +135,11 @@ inline-quotes = "single"
     [*] 2 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -146,6 +162,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .args(STDIN_BASE_OPTIONS)
         .arg("--config")
@@ -162,11 +181,11 @@ inline-quotes = "single"
     [*] 2 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`:
       - 'flake8-quotes' -> 'lint.flake8-quotes'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -222,6 +241,9 @@ OTHER = "OTHER"
 
     fs::write(out_dir.join("a.py"), r#"a = "a""#)?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(tempdir.path())
         .arg("check")
@@ -241,11 +263,11 @@ OTHER = "OTHER"
     [*] 3 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -266,6 +288,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(tempdir.path())
         .arg("check")
@@ -288,11 +313,11 @@ if __name__ == "__main__":
     [*] 2 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -311,6 +336,9 @@ max-line-length = 100
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .args(STDIN_BASE_OPTIONS)
         .arg("--config")
@@ -330,12 +358,12 @@ _ = "---------------------------------------------------------------------------
     Found 1 error.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`:
       - 'select' -> 'lint.select'
       - 'pycodestyle' -> 'lint.pycodestyle'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -353,6 +381,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(tempdir.path())
         .arg("check")
@@ -377,11 +408,11 @@ if __name__ == "__main__":
     [*] 1 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -399,6 +430,9 @@ inline-quotes = "single"
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(tempdir.path())
         .arg("check")
@@ -423,11 +457,11 @@ if __name__ == "__main__":
     [*] 1 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+    warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`:
       - 'extend-select' -> 'lint.extend-select'
-
-
     "###);
+    });
+
     Ok(())
 }
 
@@ -456,6 +490,9 @@ ignore = ["D203", "D212"]
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(sub_dir)
         .arg("check")
@@ -468,6 +505,8 @@ ignore = ["D203", "D212"]
     ----- stderr -----
     warning: No Python files found under the given path(s)
     "###);
+    });
+
     Ok(())
 }
 
@@ -524,6 +563,9 @@ include = ["*.ipy"]
 "#,
     )?;
 
+    insta::with_settings!({
+        filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")]
+    }, {
     assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME))
         .current_dir(tempdir.path())
         .arg("check")
@@ -540,5 +582,7 @@ include = ["*.ipy"]
 
     ----- stderr -----
     "###);
+    });
+
     Ok(())
 }
diff --git a/crates/ruff/tests/resolve_files.rs b/crates/ruff/tests/resolve_files.rs
@@ -39,10 +39,8 @@ fn check_project_include_defaults() {
         [BASEPATH]/include-test/subdirectory/c.py
 
         ----- stderr -----
-        warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your configuration:
+        warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `nested-project/pyproject.toml`:
           - 'select' -> 'lint.select'
-
-
         "###);
     });
 }

diff --git a/crates/ruff_linter/src/logging.rs b/crates/ruff_linter/src/logging.rs
@@ -8,14 +8,15 @@ use fern;
 use log::Level;
 use once_cell::sync::Lazy;
 use ruff_python_parser::{ParseError, ParseErrorType};
+use rustc_hash::FxHashSet;
 
 use ruff_source_file::{LineIndex, OneIndexed, SourceCode, SourceLocation};
 
 use crate::fs;
 use crate::source_kind::SourceKind;
 use ruff_notebook::Notebook;
 
-pub static WARNINGS: Lazy<Mutex<Vec<&'static str>>> = Lazy::new(Mutex::default);
+pub static IDENTIFIERS: Lazy<Mutex<Vec<&'static str>>> = Lazy::new(Mutex::default);
 
 /// Warn a user once, with uniqueness determined by the given ID.
 #[macro_export]
@@ -24,7 +25,7 @@ macro_rules! warn_user_once_by_id {
         use colored::Colorize;
         use log::warn;
 
-        if let Ok(mut states) = $crate::logging::WARNINGS.lock() {
+        if let Ok(mut states) = $crate::logging::IDENTIFIERS.lock() {
             if !states.contains(&$id) {
                 let message = format!("{}", format_args!($($arg)*));
                 warn!("{}", message.bold());
@@ -34,6 +35,26 @@ macro_rules! warn_user_once_by_id {
     };
 }
 
+pub static MESSAGES: Lazy<Mutex<FxHashSet<String>>> = Lazy::new(Mutex::default);
+
+/// Warn a user once, if warnings are enabled, with uniqueness determined by the content of the
+/// message.
+#[macro_export]
+macro_rules! warn_user_once_by_message {
+    ($($arg:tt)*) => {
+        use colored::Colorize;
+        use log::warn;
+
+        if let Ok(mut states) = $crate::logging::MESSAGES.lock() {
+            let message = format!("{}", format_args!($($arg)*));
+            if !states.contains(&message) {
+                warn!("{}", message.bold());
+                states.insert(message);
+            }
+        }
+    };
+}
+
 /// Warn a user once, with uniqueness determined by the calling location itself.
 #[macro_export]
 macro_rules! warn_user_once {