mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-26 20:09:22 +00:00
Improve handling of builtin symbols in linter rules (#10919)
Add a new method to the semantic model to simplify and improve the correctness of a common pattern
This commit is contained in:
parent
effd5188c9
commit
f779babc5f
93 changed files with 886 additions and 588 deletions
|
@ -251,12 +251,53 @@ impl<'a> SemanticModel<'a> {
|
|||
}
|
||||
|
||||
/// Return `true` if `member` is bound as a builtin.
|
||||
///
|
||||
/// Note that a "builtin binding" does *not* include explicit lookups via the `builtins`
|
||||
/// module, e.g. `import builtins; builtins.open`. It *only* includes the bindings
|
||||
/// that are pre-populated in Python's global scope before any imports have taken place.
|
||||
pub fn is_builtin(&self, member: &str) -> bool {
|
||||
self.lookup_symbol(member)
|
||||
.map(|binding_id| &self.bindings[binding_id])
|
||||
.is_some_and(|binding| binding.kind.is_builtin())
|
||||
}
|
||||
|
||||
/// If `expr` is a reference to a builtins symbol,
|
||||
/// return the name of that symbol. Else, return `None`.
|
||||
///
|
||||
/// This method returns `true` both for "builtin bindings"
|
||||
/// (present even without any imports, e.g. `open()`), and for explicit lookups
|
||||
/// via the `builtins` module (e.g. `import builtins; builtins.open()`).
|
||||
pub fn resolve_builtin_symbol<'expr>(&'a self, expr: &'expr Expr) -> Option<&'a str>
|
||||
where
|
||||
'expr: 'a,
|
||||
{
|
||||
// Fast path: we only need to worry about name expressions
|
||||
if !self.seen_module(Modules::BUILTINS) {
|
||||
let name = &expr.as_name_expr()?.id;
|
||||
return if self.is_builtin(name) {
|
||||
Some(name)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
}
|
||||
|
||||
// Slow path: we have to consider names and attributes
|
||||
let qualified_name = self.resolve_qualified_name(expr)?;
|
||||
match qualified_name.segments() {
|
||||
["" | "builtins", name] => Some(*name),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// Return `true` if `expr` is a reference to `builtins.$target`,
|
||||
/// i.e. either `object` (where `object` is not overridden in the global scope),
|
||||
/// or `builtins.object` (where `builtins` is imported as a module at the top level)
|
||||
pub fn match_builtin_expr(&self, expr: &Expr, symbol: &str) -> bool {
|
||||
debug_assert!(!symbol.contains('.'));
|
||||
self.resolve_builtin_symbol(expr)
|
||||
.is_some_and(|name| name == symbol)
|
||||
}
|
||||
|
||||
/// Return `true` if `member` is an "available" symbol, i.e., a symbol that has not been bound
|
||||
/// in the current scope, or in any containing scope.
|
||||
pub fn is_available(&self, member: &str) -> bool {
|
||||
|
@ -1138,6 +1179,7 @@ impl<'a> SemanticModel<'a> {
|
|||
pub fn add_module(&mut self, module: &str) {
|
||||
match module {
|
||||
"_typeshed" => self.seen.insert(Modules::TYPESHED),
|
||||
"builtins" => self.seen.insert(Modules::BUILTINS),
|
||||
"collections" => self.seen.insert(Modules::COLLECTIONS),
|
||||
"dataclasses" => self.seen.insert(Modules::DATACLASSES),
|
||||
"datetime" => self.seen.insert(Modules::DATETIME),
|
||||
|
@ -1708,6 +1750,7 @@ bitflags! {
|
|||
const TYPING_EXTENSIONS = 1 << 15;
|
||||
const TYPESHED = 1 << 16;
|
||||
const DATACLASSES = 1 << 17;
|
||||
const BUILTINS = 1 << 18;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue