[red-knot] User-level configuration #16021

MichaReiser · 2025-02-07T14:34:49Z

Summary

This PR adds support for user-level configurations (~/.config/knot/knot.toml) to Red Knot.

Red Knot will watch the user-level configuration file for changes but only if it exists
when the process start. It doesn't watch for new configurations,
mainly to simplify things for now (it would require watching the entire .config directory because the knot subfolder might not exist either).

The new ConfigurationFile struct seems a bit overkill for now but I plan to use it for
hierarchical configurations as well.

Red Knot uses the same strategy as uv and Ruff by using the etcetera crate.

Test Plan

Added CLI and file watching test

MichaReiser · 2025-02-07T14:36:12Z

crates/red_knot/src/main.rs

@@ -99,10 +99,12 @@ fn run_check(args: CheckCommand) -> anyhow::Result<ExitStatus> {
    let exit_zero = args.exit_zero;

    let cli_options = args.into_options();
-    let mut workspace_metadata = ProjectMetadata::discover(system.current_directory(), &system)?;
-    workspace_metadata.apply_cli_options(cli_options.clone());
+    let mut project_metadata = ProjectMetadata::discover(system.current_directory(), &system)?;


We may want nicer error messages here that use proper diagnostics but I decided to not tackle that for now and continue doing what we do for other errors at this stage.

MichaReiser · 2025-02-07T14:36:26Z

crates/red_knot_project/src/db/changes.rs

@@ -47,7 +48,7 @@ impl ProjectDatabase {
            if let Some(path) = change.system_path() {
                if matches!(
                    path.file_name(),
-                    Some(".gitignore" | ".ignore" | "ruff.toml" | ".ruff.toml" | "pyproject.toml")
+                    Some(".gitignore" | ".ignore" | "knot.toml" | "pyproject.toml")


MichaReiser · 2025-02-07T14:37:14Z

crates/red_knot_project/src/db/changes.rs

+                    if let Err(error) = metadata.apply_configuration_files(self.system()) {
+                        tracing::error!(
+                            "Failed to apply configuration files, continuing without applying them: {error}"
+                        );
+                    }


We may want to use proper diagnostics here so that LSP users get notified about this error but there are other errors in this file where we're using tracing -> A problem for another day

MichaReiser · 2025-02-07T14:38:21Z

crates/red_knot_project/src/db/changes.rs

+                    if entry
+                        .path()
+                        .extension()
+                        .and_then(PySourceType::try_from_extension)
+                        .is_some()
+                    {
+                        let mut paths = added_paths.lock().unwrap();

-                    paths.push(entry.into_path());
+                        paths.push(entry.into_path());
+                    }


I got really confused when red knot started parsing my knot.toml file as a python file. For now, I did the simplest fix by copying this condition from Project::discover_files. I have to rework this code next month anyway to properly support file inclusion and exclusions.

MichaReiser · 2025-02-07T18:54:41Z

crates/red_knot/tests/utils.rs

+#![allow(dead_code)]
+
+/// Sets an environment variable for the duration this struct is in scope.
+pub(crate) struct EnvVarGuard {


This is actually not sufficient because cargo runs tests concurrently. So we also need some form of a lock to avoid that multiple tests hold on to the same env variable. Ugh, this is getting out of hand.

github-actions · 2025-02-08T16:55:34Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

crates/red_knot_project/src/metadata.rs

crates/red_knot_project/src/metadata/configuration_file.rs

crates/ruff_db/src/system/os.rs

sharkdp

Thank you!

…rrides between tests

* main: add diagnostic `Span` (couples `File` and `TextRange`) (#16101) Remove `Hash` and `Eq` from `AstNodeRef` for types not implementing `Eq` or `Hash` (#16100) Fix release build warning about unused todo type message (#16102) [`pydocstyle`] Handle arguments with the same names as sections (`D417`) (#16011) [red-knot] Reduce usage of `From<Type>` implementations when working with `Symbol`s (#16076) Transition to salsa coarse-grained tracked structs (#15763) [`pyupgrade`] Handle micro version numbers correctly (`UP036`) (#16091) [red-knot] `T | object == object` (#16088) [`ruff`] Skip singleton starred expressions for `incorrectly-parenthesized-tuple-in-subscript` (`RUF031`) (#16083) Delete left-over `verbosity.rs (#16081) [red-knot] User-level configuration (#16021) Add `user_configuration_directory` to `System` (#16020)

MichaReiser requested review from carljm, AlexWaygood and sharkdp as code owners February 7, 2025 14:34

MichaReiser added the red-knot Multi-file analysis & type inference label Feb 7, 2025

MichaReiser commented Feb 7, 2025

View reviewed changes

MichaReiser force-pushed the micha/user-level-configuration branch 2 times, most recently from 39bef15 to a1ab60d Compare February 7, 2025 14:45

MichaReiser commented Feb 7, 2025

View reviewed changes

MichaReiser force-pushed the micha/user-level-configuration branch 2 times, most recently from b2aeb58 to dd75dc2 Compare February 8, 2025 16:17