mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-16 01:25:11 +00:00
Ensure that tab characters aren't in multi-line strings before throwing a violation (#3837)
This commit is contained in:
parent
454c6d9c2f
commit
abaf0a198d
6 changed files with 131 additions and 78 deletions
|
@ -5,30 +5,47 @@ use rustpython_parser::ast::Location;
|
|||
use rustpython_parser::lexer::LexResult;
|
||||
use rustpython_parser::Tok;
|
||||
|
||||
use crate::types::Range;
|
||||
|
||||
pub struct Indexer {
|
||||
commented_lines: Vec<usize>,
|
||||
continuation_lines: Vec<usize>,
|
||||
string_ranges: Vec<Range>,
|
||||
}
|
||||
|
||||
impl Indexer {
|
||||
/// Return a slice of all lines that include a comment.
|
||||
pub fn commented_lines(&self) -> &[usize] {
|
||||
&self.commented_lines
|
||||
}
|
||||
|
||||
/// Return a slice of all lines that end with a continuation (backslash).
|
||||
pub fn continuation_lines(&self) -> &[usize] {
|
||||
&self.continuation_lines
|
||||
}
|
||||
|
||||
/// Return a slice of all ranges that include a triple-quoted string.
|
||||
pub fn string_ranges(&self) -> &[Range] {
|
||||
&self.string_ranges
|
||||
}
|
||||
}
|
||||
|
||||
impl From<&[LexResult]> for Indexer {
|
||||
fn from(lxr: &[LexResult]) -> Self {
|
||||
let mut commented_lines = Vec::new();
|
||||
let mut continuation_lines = Vec::new();
|
||||
let mut string_ranges = Vec::new();
|
||||
let mut prev: Option<(&Location, &Tok, &Location)> = None;
|
||||
for (start, tok, end) in lxr.iter().flatten() {
|
||||
if matches!(tok, Tok::Comment(_)) {
|
||||
commented_lines.push(start.row());
|
||||
match tok {
|
||||
Tok::Comment(..) => commented_lines.push(start.row()),
|
||||
Tok::String {
|
||||
triple_quoted: true,
|
||||
..
|
||||
} => string_ranges.push(Range::new(*start, *end)),
|
||||
_ => (),
|
||||
}
|
||||
|
||||
if let Some((.., prev_tok, prev_end)) = prev {
|
||||
if !matches!(
|
||||
prev_tok,
|
||||
|
@ -44,16 +61,19 @@ impl From<&[LexResult]> for Indexer {
|
|||
Self {
|
||||
commented_lines,
|
||||
continuation_lines,
|
||||
string_ranges,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use rustpython_parser::ast::Location;
|
||||
use rustpython_parser::lexer::LexResult;
|
||||
use rustpython_parser::{lexer, Mode};
|
||||
|
||||
use crate::source_code::Indexer;
|
||||
use crate::types::Range;
|
||||
|
||||
#[test]
|
||||
fn continuation() {
|
||||
|
@ -114,4 +134,56 @@ import os
|
|||
let indexer: Indexer = lxr.as_slice().into();
|
||||
assert_eq!(indexer.continuation_lines(), [9, 12]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn string_ranges() {
|
||||
let contents = r#""this is a single-quoted string""#;
|
||||
let lxr: Vec<LexResult> = lexer::lex(contents, Mode::Module).collect();
|
||||
let indexer: Indexer = lxr.as_slice().into();
|
||||
assert_eq!(indexer.string_ranges(), &vec![]);
|
||||
|
||||
let contents = r#"
|
||||
"""
|
||||
this is a multiline string
|
||||
"""
|
||||
"#;
|
||||
let lxr: Vec<LexResult> = lexer::lex(contents, Mode::Module).collect();
|
||||
let indexer: Indexer = lxr.as_slice().into();
|
||||
assert_eq!(
|
||||
indexer.string_ranges(),
|
||||
&vec![Range::new(Location::new(2, 12), Location::new(4, 15))]
|
||||
);
|
||||
|
||||
let contents = r#"
|
||||
"""
|
||||
'''this is a multiline string with multiple delimiter types'''
|
||||
"""
|
||||
"#;
|
||||
let lxr: Vec<LexResult> = lexer::lex(contents, Mode::Module).collect();
|
||||
let indexer: Indexer = lxr.as_slice().into();
|
||||
assert_eq!(
|
||||
indexer.string_ranges(),
|
||||
&vec![Range::new(Location::new(2, 12), Location::new(4, 15))]
|
||||
);
|
||||
|
||||
let contents = r#"
|
||||
"""
|
||||
this is one
|
||||
multiline string
|
||||
"""
|
||||
"""
|
||||
and this is
|
||||
another
|
||||
"""
|
||||
"#;
|
||||
let lxr: Vec<LexResult> = lexer::lex(contents, Mode::Module).collect();
|
||||
let indexer: Indexer = lxr.as_slice().into();
|
||||
assert_eq!(
|
||||
indexer.string_ranges(),
|
||||
&vec![
|
||||
Range::new(Location::new(2, 12), Location::new(5, 15)),
|
||||
Range::new(Location::new(6, 12), Location::new(9, 15))
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue