Skip to content
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.

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

Avoid E703 for last expression in a cell #8821

Merged
merged 1 commit into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
94 changes: 94 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pycodestyle/E703.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"id": "33faf7ad-a3fd-4ac4-a0c3-52e507ed49df",
"metadata": {},
"outputs": [],
"source": [
"x = 1"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "481fb4bf-c1b9-47da-927f-3cfdfe4b49ec",
"metadata": {},
"outputs": [],
"source": [
"# Simple case\n",
"x;"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "2f0c65a5-0a0e-4080-afce-5a8ed0d706df",
"metadata": {},
"outputs": [],
"source": [
"# Only skip the last expression\n",
"x; # E703\n",
"x;"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "5a3fd75d-26d9-44f7-b013-1684aabfd0ae",
"metadata": {},
"outputs": [],
"source": [
"# Nested expressions isn't relevant\n",
"if True:\n",
" x;"
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "05eab5b9-e2ba-4954-8ef3-b035a79573fe",
"metadata": {},
"outputs": [],
"source": [
"# Semicolons with multiple expressions\n",
"x; x;"
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "9cbbddc5-83fc-4fdb-81ab-53a3912ae898",
"metadata": {},
"outputs": [],
"source": [
"# Comments, newlines and whitespace\n",
"x; # comment\n",
"\n",
"# another comment"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python (ruff-playground)",
"language": "python",
"name": "ruff-playground"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.3"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
16 changes: 13 additions & 3 deletions crates/ruff_linter/src/checkers/tokens.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

use std::path::Path;

use ruff_notebook::CellOffsets;
use ruff_python_ast::PySourceType;
use ruff_python_parser::lexer::LexResult;
use ruff_python_parser::Tok;

Expand All @@ -25,7 +27,8 @@ pub(crate) fn check_tokens(
locator: &Locator,
indexer: &Indexer,
settings: &LinterSettings,
is_stub: bool,
source_type: PySourceType,
cell_offsets: Option<&CellOffsets>,
) -> Vec<Diagnostic> {
let mut diagnostics: Vec<Diagnostic> = vec![];

Expand Down Expand Up @@ -112,7 +115,14 @@ pub(crate) fn check_tokens(
Rule::MultipleStatementsOnOneLineSemicolon,
Rule::UselessSemicolon,
]) {
pycodestyle::rules::compound_statements(&mut diagnostics, tokens, locator, indexer);
pycodestyle::rules::compound_statements(
&mut diagnostics,
tokens,
locator,
indexer,
source_type,
cell_offsets,
);
}

if settings.rules.enabled(Rule::AvoidableEscapedQuote) && settings.flake8_quotes.avoid_escape {
Expand Down Expand Up @@ -156,7 +166,7 @@ pub(crate) fn check_tokens(
pyupgrade::rules::extraneous_parentheses(&mut diagnostics, tokens, locator);
}

if is_stub && settings.rules.enabled(Rule::TypeCommentInStub) {
if source_type.is_stub() && settings.rules.enabled(Rule::TypeCommentInStub) {
flake8_pyi::rules::type_comment_in_stub(&mut diagnostics, locator, indexer);
}

Expand Down
3 changes: 2 additions & 1 deletion crates/ruff_linter/src/linter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ pub fn check_path(
locator,
indexer,
settings,
source_type.is_stub(),
source_type,
source_kind.as_ipy_notebook().map(Notebook::cell_offsets),
));
}

Expand Down
1 change: 1 addition & 0 deletions crates/ruff_linter/src/rules/pycodestyle/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ mod tests {
#[test_case(Rule::TrueFalseComparison, Path::new("E712.py"))]
#[test_case(Rule::TypeComparison, Path::new("E721.py"))]
#[test_case(Rule::UselessSemicolon, Path::new("E70.py"))]
#[test_case(Rule::UselessSemicolon, Path::new("E703.ipynb"))]
fn rules(rule_code: Rule, path: &Path) -> Result<()> {
let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy());
let diagnostics = test_path(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
use ruff_notebook::CellOffsets;
use ruff_python_ast::PySourceType;
use ruff_python_parser::lexer::LexResult;
use ruff_python_parser::Tok;
use ruff_text_size::TextRange;
use ruff_text_size::{TextRange, TextSize};

use ruff_diagnostics::{AlwaysFixableViolation, Violation};
use ruff_diagnostics::{Diagnostic, Edit, Fix};
Expand Down Expand Up @@ -101,6 +103,8 @@ pub(crate) fn compound_statements(
lxr: &[LexResult],
locator: &Locator,
indexer: &Indexer,
source_type: PySourceType,
cell_offsets: Option<&CellOffsets>,
) {
// Track the last seen instance of a variety of tokens.
let mut colon = None;
Expand All @@ -127,7 +131,13 @@ pub(crate) fn compound_statements(
let mut sqb_count = 0u32;
let mut brace_count = 0u32;

for &(ref tok, range) in lxr.iter().flatten() {
// Track indentation.
let mut indent = 0u32;

// Keep the token iterator to perform lookaheads.
let mut tokens = lxr.iter().flatten();

while let Some(&(ref tok, range)) = tokens.next() {
match tok {
Tok::Lpar => {
par_count = par_count.saturating_add(1);
Expand All @@ -153,6 +163,12 @@ pub(crate) fn compound_statements(
continue;
}
}
Tok::Indent => {
indent = indent.saturating_add(1);
}
Tok::Dedent => {
indent = indent.saturating_sub(1);
}
_ => {}
}

Expand All @@ -163,15 +179,24 @@ pub(crate) fn compound_statements(
match tok {
Tok::Newline => {
if let Some((start, end)) = semi {
let mut diagnostic =
Diagnostic::new(UselessSemicolon, TextRange::new(start, end));
diagnostic.set_fix(Fix::safe_edit(Edit::deletion(
indexer
.preceded_by_continuations(start, locator)
.unwrap_or(start),
end,
)));
diagnostics.push(diagnostic);
if !(source_type.is_ipynb()
&& indent == 0
&& cell_offsets
.and_then(|cell_offsets| cell_offsets.containing_range(range.start()))
.is_some_and(|cell_range| {
!has_non_trivia_tokens_till(tokens.clone(), cell_range.end())
}))
{
let mut diagnostic =
Diagnostic::new(UselessSemicolon, TextRange::new(start, end));
diagnostic.set_fix(Fix::safe_edit(Edit::deletion(
indexer
.preceded_by_continuations(start, locator)
.unwrap_or(start),
end,
)));
diagnostics.push(diagnostic);
}
}

// Reset.
Expand Down Expand Up @@ -309,3 +334,23 @@ pub(crate) fn compound_statements(
};
}
}

/// Returns `true` if there are any non-trivia tokens from the given token
/// iterator till the given end offset.
fn has_non_trivia_tokens_till<'a>(
tokens: impl Iterator<Item = &'a (Tok, TextRange)>,
cell_end: TextSize,
) -> bool {
for &(ref tok, tok_range) in tokens {
if tok_range.start() >= cell_end {
return false;
}
if !matches!(
tok,
Tok::Newline | Tok::Comment(_) | Tok::EndOfFile | Tok::NonLogicalNewline
) {
return true;
}
}
false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
source: crates/ruff_linter/src/rules/pycodestyle/mod.rs
---
E703.ipynb:5:2: E703 [*] Statement ends with an unnecessary semicolon
|
3 | x;
4 | # Only skip the last expression
5 | x; # E703
| ^ E703
6 | x;
7 | # Nested expressions isn't relevant
|
= help: Remove unnecessary semicolon

ℹ Safe fix
2 2 | # Simple case
3 3 | x;
4 4 | # Only skip the last expression
5 |-x; # E703
5 |+x # E703
6 6 | x;
7 7 | # Nested expressions isn't relevant
8 8 | if True:

E703.ipynb:9:6: E703 [*] Statement ends with an unnecessary semicolon
|
7 | # Nested expressions isn't relevant
8 | if True:
9 | x;
| ^ E703
10 | # Semicolons with multiple expressions
11 | x; x;
|
= help: Remove unnecessary semicolon

ℹ Safe fix
6 6 | x;
7 7 | # Nested expressions isn't relevant
8 8 | if True:
9 |- x;
9 |+ x
10 10 | # Semicolons with multiple expressions
11 11 | x; x;
12 12 | # Comments, newlines and whitespace


Loading