Skip to content

[ty] Keep track of type qualifiers in stub declarations without right-hand side #19756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharkdp merged 1 commit into from
Aug 5, 2025
Merged

[ty] Keep track of type qualifiers in stub declarations without right-hand side #19756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions crates/ty_python_semantic/resources/mdtest/type_qualifiers/classvar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,29 @@ c.d = 2
c.e = 2
```

## From stubs

This is a regression test for a bug where we did not properly keep track of type qualifiers when
accessed from stub files.

`module.pyi`:

```pyi
from typing import ClassVar

class C:
a: ClassVar[int]
```

`main.py`:

```py
from module import C

c = C()
c.a = 2 # error: [invalid-attribute-access]
```

## Conflicting type qualifiers

We currently ignore conflicting qualifiers and simply union them, which is more conservative than
Expand Down
42 changes: 25 additions & 17 deletions crates/ty_python_semantic/src/types/infer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,14 +694,20 @@ enum IntersectionOn {
#[derive(Debug, Clone, PartialEq, Eq)]
enum DeclaredAndInferredType<'db> {
/// We know that both the declared and inferred types are the same.
AreTheSame(Type<'db>),
AreTheSame(TypeAndQualifiers<'db>),
/// Declared and inferred types might be different, we need to check assignability.
MightBeDifferent {
declared_ty: TypeAndQualifiers<'db>,
inferred_ty: Type<'db>,
},
}

impl<'db> DeclaredAndInferredType<'db> {
fn are_the_same_type(ty: Type<'db>) -> Self {
Self::AreTheSame(ty.into())
}
}

/// Builder to infer all types in a region.
///
/// A builder is used by creating it with [`new()`](TypeInferenceBuilder::new), and then calling
Expand Down Expand Up @@ -2132,7 +2138,9 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
);

let (declared_ty, inferred_ty) = match *declared_and_inferred_ty {
DeclaredAndInferredType::AreTheSame(ty) => (ty.into(), ty),
DeclaredAndInferredType::AreTheSame(type_and_qualifiers) => {
(type_and_qualifiers, type_and_qualifiers.inner_type())
}
DeclaredAndInferredType::MightBeDifferent {
declared_ty,
inferred_ty,
Expand Down Expand Up @@ -2191,7 +2199,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
node,
definition,
&DeclaredAndInferredType::AreTheSame(Type::unknown()),
&DeclaredAndInferredType::are_the_same_type(Type::unknown()),
);
}

Expand Down Expand Up @@ -2658,7 +2666,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
function.into(),
definition,
&DeclaredAndInferredType::AreTheSame(inferred_ty),
&DeclaredAndInferredType::are_the_same_type(inferred_ty),
);
}

Expand Down Expand Up @@ -2818,7 +2826,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
.as_ref()
.is_some_and(|d| d.is_ellipsis_literal_expr())
{
DeclaredAndInferredType::AreTheSame(declared_ty)
DeclaredAndInferredType::are_the_same_type(declared_ty)
} else {
if let Some(builder) = self
.context
Expand All @@ -2831,10 +2839,10 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
declared_ty.display(self.db())
));
}
DeclaredAndInferredType::AreTheSame(declared_ty)
DeclaredAndInferredType::are_the_same_type(declared_ty)
}
} else {
DeclaredAndInferredType::AreTheSame(declared_ty)
DeclaredAndInferredType::are_the_same_type(declared_ty)
};
self.add_declaration_with_binding(
parameter.into(),
Expand Down Expand Up @@ -2874,7 +2882,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
parameter.into(),
definition,
&DeclaredAndInferredType::AreTheSame(ty),
&DeclaredAndInferredType::are_the_same_type(ty),
);
} else {
self.add_binding(
Expand Down Expand Up @@ -2906,7 +2914,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
parameter.into(),
definition,
&DeclaredAndInferredType::AreTheSame(ty),
&DeclaredAndInferredType::are_the_same_type(ty),
);
} else {
self.add_binding(
Expand Down Expand Up @@ -3004,7 +3012,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
class_node.into(),
definition,
&DeclaredAndInferredType::AreTheSame(class_ty),
&DeclaredAndInferredType::are_the_same_type(class_ty),
);

// if there are type parameters, then the keywords and bases are within that scope
Expand Down Expand Up @@ -3078,7 +3086,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
type_alias.into(),
definition,
&DeclaredAndInferredType::AreTheSame(type_alias_ty),
&DeclaredAndInferredType::are_the_same_type(type_alias_ty),
);
}

Expand Down Expand Up @@ -3433,7 +3441,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
node.into(),
definition,
&DeclaredAndInferredType::AreTheSame(ty),
&DeclaredAndInferredType::are_the_same_type(ty),
);
}

Expand All @@ -3453,7 +3461,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
node.into(),
definition,
&DeclaredAndInferredType::AreTheSame(pep_695_todo),
&DeclaredAndInferredType::are_the_same_type(pep_695_todo),
);
}

Expand All @@ -3473,7 +3481,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
node.into(),
definition,
&DeclaredAndInferredType::AreTheSame(pep_695_todo),
&DeclaredAndInferredType::are_the_same_type(pep_695_todo),
);
}

Expand Down Expand Up @@ -4557,7 +4565,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
target.into(),
definition,
&DeclaredAndInferredType::AreTheSame(declared.inner_type()),
&DeclaredAndInferredType::AreTheSame(declared),
);
} else {
self.add_declaration(target.into(), definition, declared);
Expand Down Expand Up @@ -4875,7 +4883,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
alias.into(),
definition,
&DeclaredAndInferredType::AreTheSame(binding_ty),
&DeclaredAndInferredType::are_the_same_type(binding_ty),
);
}

Expand Down Expand Up @@ -5124,7 +5132,7 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
self.add_declaration_with_binding(
alias.into(),
definition,
&DeclaredAndInferredType::AreTheSame(submodule_type),
&DeclaredAndInferredType::are_the_same_type(submodule_type),
);
return;
}
Expand Down
Loading