mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 12:29:28 +00:00
a6d3d2fccd
Support using `reveal_type` without importing it, as implied by the type spec and supported by existing type checkers. We use `typing_extensions.reveal_type` for the implicit built-in; this way it exists on all Python versions. (It imports from `typing` on newer Python versions.) Emits an "undefined name" diagnostic whenever `reveal_type` is referenced in this way (in addition to the revealed-type diagnostic when it is called). This follows the mypy example (with `--enable-error-code unimported-reveal`) and I think provides a good (and easily understandable) balance for user experience. If you are using `reveal_type` for quick temporary debugging, the additional undefined-name diagnostic doesn't hinder that use case. If we make the revealed-type diagnostic a non-failing one, the undefined-name diagnostic can still be a failing diagnostic, helping prevent accidentally leaving it in place. For any use cases where you want to leave it in place, you can always import it to avoid the undefined-name diagnostic. In the future, we can easily provide configuration options to a) turn off builtin-reveal_type altogether, and/or b) silence the undefined-name diagnostic when using it, if we have users on either side (loving or hating pseudo-builtin `reveal_type`) who are dissatisfied with this compromise.
87 lines
3.1 KiB
Rust
87 lines
3.1 KiB
Rust
use crate::module_name::ModuleName;
|
|
use crate::module_resolver::resolve_module;
|
|
use crate::semantic_index::global_scope;
|
|
use crate::semantic_index::symbol::ScopeId;
|
|
use crate::types::{global_symbol_ty, Type};
|
|
use crate::Db;
|
|
|
|
/// Enumeration of various core stdlib modules, for which we have dedicated Salsa queries.
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
enum CoreStdlibModule {
|
|
Builtins,
|
|
Types,
|
|
Typeshed,
|
|
TypingExtensions,
|
|
}
|
|
|
|
impl CoreStdlibModule {
|
|
fn name(self) -> ModuleName {
|
|
let module_name = match self {
|
|
Self::Builtins => "builtins",
|
|
Self::Types => "types",
|
|
Self::Typeshed => "_typeshed",
|
|
Self::TypingExtensions => "typing_extensions",
|
|
};
|
|
ModuleName::new_static(module_name)
|
|
.unwrap_or_else(|| panic!("{module_name} should be a valid module name!"))
|
|
}
|
|
}
|
|
|
|
/// Lookup the type of `symbol` in a given core module
|
|
///
|
|
/// Returns `Unbound` if the given core module cannot be resolved for some reason
|
|
fn core_module_symbol_ty<'db>(
|
|
db: &'db dyn Db,
|
|
core_module: CoreStdlibModule,
|
|
symbol: &str,
|
|
) -> Type<'db> {
|
|
resolve_module(db, core_module.name())
|
|
.map(|module| global_symbol_ty(db, module.file(), symbol))
|
|
.unwrap_or(Type::Unbound)
|
|
}
|
|
|
|
/// Lookup the type of `symbol` in the builtins namespace.
|
|
///
|
|
/// Returns `Unbound` if the `builtins` module isn't available for some reason.
|
|
#[inline]
|
|
pub(crate) fn builtins_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> {
|
|
core_module_symbol_ty(db, CoreStdlibModule::Builtins, symbol)
|
|
}
|
|
|
|
/// Lookup the type of `symbol` in the `types` module namespace.
|
|
///
|
|
/// Returns `Unbound` if the `types` module isn't available for some reason.
|
|
#[inline]
|
|
pub(crate) fn types_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> {
|
|
core_module_symbol_ty(db, CoreStdlibModule::Types, symbol)
|
|
}
|
|
|
|
/// Lookup the type of `symbol` in the `_typeshed` module namespace.
|
|
///
|
|
/// Returns `Unbound` if the `_typeshed` module isn't available for some reason.
|
|
#[inline]
|
|
pub(crate) fn typeshed_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> {
|
|
core_module_symbol_ty(db, CoreStdlibModule::Typeshed, symbol)
|
|
}
|
|
|
|
/// Lookup the type of `symbol` in the `typing_extensions` module namespace.
|
|
///
|
|
/// Returns `Unbound` if the `typing_extensions` module isn't available for some reason.
|
|
#[inline]
|
|
pub(crate) fn typing_extensions_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> {
|
|
core_module_symbol_ty(db, CoreStdlibModule::TypingExtensions, symbol)
|
|
}
|
|
|
|
/// Get the scope of a core stdlib module.
|
|
///
|
|
/// Can return `None` if a custom typeshed is used that is missing the core module in question.
|
|
fn core_module_scope(db: &dyn Db, core_module: CoreStdlibModule) -> Option<ScopeId<'_>> {
|
|
resolve_module(db, core_module.name()).map(|module| global_scope(db, module.file()))
|
|
}
|
|
|
|
/// Get the `builtins` module scope.
|
|
///
|
|
/// Can return `None` if a custom typeshed is used that is missing `builtins.pyi`.
|
|
pub(crate) fn builtins_module_scope(db: &dyn Db) -> Option<ScopeId<'_>> {
|
|
core_module_scope(db, CoreStdlibModule::Builtins)
|
|
}
|