1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
use ruff_text_size::TextRange;
use crate::{PythonWhitespace, is_python_whitespace};
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum SuppressionKind {
/// A `fmt: off` or `yapf: disable` comment
Off,
/// A `fmt: on` or `yapf: enable` comment
On,
/// A `fmt: skip` comment
Skip,
}
impl SuppressionKind {
/// Attempts to identify the `kind` of a `comment`.
/// The comment string should be the full line with the comment on it.
pub fn from_comment(comment: &str) -> Option<Self> {
// Match against `# fmt: on`, `# fmt: off`, `# yapf: disable`, and `# yapf: enable`, which
// must be on their own lines.
let trimmed = comment
.strip_prefix('#')
.unwrap_or(comment)
.trim_whitespace();
if let Some(command) = trimmed.strip_prefix("fmt:") {
match command.trim_whitespace_start() {
"off" => return Some(Self::Off),
"on" => return Some(Self::On),
"skip" => return Some(Self::Skip),
_ => {}
}
} else if let Some(command) = trimmed.strip_prefix("yapf:") {
match command.trim_whitespace_start() {
"disable" => return Some(Self::Off),
"enable" => return Some(Self::On),
_ => {}
}
}
// Search for `# fmt: skip` comments, which can be interspersed with other comments (e.g.,
// `# fmt: skip # noqa: E501`).
for segment in comment.split('#') {
let trimmed = segment.trim_whitespace();
if let Some(command) = trimmed.strip_prefix("fmt:") {
if command.trim_whitespace_start() == "skip" {
return Some(SuppressionKind::Skip);
}
}
}
None
}
/// Returns true if this comment is a `fmt: off` or `yapf: disable` own line suppression comment.
pub fn is_suppression_on(slice: &str, position: CommentLinePosition) -> bool {
position.is_own_line() && matches!(Self::from_comment(slice), Some(Self::On))
}
/// Returns true if this comment is a `fmt: on` or `yapf: enable` own line suppression comment.
pub fn is_suppression_off(slice: &str, position: CommentLinePosition) -> bool {
position.is_own_line() && matches!(Self::from_comment(slice), Some(Self::Off))
}
}
/// The position of a comment in the source text.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum CommentLinePosition {
/// A comment that is on the same line as the preceding token and is separated by at least one line break from the following token.
///
/// # Examples
///
/// ## End of line
///
/// ```python
/// a; # comment
/// b;
/// ```
///
/// `# comment` is an end of line comments because it is separated by at least one line break from the following token `b`.
/// Comments that not only end, but also start on a new line are [`OwnLine`](CommentLinePosition::OwnLine) comments.
EndOfLine,
/// A Comment that is separated by at least one line break from the preceding token.
///
/// # Examples
///
/// ```python
/// a;
/// # comment
/// b;
/// ```
///
/// `# comment` line comments because they are separated by one line break from the preceding token `a`.
OwnLine,
}
impl CommentLinePosition {
pub const fn is_own_line(self) -> bool {
matches!(self, Self::OwnLine)
}
pub const fn is_end_of_line(self) -> bool {
matches!(self, Self::EndOfLine)
}
/// Finds the line position of a comment given a range over a valid
/// comment.
pub fn for_range(comment_range: TextRange, source_code: &str) -> Self {
let before = &source_code[TextRange::up_to(comment_range.start())];
for c in before.chars().rev() {
match c {
'\n' | '\r' => {
break;
}
c if is_python_whitespace(c) => continue,
_ => return Self::EndOfLine,
}
}
Self::OwnLine
}
}