Skip to content

Commit

Permalink
Allow matplotlib.use calls to intersperse imports (#9094)
Browse files Browse the repository at this point in the history
This PR allows `matplotlib.use` calls to intersperse imports without
triggering `E402`. This is a pragmatic choice as it's common to require
`matplotlib.use` calls prior to importing from within `matplotlib`
itself.

Closes #9091.
  • Loading branch information
charliermarsh authored Dec 11, 2023
1 parent 07380e0 commit f452bf8
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 30 deletions.
18 changes: 12 additions & 6 deletions crates/ruff_linter/resources/test/fixtures/pycodestyle/E402.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,27 @@

import f

__some__magic = 1
import matplotlib

matplotlib.use("Agg")

import g

__some__magic = 1

import h


def foo() -> None:
import h
import i


if __name__ == "__main__":
import i
import j

import j; import k
import k; import l


if __name__ == "__main__":
import l; \
import m
import m; \
import n
1 change: 1 addition & 0 deletions crates/ruff_linter/src/checkers/ast/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ where
if !(self.semantic.seen_import_boundary()
|| helpers::is_assignment_to_a_dunder(stmt)
|| helpers::in_nested_block(self.semantic.current_statements())
|| imports::is_matplotlib_activation(stmt, self.semantic())
|| self.settings.preview.is_enabled()
&& imports::is_sys_path_modification(stmt, self.semantic()))
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,50 @@ E402.py:25:1: E402 Module level import not at top of file
25 | import f
| ^^^^^^^^ E402
26 |
27 | __some__magic = 1
27 | import matplotlib
|

E402.py:29:1: E402 Module level import not at top of file
E402.py:27:1: E402 Module level import not at top of file
|
27 | __some__magic = 1
25 | import f
26 |
27 | import matplotlib
| ^^^^^^^^^^^^^^^^^ E402
28 |
29 | import g
29 | matplotlib.use("Agg")
|

E402.py:31:1: E402 Module level import not at top of file
|
29 | matplotlib.use("Agg")
30 |
31 | import g
| ^^^^^^^^ E402
32 |
33 | __some__magic = 1
|

E402.py:35:1: E402 Module level import not at top of file
|
33 | __some__magic = 1
34 |
35 | import h
| ^^^^^^^^ E402
|

E402.py:39:1: E402 Module level import not at top of file
E402.py:45:1: E402 Module level import not at top of file
|
37 | import i
38 |
39 | import j; import k
43 | import j
44 |
45 | import k; import l
| ^^^^^^^^ E402
|

E402.py:39:11: E402 Module level import not at top of file
E402.py:45:11: E402 Module level import not at top of file
|
37 | import i
38 |
39 | import j; import k
43 | import j
44 |
45 | import k; import l
| ^^^^^^^^ E402
|

Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
source: crates/ruff_linter/src/rules/pycodestyle/mod.rs
---
E402.py:29:1: E402 Module level import not at top of file
E402.py:35:1: E402 Module level import not at top of file
|
27 | __some__magic = 1
28 |
29 | import g
33 | __some__magic = 1
34 |
35 | import h
| ^^^^^^^^ E402
|

E402.py:39:1: E402 Module level import not at top of file
E402.py:45:1: E402 Module level import not at top of file
|
37 | import i
38 |
39 | import j; import k
43 | import j
44 |
45 | import k; import l
| ^^^^^^^^ E402
|

E402.py:39:11: E402 Module level import not at top of file
E402.py:45:11: E402 Module level import not at top of file
|
37 | import i
38 |
39 | import j; import k
43 | import j
44 |
45 | import k; import l
| ^^^^^^^^ E402
|

Expand Down
18 changes: 18 additions & 0 deletions crates/ruff_python_semantic/src/analyze/imports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,21 @@ pub fn is_sys_path_modification(stmt: &Stmt, semantic: &SemanticModel) -> bool {
)
})
}

/// Returns `true` if a [`Stmt`] is a `matplotlib.use` activation, as in:
/// ```python
/// import matplotlib
///
/// matplotlib.use("Agg")
/// ```
pub fn is_matplotlib_activation(stmt: &Stmt, semantic: &SemanticModel) -> bool {
let Stmt::Expr(ast::StmtExpr { value, range: _ }) = stmt else {
return false;
};
let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() else {
return false;
};
semantic
.resolve_call_path(func.as_ref())
.is_some_and(|call_path| matches!(call_path.as_slice(), ["matplotlib", "use"]))
}

0 comments on commit f452bf8

Please sign in to comment.