[ty] Pull types on synthesized Python files created by mdtest

Author: AlexWaygood

Cargo.lock

@@ -50,6 +50,7 @@ strum_macros = { workspace = true }
 [dev-dependencies]
 ruff_db = { workspace = true, features = ["testing", "os"] }
 ruff_python_parser = { workspace = true }
+ty_python_semantic = { workspace = true, features = ["testing"] }
 ty_test = { workspace = true }
 ty_vendored = { workspace = true }
 
@@ -63,6 +64,7 @@ quickcheck_macros = { version = "1.0.0" }
 
 [features]
 serde = ["ruff_db/serde", "dep:serde", "ruff_python_ast/serde"]
+testing = []
 
 [lints]
 workspace = true

crates/ty_python_semantic/Cargo.toml

@@ -35,6 +35,9 @@ pub mod types;
 mod unpack;
 mod util;
 
+#[cfg(feature = "testing")]
+pub mod pull_types;
+
 type FxOrderSet<V> = ordermap::set::OrderSet<V, BuildHasherDefault<FxHasher>>;
 
 /// Returns the default registry with all known semantic lints.

crates/ty_python_semantic/src/lib.rs

@@ -0,0 +1,134 @@
+//! A utility visitor for testing, which attempts to "pull a type" for ever sub-node in a given AST.
+//!
+//! This is used in the "corpus" and (indirectly) the "mdtest" integration tests for this crate.
+//! (Mdtest uses the `pull_types` function via the `ty_test` crate.)
+
+use crate::{Db, HasType, SemanticModel};
+use ruff_db::{files::File, parsed::parsed_module};
+use ruff_python_ast::{
+    self as ast, visitor::source_order, visitor::source_order::SourceOrderVisitor,
+};
+
+pub fn pull_types(db: &dyn Db, file: File) {
+    let mut visitor = PullTypesVisitor::new(db, file);
+
+    let ast = parsed_module(db.upcast(), file).load(db.upcast());
+
+    visitor.visit_body(ast.suite());
+}
+
+struct PullTypesVisitor<'db> {
+    model: SemanticModel<'db>,
+}
+
+impl<'db> PullTypesVisitor<'db> {
+    fn new(db: &'db dyn Db, file: File) -> Self {
+        Self {
+            model: SemanticModel::new(db, file),
+        }
+    }
+
+    fn visit_target(&mut self, target: &ast::Expr) {
+        match target {
+            ast::Expr::List(ast::ExprList { elts, .. })
+            | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => {
+                for element in elts {
+                    self.visit_target(element);
+                }
+            }
+            _ => self.visit_expr(target),
+        }
+    }
+}
+
+impl SourceOrderVisitor<'_> for PullTypesVisitor<'_> {
+    fn visit_stmt(&mut self, stmt: &ast::Stmt) {
+        match stmt {
+            ast::Stmt::FunctionDef(function) => {
+                let _ty = function.inferred_type(&self.model);
+            }
+            ast::Stmt::ClassDef(class) => {
+                let _ty = class.inferred_type(&self.model);
+            }
+            ast::Stmt::Assign(assign) => {
+                for target in &assign.targets {
+                    self.visit_target(target);
+                }
+                self.visit_expr(&assign.value);
+                return;
+            }
+            ast::Stmt::For(for_stmt) => {
+                self.visit_target(&for_stmt.target);
+                self.visit_expr(&for_stmt.iter);
+                self.visit_body(&for_stmt.body);
+                self.visit_body(&for_stmt.orelse);
+                return;
+            }
+            ast::Stmt::With(with_stmt) => {
+                for item in &with_stmt.items {
+                    if let Some(target) = &item.optional_vars {
+                        self.visit_target(target);
+                    }
+                    self.visit_expr(&item.context_expr);
+                }
+
+                self.visit_body(&with_stmt.body);
+                return;
+            }
+            ast::Stmt::AnnAssign(_)
+            | ast::Stmt::Return(_)
+            | ast::Stmt::Delete(_)
+            | ast::Stmt::AugAssign(_)
+            | ast::Stmt::TypeAlias(_)
+            | ast::Stmt::While(_)
+            | ast::Stmt::If(_)
+            | ast::Stmt::Match(_)
+            | ast::Stmt::Raise(_)
+            | ast::Stmt::Try(_)
+            | ast::Stmt::Assert(_)
+            | ast::Stmt::Import(_)
+            | ast::Stmt::ImportFrom(_)
+            | ast::Stmt::Global(_)
+            | ast::Stmt::Nonlocal(_)
+            | ast::Stmt::Expr(_)
+            | ast::Stmt::Pass(_)
+            | ast::Stmt::Break(_)
+            | ast::Stmt::Continue(_)
+            | ast::Stmt::IpyEscapeCommand(_) => {}
+        }
+
+        source_order::walk_stmt(self, stmt);
+    }
+
+    fn visit_expr(&mut self, expr: &ast::Expr) {
+        let _ty = expr.inferred_type(&self.model);
+
+        source_order::walk_expr(self, expr);
+    }
+
+    fn visit_comprehension(&mut self, comprehension: &ast::Comprehension) {
+        self.visit_expr(&comprehension.iter);
+        self.visit_target(&comprehension.target);
+        for if_expr in &comprehension.ifs {
+            self.visit_expr(if_expr);
+        }
+    }
+
+    fn visit_parameter(&mut self, parameter: &ast::Parameter) {
+        let _ty = parameter.inferred_type(&self.model);
+
+        source_order::walk_parameter(self, parameter);
+    }
+
+    fn visit_parameter_with_default(&mut self, parameter_with_default: &ast::ParameterWithDefault) {
+        let _ty = parameter_with_default.inferred_type(&self.model);
+
+        source_order::walk_parameter_with_default(self, parameter_with_default);
+    }
+
+    fn visit_alias(&mut self, alias: &ast::Alias) {
+        let _ty = alias.inferred_type(&self.model);
+
+        source_order::walk_alias(self, alias);
+    }
+}

crates/ty_python_semantic/src/pull_types.rs

@@ -471,8 +471,10 @@ impl<'db> TypeInference<'db> {
     #[track_caller]
     pub(crate) fn expression_type(&self, expression: ScopedExpressionId) -> Type<'db> {
         self.try_expression_type(expression).expect(
-            "expression should belong to this TypeInference region and \
-            TypeInferenceBuilder should have inferred a type for it",
+            "Failed to retrieve the inferred type for an `ast::Expr` node \
+            passed to `TypeInference::expression_type()`. The `TypeInferenceBuilder` \
+            should infer and store types for all `ast::Expr` nodes in any `TypeInference` \
+            region it analyzes.",
         )
     }
 

crates/ty_python_semantic/src/types/infer.rs

@@ -1,19 +1,15 @@
 use anyhow::{Context, anyhow};
 use ruff_db::Upcast;
 use ruff_db::files::{File, Files, system_path_to_file};
-use ruff_db::parsed::parsed_module;
 use ruff_db::system::{DbWithTestSystem, System, SystemPath, SystemPathBuf, TestSystem};
 use ruff_db::vendored::VendoredFileSystem;
-use ruff_python_ast::visitor::source_order;
-use ruff_python_ast::visitor::source_order::SourceOrderVisitor;
-use ruff_python_ast::{
-    self as ast, Alias, Comprehension, Expr, Parameter, ParameterWithDefault, PythonVersion, Stmt,
-};
+use ruff_python_ast::PythonVersion;
 
 use ty_python_semantic::lint::{LintRegistry, RuleSelection};
+use ty_python_semantic::pull_types::pull_types;
 use ty_python_semantic::{
-    Db, HasType, Program, ProgramSettings, PythonPlatform, PythonVersionSource,
-    PythonVersionWithSource, SearchPathSettings, SemanticModel, default_lint_registry,
+    Program, ProgramSettings, PythonPlatform, PythonVersionSource, PythonVersionWithSource,
+    SearchPathSettings, default_lint_registry,
 };
 
 fn get_cargo_workspace_root() -> anyhow::Result<SystemPathBuf> {
@@ -174,129 +170,6 @@ fn run_corpus_tests(pattern: &str) -> anyhow::Result<()> {
     Ok(())
 }
 
-fn pull_types(db: &dyn Db, file: File) {
-    let mut visitor = PullTypesVisitor::new(db, file);
-
-    let ast = parsed_module(db.upcast(), file).load(db.upcast());
-
-    visitor.visit_body(ast.suite());
-}
-
-struct PullTypesVisitor<'db> {
-    model: SemanticModel<'db>,
-}
-
-impl<'db> PullTypesVisitor<'db> {
-    fn new(db: &'db dyn Db, file: File) -> Self {
-        Self {
-            model: SemanticModel::new(db, file),
-        }
-    }
-
-    fn visit_target(&mut self, target: &Expr) {
-        match target {
-            Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => {
-                for element in elts {
-                    self.visit_target(element);
-                }
-            }
-            _ => self.visit_expr(target),
-        }
-    }
-}
-
-impl SourceOrderVisitor<'_> for PullTypesVisitor<'_> {
-    fn visit_stmt(&mut self, stmt: &Stmt) {
-        match stmt {
-            Stmt::FunctionDef(function) => {
-                let _ty = function.inferred_type(&self.model);
-            }
-            Stmt::ClassDef(class) => {
-                let _ty = class.inferred_type(&self.model);
-            }
-            Stmt::Assign(assign) => {
-                for target in &assign.targets {
-                    self.visit_target(target);
-                }
-                self.visit_expr(&assign.value);
-                return;
-            }
-            Stmt::For(for_stmt) => {
-                self.visit_target(&for_stmt.target);
-                self.visit_expr(&for_stmt.iter);
-                self.visit_body(&for_stmt.body);
-                self.visit_body(&for_stmt.orelse);
-                return;
-            }
-            Stmt::With(with_stmt) => {
-                for item in &with_stmt.items {
-                    if let Some(target) = &item.optional_vars {
-                        self.visit_target(target);
-                    }
-                    self.visit_expr(&item.context_expr);
-                }
-
-                self.visit_body(&with_stmt.body);
-                return;
-            }
-            Stmt::AnnAssign(_)
-            | Stmt::Return(_)
-            | Stmt::Delete(_)
-            | Stmt::AugAssign(_)
-            | Stmt::TypeAlias(_)
-            | Stmt::While(_)
-            | Stmt::If(_)
-            | Stmt::Match(_)
-            | Stmt::Raise(_)
-            | Stmt::Try(_)
-            | Stmt::Assert(_)
-            | Stmt::Import(_)
-            | Stmt::ImportFrom(_)
-            | Stmt::Global(_)
-            | Stmt::Nonlocal(_)
-            | Stmt::Expr(_)
-            | Stmt::Pass(_)
-            | Stmt::Break(_)
-            | Stmt::Continue(_)
-            | Stmt::IpyEscapeCommand(_) => {}
-        }
-
-        source_order::walk_stmt(self, stmt);
-    }
-
-    fn visit_expr(&mut self, expr: &Expr) {
-        let _ty = expr.inferred_type(&self.model);
-
-        source_order::walk_expr(self, expr);
-    }
-
-    fn visit_comprehension(&mut self, comprehension: &Comprehension) {
-        self.visit_expr(&comprehension.iter);
-        self.visit_target(&comprehension.target);
-        for if_expr in &comprehension.ifs {
-            self.visit_expr(if_expr);
-        }
-    }
-
-    fn visit_parameter(&mut self, parameter: &Parameter) {
-        let _ty = parameter.inferred_type(&self.model);
-
-        source_order::walk_parameter(self, parameter);
-    }
-
-    fn visit_parameter_with_default(&mut self, parameter_with_default: &ParameterWithDefault) {
-        let _ty = parameter_with_default.inferred_type(&self.model);
-
-        source_order::walk_parameter_with_default(self, parameter_with_default);
-    }
-
-    fn visit_alias(&mut self, alias: &Alias) {
-        let _ty = alias.inferred_type(&self.model);
-
-        source_order::walk_alias(self, alias);
-    }
-}
-
 /// Whether or not the .py/.pyi version of this file is expected to fail
 #[rustfmt::skip]
 const KNOWN_FAILURES: &[(&str, bool, bool)] = &[

crates/ty_python_semantic/tests/corpus.rs

@@ -18,7 +18,7 @@ ruff_python_trivia = { workspace = true }
 ruff_source_file = { workspace = true }
 ruff_text_size = { workspace = true }
 ruff_python_ast = { workspace = true }
-ty_python_semantic = { workspace = true, features = ["serde"] }
+ty_python_semantic = { workspace = true, features = ["serde", "testing"] }
 ty_vendored = { workspace = true }
 
 anyhow = { workspace = true }

crates/ty_test/Cargo.toml

@@ -17,6 +17,7 @@ use ruff_db::testing::{setup_logging, setup_logging_with_filter};
 use ruff_source_file::{LineIndex, OneIndexed};
 use std::backtrace::BacktraceStatus;
 use std::fmt::Write;
+use ty_python_semantic::pull_types::pull_types;
 use ty_python_semantic::types::check_types;
 use ty_python_semantic::{
     Program, ProgramSettings, PythonPath, PythonPlatform, PythonVersionSource,
@@ -294,6 +295,10 @@ fn run_test(
     let failures: Failures = test_files
         .into_iter()
         .filter_map(|test_file| {
+            if !KNOWN_PULL_TYPES_FAILURES.contains(&&*relative_fixture_path.as_str().replace('\\', "/")) {
+                pull_types(db, test_file.file);
+            }
+
             let parsed = parsed_module(db, test_file.file).load(db);
 
             let mut diagnostics: Vec<Diagnostic> = parsed
@@ -350,6 +355,7 @@ fn run_test(
                     });
                 }
             };
+
             diagnostics.extend(type_diagnostics.into_iter().cloned());
             diagnostics.sort_by(|left, right|left.rendering_sort_key(db).cmp(&right.rendering_sort_key(db)));
 
@@ -363,6 +369,7 @@ fn run_test(
             if test.should_snapshot_diagnostics() {
                 snapshot_diagnostics.extend(diagnostics);
             }
+
             failure
         })
         .collect();
@@ -462,3 +469,11 @@ fn create_diagnostic_snapshot(
     }
     snapshot
 }
+
+const KNOWN_PULL_TYPES_FAILURES: &[&str] = &[
+    "crates/ty_python_semantic/resources/mdtest/annotations/any.md",
+    "crates/ty_python_semantic/resources/mdtest/annotations/callable.md",
+    "crates/ty_python_semantic/resources/mdtest/type_api.md",
+    "crates/ty_python_semantic/resources/mdtest/type_qualifiers/classvar.md",
+    "crates/ty_python_semantic/resources/mdtest/type_qualifiers/final.md",
+];