Consider soft keyword for various parsing logic#11474
Consider soft keyword for various parsing logic#11474dhruvmanila merged 1 commit intodhruv/parser-phase-2from
Conversation
b45040f to
0fbe59f
Compare
|
(Converting this to draft as there are a few more references to be looked at.) |
0fbe59f to
a47bca9
Compare
35b7a6e to
09022fa
Compare
64da911 to
642036a
Compare
09022fa to
c64f352
Compare
|
This is ready to review. |
f591341 to
65ae60a
Compare
c64f352 to
b154931
Compare
65ae60a to
0ca2ed3
Compare
b154931 to
d391949
Compare
0ca2ed3 to
a242077
Compare
d391949 to
cbf7e6d
Compare
a242077 to
c393e70
Compare
cbf7e6d to
f8ffc5c
Compare
| RecoveryContextKind::ImportNames => p.at_name_or_soft_keyword(), | ||
| RecoveryContextKind::ImportFromAsNames(_) => { | ||
| matches!(p.current_token_kind(), TokenKind::Star | TokenKind::Name) | ||
| p.at(TokenKind::Star) || p.at_name_or_soft_keyword() |
There was a problem hiding this comment.
I think I would just call p.at_name_or_soft_keyword p.at_name to align it with parse_name. The downside is that this can be confusing because there's also a Name token. Could we rename parse_name to parse_identifier?
There was a problem hiding this comment.
I think I would just call
p.at_name_or_soft_keywordp.at_nameto align it withparse_name. The downside is that this can be confusing because there's also aNametoken.
Yeah, I thought of doing that but I found the explicit name better just to avoid this confusion.
Could we rename
parse_nametoparse_identifier?
They both exists because sometimes the parser needs to construct an ExprName node while other times it only needs an Identifier.
## Summary This PR updates various checks to consider soft keywords. 1. Update the following methods to also check whether the parser is at a soft keyword token: 1. `at_simple_stmt` 2. `at_stmt` 3. `at_expr` 4. `at_pattern_start` 5. `at_mapping_pattern_start` 2. Update various references of `parser.at(TokenKind::Name)` to use `parser.at_name_or_soft_keyword`. In the future, we should update it to also include other keywords on a case-by-case basis. 3. Re-use `parse_name` and `parse_identifier` for literal pattern parsing. We should always use either of these methods instead of doing the same manually to make sure that soft keyword are correctly tranformed. For (i) and (ii), we could've just extended the `EXPR_SET` with the soft keyword tokens but I think it's better to be explicit about what the method checks and to have separation between the token set corresponding to statement and soft keywords. ## Test Plan Add a few test cases and update the snapshots. These snapshots were generated through the local fork of the parser which compiles.
## Summary This PR updates various checks to consider soft keywords. 1. Update the following methods to also check whether the parser is at a soft keyword token: 1. `at_simple_stmt` 2. `at_stmt` 3. `at_expr` 4. `at_pattern_start` 5. `at_mapping_pattern_start` 2. Update various references of `parser.at(TokenKind::Name)` to use `parser.at_name_or_soft_keyword`. In the future, we should update it to also include other keywords on a case-by-case basis. 3. Re-use `parse_name` and `parse_identifier` for literal pattern parsing. We should always use either of these methods instead of doing the same manually to make sure that soft keyword are correctly tranformed. For (i) and (ii), we could've just extended the `EXPR_SET` with the soft keyword tokens but I think it's better to be explicit about what the method checks and to have separation between the token set corresponding to statement and soft keywords. ## Test Plan Add a few test cases and update the snapshots. These snapshots were generated through the local fork of the parser which compiles.
## Summary This PR updates various checks to consider soft keywords. 1. Update the following methods to also check whether the parser is at a soft keyword token: 1. `at_simple_stmt` 2. `at_stmt` 3. `at_expr` 4. `at_pattern_start` 5. `at_mapping_pattern_start` 2. Update various references of `parser.at(TokenKind::Name)` to use `parser.at_name_or_soft_keyword`. In the future, we should update it to also include other keywords on a case-by-case basis. 3. Re-use `parse_name` and `parse_identifier` for literal pattern parsing. We should always use either of these methods instead of doing the same manually to make sure that soft keyword are correctly tranformed. For (i) and (ii), we could've just extended the `EXPR_SET` with the soft keyword tokens but I think it's better to be explicit about what the method checks and to have separation between the token set corresponding to statement and soft keywords. ## Test Plan Add a few test cases and update the snapshots. These snapshots were generated through the local fork of the parser which compiles.
## Summary This PR updates various checks to consider soft keywords. 1. Update the following methods to also check whether the parser is at a soft keyword token: 1. `at_simple_stmt` 2. `at_stmt` 3. `at_expr` 4. `at_pattern_start` 5. `at_mapping_pattern_start` 2. Update various references of `parser.at(TokenKind::Name)` to use `parser.at_name_or_soft_keyword`. In the future, we should update it to also include other keywords on a case-by-case basis. 3. Re-use `parse_name` and `parse_identifier` for literal pattern parsing. We should always use either of these methods instead of doing the same manually to make sure that soft keyword are correctly tranformed. For (i) and (ii), we could've just extended the `EXPR_SET` with the soft keyword tokens but I think it's better to be explicit about what the method checks and to have separation between the token set corresponding to statement and soft keywords. ## Test Plan Add a few test cases and update the snapshots. These snapshots were generated through the local fork of the parser which compiles.
## Summary This PR updates the entire parser stack in multiple ways: ### Make the lexer lazy * #11244 * #11473 Previously, Ruff's lexer would act as an iterator. The parser would collect all the tokens in a vector first and then process the tokens to create the syntax tree. The first task in this project is to update the entire parsing flow to make the lexer lazy. This includes the `Lexer`, `TokenSource`, and `Parser`. For context, the `TokenSource` is a wrapper around the `Lexer` to filter out the trivia tokens[^1]. Now, the parser will ask the token source to get the next token and only then the lexer will continue and emit the token. This means that the lexer needs to be aware of the "current" token. When the `next_token` is called, the current token will be updated with the newly lexed token. The main motivation to make the lexer lazy is to allow re-lexing a token in a different context. This is going to be really useful to make the parser error resilience. For example, currently the emitted tokens remains the same even if the parser can recover from an unclosed parenthesis. This is important because the lexer emits a `NonLogicalNewline` in parenthesized context while a normal `Newline` in non-parenthesized context. This different kinds of newline is also used to emit the indentation tokens which is important for the parser as it's used to determine the start and end of a block. Additionally, this allows us to implement the following functionalities: 1. Checkpoint - rewind infrastructure: The idea here is to create a checkpoint and continue lexing. At a later point, this checkpoint can be used to rewind the lexer back to the provided checkpoint. 2. Remove the `SoftKeywordTransformer` and instead use lookahead or speculative parsing to determine whether a soft keyword is a keyword or an identifier 3. Remove the `Tok` enum. The `Tok` enum represents the tokens emitted by the lexer but it contains owned data which makes it expensive to clone. The new `TokenKind` enum just represents the type of token which is very cheap. This brings up a question as to how will the parser get the owned value which was stored on `Tok`. This will be solved by introducing a new `TokenValue` enum which only contains a subset of token kinds which has the owned value. This is stored on the lexer and is requested by the parser when it wants to process the data. For example: https://github.com/astral-sh/ruff/blob/8196720f809380d8f1fc7651679ff3fc2cb58cd7/crates/ruff_python_parser/src/parser/expression.rs#L1260-L1262 [^1]: Trivia tokens are `NonLogicalNewline` and `Comment` ### Remove `SoftKeywordTransformer` * #11441 * #11459 * #11442 * #11443 * #11474 For context, https://github.com/RustPython/RustPython/pull/4519/files#diff-5de40045e78e794aa5ab0b8aacf531aa477daf826d31ca129467703855408220 added support for soft keywords in the parser which uses infinite lookahead to classify a soft keyword as a keyword or an identifier. This is a brilliant idea as it basically wraps the existing Lexer and works on top of it which means that the logic for lexing and re-lexing a soft keyword remains separate. The change here is to remove `SoftKeywordTransformer` and let the parser determine this based on context, lookahead and speculative parsing. * **Context:** The transformer needs to know the position of the lexer between it being at a statement position or a simple statement position. This is because a `match` token starts a compound statement while a `type` token starts a simple statement. **The parser already knows this.** * **Lookahead:** Now that the parser knows the context it can perform lookahead of up to two tokens to classify the soft keyword. The logic for this is mentioned in the PR implementing it for `type` and `match soft keyword. * **Speculative parsing:** This is where the checkpoint - rewind infrastructure helps. For `match` soft keyword, there are certain cases for which we can't classify based on lookahead. The idea here is to create a checkpoint and keep parsing. Based on whether the parsing was successful and what tokens are ahead we can classify the remaining cases. Refer to #11443 for more details. If the soft keyword is being parsed in an identifier context, it'll be converted to an identifier and the emitted token will be updated as well. Refer https://github.com/astral-sh/ruff/blob/8196720f809380d8f1fc7651679ff3fc2cb58cd7/crates/ruff_python_parser/src/parser/expression.rs#L487-L491. The `case` soft keyword doesn't require any special handling because it'll be a keyword only in the context of a match statement. ### Update the parser API * #11494 * #11505 Now that the lexer is in sync with the parser, and the parser helps to determine whether a soft keyword is a keyword or an identifier, the lexer cannot be used on its own. The reason being that it's not sensitive to the context (which is correct). This means that the parser API needs to be updated to not allow any access to the lexer. Previously, there were multiple ways to parse the source code: 1. Passing the source code itself 2. Or, passing the tokens Now that the lexer and parser are working together, the API corresponding to (2) cannot exists. The final API is mentioned in this PR description: #11494. ### Refactor the downstream tools (linter and formatter) * #11511 * #11515 * #11529 * #11562 * #11592 And, the final set of changes involves updating all references of the lexer and `Tok` enum. This was done in two-parts: 1. Update all the references in a way that doesn't require any changes from this PR i.e., it can be done independently * #11402 * #11406 * #11418 * #11419 * #11420 * #11424 2. Update all the remaining references to use the changes made in this PR For (2), there were various strategies used: 1. Introduce a new `Tokens` struct which wraps the token vector and add methods to query a certain subset of tokens. These includes: 1. `up_to_first_unknown` which replaces the `tokenize` function 2. `in_range` and `after` which replaces the `lex_starts_at` function where the former returns the tokens within the given range while the latter returns all the tokens after the given offset 2. Introduce a new `TokenFlags` which is a set of flags to query certain information from a token. Currently, this information is only limited to any string type token but can be expanded to include other information in the future as needed. #11578 3. Move the `CommentRanges` to the parsed output because this information is common to both the linter and the formatter. This removes the need for `tokens_and_ranges` function. ## Test Plan - [x] Update and verify the test snapshots - [x] Make sure the entire test suite is passing - [x] Make sure there are no changes in the ecosystem checks - [x] Run the fuzzer on the parser - [x] Run this change on dozens of open-source projects ### Running this change on dozens of open-source projects Refer to the PR description to get the list of open source projects used for testing. Now, the following tests were done between `main` and this branch: 1. Compare the output of `--select=E999` (syntax errors) 2. Compare the output of default rule selection 3. Compare the output of `--select=ALL` **Conclusion: all output were same** ## What's next? The next step is to introduce re-lexing logic and update the parser to feed the recovery information to the lexer so that it can emit the correct token. This moves us one step closer to having error resilience in the parser and provides Ruff the possibility to lint even if the source code contains syntax errors.
Summary
This PR updates various checks to consider soft keywords.
at_simple_stmtat_stmtat_exprat_pattern_startat_mapping_pattern_startparser.at(TokenKind::Name)to useparser.at_name_or_soft_keyword. In the future, we should update it to also include other keywords on a case-by-case basis.parse_nameandparse_identifierfor literal pattern parsing. We should always use either of these methods instead of doing the same manually to make sure that soft keyword are correctly tranformed.For (i) and (ii), we could've just extended the
EXPR_SETwith the soft keyword tokens but I think it's better to be explicit about what the method checks and to have separation between the token set corresponding to statement and soft keywords.Test Plan
Add a few test cases and update the snapshots. These snapshots were generated through the local fork of the parser which compiles.