Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve some comments in `normalize_comment` (#7688)

This commit is contained in:
Charlie Marsh 2023-09-27 23:08:25 -04:00 committed by GitHub
parent a6d79c03b3
commit 8028de8956
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
crates/ruff_python_formatter/src/comments/format.rs
View File

@ -450,12 +450,15 @@ impl Format<PyFormatContext<'_>> for FormatNormalizedComment<'_> {
} }
} }
/// A helper for normalizing comments efficiently. /// A helper for normalizing comments by:
/// * Trimming any trailing whitespace.
/// * Adding a leading space after the `#`, if necessary.
/// ///
/// * Return as fast as possible without making unnecessary allocations. /// For example:
/// * Trim any trailing whitespace. /// * `#comment` is normalized to `# comment`.
/// * Normalize for a leading '# '. /// * `# comment ` is normalized to `# comment`.
/// * Retain non-breaking spaces for 'type:' pragmas by leading with '# \u{A0}'. /// * `# comment` is left as-is.
/// * `#!comment` is left as-is.
fn normalize_comment<'a>( fn normalize_comment<'a>(
comment: &'a SourceComment, comment: &'a SourceComment,
source: SourceCode<'a>, source: SourceCode<'a>,
@ -471,16 +474,16 @@ fn normalize_comment<'a>(
return Ok(Cow::Borrowed("#")); return Ok(Cow::Borrowed("#"));
} }
// Fast path for correctly formatted comments: // Fast path for correctly formatted comments: if the comment starts with a space, or any
// * Start with a `# '. // of the allowed characters, then it's included verbatim (apart for trimming any trailing
// * Have no trailing whitespace. // whitespace).
if content.starts_with([' ', '!', ':', '#', '\'']) { if content.starts_with([' ', '!', ':', '#', '\'']) {
return Ok(Cow::Borrowed(trimmed)); return Ok(Cow::Borrowed(trimmed));
} }
// Otherwise, we need to normalize the comment by adding a space after the `#`.
if content.starts_with('\u{A0}') { if content.starts_with('\u{A0}') {
let trimmed = content.trim_start_matches('\u{A0}'); let trimmed = content.trim_start_matches('\u{A0}');
if trimmed.trim_start().starts_with("type:") { if trimmed.trim_start().starts_with("type:") {
// Black adds a space before the non-breaking space if part of a type pragma. // Black adds a space before the non-breaking space if part of a type pragma.
Ok(Cow::Owned(std::format!("# {content}"))) Ok(Cow::Owned(std::format!("# {content}")))