mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 12:29:28 +00:00
646ff6497c
## Summary
This PR protects against code like:
```python
from typing import Optional
import bar # ruff: noqa
import baz
class Foo:
x: Optional[str] = None
```
In which the user wrote `# ruff: noqa` to ignore a specific error, not
realizing that it was a file-level exemption that thus turned off all
lint rules.
Specifically, if a `# ruff: noqa` directive is not at the start of a
line, we now ignore it and warn, since this is almost certainly a
mistake.
128 lines
4.3 KiB
Rust
128 lines
4.3 KiB
Rust
use ruff_source_file::Locator;
|
|
use ruff_text_size::{TextRange, TextSize};
|
|
|
|
/// Extract the leading indentation from a line.
|
|
pub fn indentation_at_offset<'a>(offset: TextSize, locator: &'a Locator) -> Option<&'a str> {
|
|
let line_start = locator.line_start(offset);
|
|
let indentation = &locator.contents()[TextRange::new(line_start, offset)];
|
|
|
|
if indentation.chars().all(is_python_whitespace) {
|
|
Some(indentation)
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
|
|
/// Return `true` if the node starting the given [`TextSize`] has leading content.
|
|
pub fn has_leading_content(offset: TextSize, locator: &Locator) -> bool {
|
|
let line_start = locator.line_start(offset);
|
|
let leading = &locator.contents()[TextRange::new(line_start, offset)];
|
|
leading.chars().any(|char| !is_python_whitespace(char))
|
|
}
|
|
|
|
/// Return `true` if the node ending at the given [`TextSize`] has trailing content.
|
|
pub fn has_trailing_content(offset: TextSize, locator: &Locator) -> bool {
|
|
let line_end = locator.line_end(offset);
|
|
let trailing = &locator.contents()[TextRange::new(offset, line_end)];
|
|
|
|
for char in trailing.chars() {
|
|
if char == '#' {
|
|
return false;
|
|
}
|
|
if !is_python_whitespace(char) {
|
|
return true;
|
|
}
|
|
}
|
|
false
|
|
}
|
|
|
|
/// Returns `true` for [whitespace](https://docs.python.org/3/reference/lexical_analysis.html#whitespace-between-tokens)
|
|
/// characters.
|
|
pub const fn is_python_whitespace(c: char) -> bool {
|
|
matches!(
|
|
c,
|
|
// Space, tab, or form-feed
|
|
' ' | '\t' | '\x0C'
|
|
)
|
|
}
|
|
|
|
/// Extract the leading indentation from a line.
|
|
pub fn leading_indentation(line: &str) -> &str {
|
|
line.find(|char: char| !is_python_whitespace(char))
|
|
.map_or(line, |index| &line[..index])
|
|
}
|
|
|
|
pub trait PythonWhitespace {
|
|
/// Like `str::trim()`, but only removes whitespace characters that Python considers
|
|
/// to be [whitespace](https://docs.python.org/3/reference/lexical_analysis.html#whitespace-between-tokens).
|
|
fn trim_whitespace(&self) -> &Self;
|
|
|
|
/// Like `str::trim_start()`, but only removes whitespace characters that Python considers
|
|
/// to be [whitespace](https://docs.python.org/3/reference/lexical_analysis.html#whitespace-between-tokens).
|
|
fn trim_whitespace_start(&self) -> &Self;
|
|
|
|
/// Like `str::trim_end()`, but only removes whitespace characters that Python considers
|
|
/// to be [whitespace](https://docs.python.org/3/reference/lexical_analysis.html#whitespace-between-tokens).
|
|
fn trim_whitespace_end(&self) -> &Self;
|
|
}
|
|
|
|
impl PythonWhitespace for str {
|
|
fn trim_whitespace(&self) -> &Self {
|
|
self.trim_matches(is_python_whitespace)
|
|
}
|
|
|
|
fn trim_whitespace_start(&self) -> &Self {
|
|
self.trim_start_matches(is_python_whitespace)
|
|
}
|
|
|
|
fn trim_whitespace_end(&self) -> &Self {
|
|
self.trim_end_matches(is_python_whitespace)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use crate::has_trailing_content;
|
|
use ruff_python_ast::{Ranged, Suite};
|
|
use ruff_python_parser::{Parse, ParseError};
|
|
use ruff_source_file::Locator;
|
|
|
|
#[test]
|
|
fn trailing_content() -> Result<(), ParseError> {
|
|
let contents = "x = 1";
|
|
let program = Suite::parse(contents, "<filename>")?;
|
|
let stmt = program.first().unwrap();
|
|
let locator = Locator::new(contents);
|
|
assert!(!has_trailing_content(stmt.end(), &locator));
|
|
|
|
let contents = "x = 1; y = 2";
|
|
let program = Suite::parse(contents, "<filename>")?;
|
|
let stmt = program.first().unwrap();
|
|
let locator = Locator::new(contents);
|
|
assert!(has_trailing_content(stmt.end(), &locator));
|
|
|
|
let contents = "x = 1 ";
|
|
let program = Suite::parse(contents, "<filename>")?;
|
|
let stmt = program.first().unwrap();
|
|
let locator = Locator::new(contents);
|
|
assert!(!has_trailing_content(stmt.end(), &locator));
|
|
|
|
let contents = "x = 1 # Comment";
|
|
let program = Suite::parse(contents, "<filename>")?;
|
|
let stmt = program.first().unwrap();
|
|
let locator = Locator::new(contents);
|
|
assert!(!has_trailing_content(stmt.end(), &locator));
|
|
|
|
let contents = r#"
|
|
x = 1
|
|
y = 2
|
|
"#
|
|
.trim();
|
|
let program = Suite::parse(contents, "<filename>")?;
|
|
let stmt = program.first().unwrap();
|
|
let locator = Locator::new(contents);
|
|
assert!(!has_trailing_content(stmt.end(), &locator));
|
|
|
|
Ok(())
|
|
}
|
|
}
|