mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-29 13:24:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[syntax-errors]: import from * only allowed at module scope (F406) (#20166)
Some checks are pending
CI / Determine changes (push) Waiting to run
Details
CI / cargo fmt (push) Waiting to run
Details
CI / cargo clippy (push) Blocked by required conditions
Details
CI / cargo test (linux) (push) Blocked by required conditions
Details
CI / cargo test (linux, release) (push) Blocked by required conditions
Details
CI / cargo test (windows) (push) Blocked by required conditions
Details
CI / cargo test (wasm) (push) Blocked by required conditions
Details
CI / cargo build (release) (push) Waiting to run
Details
CI / cargo build (msrv) (push) Blocked by required conditions
Details
CI / cargo fuzz build (push) Blocked by required conditions
Details
CI / fuzz parser (push) Blocked by required conditions
Details
CI / test scripts (push) Blocked by required conditions
Details
CI / ecosystem (push) Blocked by required conditions
Details
CI / Fuzz for new ty panics (push) Blocked by required conditions
Details
CI / cargo shear (push) Blocked by required conditions
Details
CI / python package (push) Waiting to run
Details
CI / pre-commit (push) Waiting to run
Details
CI / mkdocs (push) Waiting to run
Details
CI / formatter instabilities and black similarity (push) Blocked by required conditions
Details
CI / test ruff-lsp (push) Blocked by required conditions
Details
CI / check playground (push) Blocked by required conditions
Details
CI / benchmarks-instrumented (push) Blocked by required conditions
Details
CI / benchmarks-walltime (push) Blocked by required conditions
Details
[ty Playground] Release / publish (push) Waiting to run
Details

Browse source 
<!--
Thank you for contributing to Ruff/ty! To help us out with reviewing,
please consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title? (Please prefix
with `[ty]` for ty pull
  requests.)
- Does this pull request include references to any relevant issues?
-->

## Summary

This PR implements F406
https://docs.astral.sh/ruff/rules/undefined-local-with-nested-import-star-usage/
as a semantic syntax error

## Test Plan

I have written inline tests as directed in #17412

---------

Signed-off-by: 11happy <soni5happy@gmail.com>
This commit is contained in:
Bhuminjay Soni 2025-09-17 01:23:28 +05:30 • committed by GitHub
parent 8a027b0d74
commit c3f2187fda
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 373 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

12
crates/ruff_linter/src/checkers/ast/analyze/statement.rs
View file

@ -1,7 +1,6 @@
use ruff_python_ast::helpers;
use ruff_python_ast::types::Node;
use ruff_python_ast::{self as ast, Expr, Stmt};
use ruff_python_semantic::ScopeKind;
use ruff_text_size::Ranged;
use crate::checkers::ast::Checker;
@ -809,17 +808,6 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) {
pyflakes::rules::future_feature_not_defined(checker, alias);
}
} else if &alias.name == "*" {
// F406
if checker.is_rule_enabled(Rule::UndefinedLocalWithNestedImportStarUsage) {
if !matches!(checker.semantic.current_scope().kind, ScopeKind::Module) {
checker.report_diagnostic(
pyflakes::rules::UndefinedLocalWithNestedImportStarUsage {
name: helpers::format_import_from(level, module).to_string(),
},
stmt.range(),
);
}
}
// F403
checker.report_diagnostic_if_enabled(
pyflakes::rules::UndefinedLocalWithImportStar {

2
crates/ruff_linter/src/checkers/ast/analyze/unresolved_references.rs
View file

@ -13,7 +13,7 @@ pub(crate) fn unresolved_references(checker: &Checker) {
for reference in checker.semantic.unresolved_references() {
if reference.is_wildcard_import() {
// F406
// F405
checker.report_diagnostic_if_enabled(
pyflakes::rules::UndefinedLocalWithImportStarUsage {
name: reference.name(checker.source()).to_string(),

11
crates/ruff_linter/src/checkers/ast/mod.rs
View file

@ -69,7 +69,8 @@ use crate::package::PackageRoot;
use crate::preview::is_undefined_export_in_dunder_init_enabled;
use crate::registry::Rule;
use crate::rules::pyflakes::rules::{
LateFutureImport, ReturnOutsideFunction, YieldOutsideFunction,
LateFutureImport, ReturnOutsideFunction, UndefinedLocalWithNestedImportStarUsage,
YieldOutsideFunction,
};
use crate::rules::pylint::rules::{
AwaitOutsideAsync, LoadBeforeGlobalDeclaration, YieldFromInAsyncFunction,
@ -659,6 +660,14 @@ impl SemanticSyntaxContext for Checker<'_> {
self.report_diagnostic(YieldOutsideFunction::new(kind), error.range);
}
}
SemanticSyntaxErrorKind::NonModuleImportStar(name) => {
if self.is_rule_enabled(Rule::UndefinedLocalWithNestedImportStarUsage) {
self.report_diagnostic(
UndefinedLocalWithNestedImportStarUsage { name },
error.range,
);
}
}
SemanticSyntaxErrorKind::ReturnOutsideFunction => {
// F706
if self.is_rule_enabled(Rule::ReturnOutsideFunction) {

8
crates/ruff_python_parser/resources/inline/err/import_from_star.py Normal file
View file

@ -0,0 +1,8 @@
def f1():
from module import *
class C:
from module import *
def f2():
from ..module import *
def f3():
from module import *, *

1
crates/ruff_python_parser/resources/inline/ok/import_from_star.py Normal file
View file

@ -0,0 +1 @@
from module import *

42
crates/ruff_python_parser/src/semantic_errors.rs
View file

@ -3,16 +3,16 @@
//! This checker is not responsible for traversing the AST itself. Instead, its
//! [`SemanticSyntaxChecker::visit_stmt`] and [`SemanticSyntaxChecker::visit_expr`] methods should
//! be called in a parent `Visitor`'s `visit_stmt` and `visit_expr` methods, respectively.
use std::fmt::Display;
use ruff_python_ast::{
self as ast, Expr, ExprContext, IrrefutablePatternKind, Pattern, PythonVersion, Stmt, StmtExpr,
StmtImportFrom,
comparable::ComparableExpr,
helpers,
visitor::{Visitor, walk_expr},
};
use ruff_text_size::{Ranged, TextRange, TextSize};
use rustc_hash::{FxBuildHasher, FxHashSet};
use std::fmt::Display;
#[derive(Debug, Default)]
pub struct SemanticSyntaxChecker {
@ -58,10 +58,40 @@ impl SemanticSyntaxChecker {
fn check_stmt<Ctx: SemanticSyntaxContext>(&mut self, stmt: &ast::Stmt, ctx: &Ctx) {
match stmt {
Stmt::ImportFrom(StmtImportFrom { range, module, .. }) => {
Stmt::ImportFrom(StmtImportFrom {
range,
module,
level,
names,
..
}) => {
if self.seen_futures_boundary && matches!(module.as_deref(), Some("__future__")) {
Self::add_error(ctx, SemanticSyntaxErrorKind::LateFutureImport, *range);
}
for alias in names {
if alias.name.as_str() == "*" && !ctx.in_module_scope() {
// test_err import_from_star
// def f1():
// from module import *
// class C:
// from module import *
// def f2():
// from ..module import *
// def f3():
// from module import *, *
// test_ok import_from_star
// from module import *
Self::add_error(
ctx,
SemanticSyntaxErrorKind::NonModuleImportStar(
helpers::format_import_from(*level, module.as_deref()).to_string(),
),
*range,
);
break;
}
}
}
Stmt::Match(match_stmt) => {
Self::irrefutable_match_case(match_stmt, ctx);
@ -1002,6 +1032,9 @@ impl Display for SemanticSyntaxError {
SemanticSyntaxErrorKind::YieldFromInAsyncFunction => {
f.write_str("`yield from` statement in async function; use `async for` instead")
}
SemanticSyntaxErrorKind::NonModuleImportStar(name) => {
write!(f, "`from {name} import *` only allowed at module level")
}
}
}
}
@ -1362,6 +1395,9 @@ pub enum SemanticSyntaxErrorKind {
/// Represents the use of `yield from` inside an asynchronous function.
YieldFromInAsyncFunction,
/// Represents the use of `from <module> import *` outside module scope.
NonModuleImportStar(String),
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, get_size2::GetSize)]

271
crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_from_star.py.snap Normal file
View file

@ -0,0 +1,271 @@
---
source: crates/ruff_python_parser/tests/fixtures.rs
input_file: crates/ruff_python_parser/resources/inline/err/import_from_star.py
---
## AST
```
Module(
ModModule {
node_index: NodeIndex(None),
range: 0..144,
body: [
FunctionDef(
StmtFunctionDef {
node_index: NodeIndex(None),
range: 0..34,
is_async: false,
decorator_list: [],
name: Identifier {
id: Name("f1"),
range: 4..6,
node_index: NodeIndex(None),
},
type_params: None,
parameters: Parameters {
range: 6..8,
node_index: NodeIndex(None),
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [],
kwarg: None,
},
returns: None,
body: [
ImportFrom(
StmtImportFrom {
node_index: NodeIndex(None),
range: 14..34,
module: Some(
Identifier {
id: Name("module"),
range: 19..25,
node_index: NodeIndex(None),
},
),
names: [
Alias {
range: 33..34,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 33..34,
node_index: NodeIndex(None),
},
asname: None,
},
],
level: 0,
},
),
],
},
),
ClassDef(
StmtClassDef {
node_index: NodeIndex(None),
range: 35..68,
decorator_list: [],
name: Identifier {
id: Name("C"),
range: 41..42,
node_index: NodeIndex(None),
},
type_params: None,
arguments: None,
body: [
ImportFrom(
StmtImportFrom {
node_index: NodeIndex(None),
range: 48..68,
module: Some(
Identifier {
id: Name("module"),
range: 53..59,
node_index: NodeIndex(None),
},
),
names: [
Alias {
range: 67..68,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 67..68,
node_index: NodeIndex(None),
},
asname: None,
},
],
level: 0,
},
),
],
},
),
FunctionDef(
StmtFunctionDef {
node_index: NodeIndex(None),
range: 69..105,
is_async: false,
decorator_list: [],
name: Identifier {
id: Name("f2"),
range: 73..75,
node_index: NodeIndex(None),
},
type_params: None,
parameters: Parameters {
range: 75..77,
node_index: NodeIndex(None),
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [],
kwarg: None,
},
returns: None,
body: [
ImportFrom(
StmtImportFrom {
node_index: NodeIndex(None),
range: 83..105,
module: Some(
Identifier {
id: Name("module"),
range: 90..96,
node_index: NodeIndex(None),
},
),
names: [
Alias {
range: 104..105,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 104..105,
node_index: NodeIndex(None),
},
asname: None,
},
],
level: 2,
},
),
],
},
),
FunctionDef(
StmtFunctionDef {
node_index: NodeIndex(None),
range: 106..143,
is_async: false,
decorator_list: [],
name: Identifier {
id: Name("f3"),
range: 110..112,
node_index: NodeIndex(None),
},
type_params: None,
parameters: Parameters {
range: 112..114,
node_index: NodeIndex(None),
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [],
kwarg: None,
},
returns: None,
body: [
ImportFrom(
StmtImportFrom {
node_index: NodeIndex(None),
range: 120..143,
module: Some(
Identifier {
id: Name("module"),
range: 125..131,
node_index: NodeIndex(None),
},
),
names: [
Alias {
range: 139..140,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 139..140,
node_index: NodeIndex(None),
},
asname: None,
},
Alias {
range: 142..143,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 142..143,
node_index: NodeIndex(None),
},
asname: None,
},
],
level: 0,
},
),
],
},
),
],
},
)
```
## Errors
|
6 | from ..module import *
7 | def f3():
8 | from module import *, *
| ^^^^ Syntax Error: Star import must be the only import
|
## Semantic Syntax Errors
|
1 | def f1():
2 | from module import *
| ^^^^^^^^^^^^^^^^^^^^ Syntax Error: `from module import *` only allowed at module level
3 | class C:
4 | from module import *
|
|
2 | from module import *
3 | class C:
4 | from module import *
| ^^^^^^^^^^^^^^^^^^^^ Syntax Error: `from module import *` only allowed at module level
5 | def f2():
6 | from ..module import *
|
|
4 | from module import *
5 | def f2():
6 | from ..module import *
| ^^^^^^^^^^^^^^^^^^^^^^ Syntax Error: `from ..module import *` only allowed at module level
7 | def f3():
8 | from module import *, *
|
|
6 | from ..module import *
7 | def f3():
8 | from module import *, *
| ^^^^^^^^^^^^^^^^^^^^^^^ Syntax Error: `from module import *` only allowed at module level
|

42
crates/ruff_python_parser/tests/snapshots/valid_syntax@import_from_star.py.snap Normal file
View file

@ -0,0 +1,42 @@
---
source: crates/ruff_python_parser/tests/fixtures.rs
input_file: crates/ruff_python_parser/resources/inline/ok/import_from_star.py
---
## AST
```
Module(
ModModule {
node_index: NodeIndex(None),
range: 0..21,
body: [
ImportFrom(
StmtImportFrom {
node_index: NodeIndex(None),
range: 0..20,
module: Some(
Identifier {
id: Name("module"),
range: 5..11,
node_index: NodeIndex(None),
},
),
names: [
Alias {
range: 19..20,
node_index: NodeIndex(None),
name: Identifier {
id: Name("*"),
range: 19..20,
node_index: NodeIndex(None),
},
asname: None,
},
],
level: 0,
},
),
],
},
)
```

2
crates/ty_python_semantic/resources/mdtest/import/star.md
View file

@ -1399,7 +1399,7 @@ X: bool = True
```py
def f():
# TODO: we should emit a syntax error here (tracked by https://github.com/astral-sh/ruff/issues/17412)
# error: [invalid-syntax]
from exporter import *
# error: [unresolved-reference]