[ty] Tell the user why we inferred the Python version we inferred

AlexWaygood · AlexWaygood · commit 0c61c94da4c2 · 2025-05-13T21:26:30.000-04:00
diff --git a/crates/ruff_graph/src/db.rs b/crates/ruff_graph/src/db.rs
@@ -45,6 +45,7 @@ impl ModuleDb {
             &db,
             ProgramSettings {
                 python_version,
+                python_version_source: ty_python_semantic::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths,
             },
diff --git a/crates/ty/tests/cli.rs b/crates/ty/tests/cli.rs
@@ -241,6 +241,72 @@ fn config_override_python_platform() -> anyhow::Result<()> {
     Ok(())
 }
 
+#[test]
+fn config_file_annotation_showing_where_python_version_set() -> anyhow::Result<()> {
+    let case = TestCase::with_files([
+        (
+            "pyproject.toml",
+            r#"
+            [tool.ty.environment]
+            python-version = "3.8"
+            "#,
+        ),
+        (
+            "test.py",
+            r#"
+            aiter
+            "#,
+        ),
+    ])?;
+
+    assert_cmd_snapshot!(case.command(), @r#"
+    success: false
+    exit_code: 1
+    ----- stdout -----
+    error[unresolved-reference]: Name `aiter` used when not defined
+     --> test.py:2:1
+      |
+    2 | aiter
+      | ^^^^^
+      |
+    info: `aiter` was added as a builtin in Python 3.10, but Python 3.8 was assumed when resolving types
+     --> pyproject.toml:3:18
+      |
+    2 | [tool.ty.environment]
+    3 | python-version = "3.8"
+      |                  ^^^^^ Python 3.8 assumed due to this configuration setting
+      |
+    info: rule `unresolved-reference` is enabled by default
+
+    Found 1 diagnostic
+
+    ----- stderr -----
+    WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors.
+    "#);
+
+    assert_cmd_snapshot!(case.command().arg("--python-version=3.9"), @r"
+    success: false
+    exit_code: 1
+    ----- stdout -----
+    error[unresolved-reference]: Name `aiter` used when not defined
+     --> test.py:2:1
+      |
+    2 | aiter
+      | ^^^^^
+      |
+    info: `aiter` was added as a builtin in Python 3.10, but Python 3.9 was assumed when resolving types
+    info: This is because Python 3.9 was specified on the command line
+    info: rule `unresolved-reference` is enabled by default
+
+    Found 1 diagnostic
+
+    ----- stderr -----
+    WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors.
+    ");
+
+    Ok(())
+}
+
 /// Paths specified on the CLI are relative to the current working directory and not the project root.
 ///
 /// We test this by adding an extra search path from the CLI to the libs directory when
diff --git a/crates/ty/tests/file_watching.rs b/crates/ty/tests/file_watching.rs
@@ -392,19 +392,24 @@ where
     let mut project = ProjectMetadata::discover(&project_path, &system)?;
     project.apply_configuration_files(&system)?;
 
-    let program_settings = project.to_program_settings(&system);
-
-    for path in program_settings
-        .search_paths
-        .extra_paths
-        .iter()
-        .chain(program_settings.search_paths.custom_typeshed.as_ref())
+    let environment_options = project.options().environment.as_ref();
+
+    for path in environment_options
+        .and_then(|env| env.extra_paths.as_ref())
+        .into_iter()
+        .flatten()
+        .chain(
+            environment_options
+                .as_ref()
+                .and_then(|env| env.python.as_ref()),
+        )
+        .chain(environment_options.and_then(|env| env.typeshed.as_ref()))
     {
-        std::fs::create_dir_all(path.as_std_path())
-            .with_context(|| format!("Failed to create search path `{path}`"))?;
+        std::fs::create_dir_all(path.path().as_std_path())
+            .with_context(|| format!("Failed to create search path `{}`", path.path()))?;
     }
 
-    let mut db = ProjectDatabase::new(project, system)?;
+    let mut db = ProjectDatabase::new(project.clone(), system)?;
 
     if let Some(included_paths) = included_paths {
         db.project().set_included_paths(&mut db, included_paths);
diff --git a/crates/ty_ide/src/inlay_hints.rs b/crates/ty_ide/src/inlay_hints.rs
@@ -192,6 +192,7 @@ mod tests {
             &db,
             ProgramSettings {
                 python_version: PythonVersion::latest_ty(),
+                python_version_source: ty_python_semantic::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
diff --git a/crates/ty_ide/src/lib.rs b/crates/ty_ide/src/lib.rs
@@ -229,6 +229,7 @@ mod tests {
             &db,
             ProgramSettings {
                 python_version: PythonVersion::latest_ty(),
+                python_version_source: ty_python_semantic::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
diff --git a/crates/ty_project/src/db.rs b/crates/ty_project/src/db.rs
@@ -59,7 +59,7 @@ impl ProjectDatabase {
         //   we may want to have a dedicated method for this?
 
         // Initialize the `Program` singleton
-        let program_settings = project_metadata.to_program_settings(db.system());
+        let program_settings = project_metadata.to_program_settings(&db);
         Program::from_settings(&db, program_settings)?;
 
         db.project = Some(Project::from_metadata(&db, project_metadata));
diff --git a/crates/ty_project/src/db/changes.rs b/crates/ty_project/src/db/changes.rs
@@ -182,7 +182,7 @@ impl ProjectDatabase {
                         );
                     }
 
-                    let program_settings = metadata.to_program_settings(self.system());
+                    let program_settings = metadata.to_program_settings(self);
 
                     let program = Program::get(self);
                     if let Err(error) = program.update_from_settings(self, program_settings) {
@@ -209,7 +209,7 @@ impl ProjectDatabase {
         } else if custom_stdlib_change {
             let search_paths = project
                 .metadata(self)
-                .to_program_settings(self.system())
+                .to_program_settings(self)
                 .search_paths;
 
             if let Err(error) = program.update_search_paths(self, &search_paths) {
diff --git a/crates/ty_project/src/lib.rs b/crates/ty_project/src/lib.rs
@@ -680,6 +680,7 @@ mod tests {
             &db,
             ProgramSettings {
                 python_version: PythonVersion::default(),
+                python_version_source: ty_python_semantic::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings::new(vec![SystemPathBuf::from(".")]),
             },
diff --git a/crates/ty_project/src/metadata.rs b/crates/ty_project/src/metadata.rs
@@ -17,7 +17,7 @@ pub mod pyproject;
 pub mod settings;
 pub mod value;
 
-#[derive(Debug, PartialEq, Eq)]
+#[derive(Debug, PartialEq, Eq, Clone)]
 #[cfg_attr(test, derive(serde::Serialize))]
 pub struct ProjectMetadata {
     pub(super) name: Name,
@@ -239,8 +239,8 @@ impl ProjectMetadata {
         &self.extra_configuration_paths
     }
 
-    pub fn to_program_settings(&self, system: &dyn System) -> ProgramSettings {
-        self.options.to_program_settings(self.root(), system)
+    pub fn to_program_settings(&self, db: &dyn crate::Db) -> ProgramSettings {
+        self.options.to_program_settings(db, self.root())
     }
 
     /// Combine the project options with the CLI options where the CLI options take precedence.
diff --git a/crates/ty_project/src/metadata/options.rs b/crates/ty_project/src/metadata/options.rs
@@ -86,14 +86,29 @@ impl Options {
 
     pub(crate) fn to_program_settings(
         &self,
+        db: &dyn crate::Db,
         project_root: &SystemPath,
-        system: &dyn System,
     ) -> ProgramSettings {
-        let python_version = self
+        let (python_version, python_version_source) = self
             .environment
             .as_ref()
-            .and_then(|env| env.python_version.as_deref().copied())
-            .unwrap_or(PythonVersion::latest_ty());
+            .and_then(|env| env.python_version.as_ref())
+            .map(|ranged_version| {
+                (
+                    ranged_version.inner_copied(),
+                    match ranged_version.source() {
+                        ValueSource::Cli => ty_python_semantic::ValueSource::Cli,
+                        ValueSource::File(path) => ty_python_semantic::ValueSource::File(
+                            system_path_to_file(db, &**path).ok(),
+                            ranged_version.range(),
+                        ),
+                    },
+                )
+            })
+            .unwrap_or((
+                PythonVersion::latest_ty(),
+                ty_python_semantic::ValueSource::default(),
+            ));
         let python_platform = self
             .environment
             .as_ref()
@@ -105,8 +120,9 @@ impl Options {
             });
         ProgramSettings {
             python_version,
+            python_version_source,
             python_platform,
-            search_paths: self.to_search_path_settings(project_root, system),
+            search_paths: self.to_search_path_settings(project_root, db.system()),
         }
     }
 
diff --git a/crates/ty_project/src/metadata/value.rs b/crates/ty_project/src/metadata/value.rs
@@ -133,6 +133,15 @@ impl<T> RangedValue<T> {
     }
 }
 
+impl<T> RangedValue<T>
+where
+    T: Copy,
+{
+    pub fn inner_copied(&self) -> T {
+        self.value
+    }
+}
+
 impl<T> Combine for RangedValue<T> {
     fn combine(self, _other: Self) -> Self
     where
diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_reference…_-_Diagnostics_for_unre…_-_New_builtin_used_on_…_(51edda0b1aebc2bf).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_reference…_-_Diagnostics_for_unre…_-_New_builtin_used_on_…_(51edda0b1aebc2bf).snap
@@ -24,9 +24,8 @@ error[unresolved-reference]: Name `aiter` used when not defined
 1 | aiter  # error: [unresolved-reference]
   | ^^^^^
   |
-info: `aiter` was added as a builtin in Python 3.10
-info: The inferred target version of your project is Python 3.9
-info: If using a pyproject.toml file, consider adjusting the `project.requires-python` or `tool.ty.environment.python-version` field
+info: `aiter` was added as a builtin in Python 3.10, but Python 3.9 was assumed when resolving types
+info: This is because Python 3.9 was specified on the command line
 info: rule `unresolved-reference` is enabled by default
 
 ```
diff --git a/crates/ty_python_semantic/src/db.rs b/crates/ty_python_semantic/src/db.rs
@@ -180,6 +180,7 @@ pub(crate) mod tests {
                 &db,
                 ProgramSettings {
                     python_version: self.python_version,
+                    python_version_source: crate::ValueSource::default(),
                     python_platform: self.python_platform,
                     search_paths: SearchPathSettings::new(vec![src_root]),
                 },
diff --git a/crates/ty_python_semantic/src/lib.rs b/crates/ty_python_semantic/src/lib.rs
@@ -7,7 +7,7 @@ use crate::suppression::{INVALID_IGNORE_COMMENT, UNKNOWN_RULE, UNUSED_IGNORE_COM
 pub use db::Db;
 pub use module_name::ModuleName;
 pub use module_resolver::{resolve_module, system_module_search_paths, KnownModule, Module};
-pub use program::{Program, ProgramSettings, PythonPath, SearchPathSettings};
+pub use program::{Program, ProgramSettings, PythonPath, SearchPathSettings, ValueSource};
 pub use python_platform::PythonPlatform;
 pub use semantic_model::{HasType, SemanticModel};
 pub use site_packages::SysPrefixPathOrigin;
diff --git a/crates/ty_python_semantic/src/module_resolver/resolver.rs b/crates/ty_python_semantic/src/module_resolver/resolver.rs
@@ -1490,6 +1490,7 @@ mod tests {
             &db,
             ProgramSettings {
                 python_version: PythonVersion::PY38,
+                python_version_source: crate::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
@@ -1996,6 +1997,7 @@ not_a_directory
             &db,
             ProgramSettings {
                 python_version: PythonVersion::default(),
+                python_version_source: crate::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
@@ -2069,6 +2071,7 @@ not_a_directory
             &db,
             ProgramSettings {
                 python_version: PythonVersion::default(),
+                python_version_source: crate::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
@@ -2109,6 +2112,7 @@ not_a_directory
             &db,
             ProgramSettings {
                 python_version: PythonVersion::default(),
+                python_version_source: crate::ValueSource::default(),
                 python_platform: PythonPlatform::default(),
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
diff --git a/crates/ty_python_semantic/src/module_resolver/testing.rs b/crates/ty_python_semantic/src/module_resolver/testing.rs
@@ -236,6 +236,7 @@ impl TestCaseBuilder<MockedTypeshed> {
             &db,
             ProgramSettings {
                 python_version,
+                python_version_source: crate::ValueSource::default(),
                 python_platform,
                 search_paths: SearchPathSettings {
                     extra_paths: vec![],
@@ -294,6 +295,7 @@ impl TestCaseBuilder<VendoredTypeshed> {
             &db,
             ProgramSettings {
                 python_version,
+                python_version_source: crate::ValueSource::default(),
                 python_platform,
                 search_paths: SearchPathSettings {
                     python_path: PythonPath::KnownSitePackages(vec![site_packages.clone()]),
diff --git a/crates/ty_python_semantic/src/program.rs b/crates/ty_python_semantic/src/program.rs
diff --git a/crates/ty_python_semantic/src/types/diagnostic.rs b/crates/ty_python_semantic/src/types/diagnostic.rs
diff --git a/crates/ty_test/src/assertion.rs b/crates/ty_test/src/assertion.rs
diff --git a/crates/ty_test/src/lib.rs b/crates/ty_test/src/lib.rs
diff --git a/crates/ty_test/src/matcher.rs b/crates/ty_test/src/matcher.rs
diff --git a/crates/ty_wasm/src/lib.rs b/crates/ty_wasm/src/lib.rs
