language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 04:45:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add message to formatter SyntaxError (#5881)

Browse source 
**Summary** Add a static string error message to the formatter syntax
error so we can disambiguate where the syntax error came from

**Test Plan** No fixed tests, we don't expect this to occur, but it
helped with transformers syntax error debugging:

```
Error: Failed to format node

Caused by:
    syntax error: slice first colon token was not a colon
```
This commit is contained in:
konsti 2023-07-19 17:15:26 +02:00 • committed by GitHub
parent 46a17d11f3
commit 63ed7a31e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 38 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

14
crates/ruff_python_formatter/src/expression/expr_slice.rs
View file

@ -162,18 +162,22 @@ pub(crate) fn find_colons(
let after_lower = lower
.as_ref()
.map_or(range.start(), |lower| lower.range().end());
let first_colon =
first_non_trivia_token(after_lower, contents).ok_or(FormatError::SyntaxError)?;
let first_colon = first_non_trivia_token(after_lower, contents).ok_or(
FormatError::syntax_error("Din't find any token for slice first colon"),
)?;
if first_colon.kind != TokenKind::Colon {
return Err(FormatError::SyntaxError);
return Err(FormatError::syntax_error(
"slice first colon token was not a colon",
));
}
let after_upper = upper
.as_ref()
.map_or(first_colon.end(), |upper| upper.range().end());
// At least the closing bracket must exist, so there must be a token there
let next_token =
first_non_trivia_token(after_upper, contents).ok_or(FormatError::SyntaxError)?;
let next_token = first_non_trivia_token(after_upper, contents).ok_or(
FormatError::syntax_error("Din't find any token for slice second colon"),
)?;
let second_colon = if next_token.kind == TokenKind::Colon {
debug_assert!(
next_token.range.start() < range.end(),

8
crates/ruff_python_formatter/src/expression/string.rs
View file

@ -91,7 +91,9 @@ impl Format<PyFormatContext<'_>> for FormatStringContinuation<'_> {
continue;
}
Err(_) => {
return Err(FormatError::SyntaxError);
return Err(FormatError::syntax_error(
"Unexpected lexer error in string formatting",
));
}
};
@ -167,7 +169,9 @@ impl Format<PyFormatContext<'_>> for FormatStringPart {
let prefix = StringPrefix::parse(string_content);
let after_prefix = &string_content[usize::from(prefix.text_len())..];
let quotes = StringQuotes::parse(after_prefix).ok_or(FormatError::SyntaxError)?;
let quotes = StringQuotes::parse(after_prefix).ok_or(FormatError::syntax_error(
"Didn't find string quotes after prefix",
))?;
let relative_raw_content_range = TextRange::new(
prefix.text_len() + quotes.text_len(),
string_content.text_len() - quotes.text_len(),