Update `Stylist`, `Indexer` to use tokens from parsed output #11592

dhruvmanila · 2024-05-29T01:51:00Z

Summary

This PR updates the Stylist and Indexer to get the information from TokenFlags instead of the owned token data. This removes the need for Tok completely.

Both Stylist and Indexer are now constructed using the parsed program.

This PR also removes the final few references to Tok and related structs. This means that clippy will now be useful and a follow-up PR will fix all the errors.

Part of #11401

## Summary This PR implements the `TokenFlags` which will be stored on each `Token` and certain flags will be set depending on the token kind. Currently, it's equivalent to `AnyStringFlags` but it will help in the future to provide additional information regarding certain tokens like unterminated string, number kinds, etc. The main motivation to add a `TokenFlags` is to store certain information related to the token which will then be used by downstream tools. Currently, the information is only related to string tokens. The downstream tools should not be allowed access to the flags directly, it's an implementation detail. Instead, methods will be provided on `Token` to query certain information. An example can be seen in the follow-up PR (#11592). For example, the `Stylist` and `Indexer` uses the string flags stored on `String`/`FStringStart` token to get certain information. They will be updated to use these flags instead, thus removing the need for `Tok` completely. Prior art in TypeScript: https://github.com/microsoft/TypeScript/blob/16beff101ae1dae0600820ebf22632ac8a40cfc8/src/compiler/types.ts#L2788-L2827

MichaReiser · 2024-05-29T06:48:36Z

crates/ruff_linter/src/directives.rs

                break;
            }

            // For multi-line strings, we expect `noqa` directives on the last line of the
            // string.
-            Tok::String { flags, .. } if flags.is_triple_quoted() => {
-                if locator.contains_line_break(*range) {
+            TokenKind::String if token.is_triple_quoted_string() => {


This is actually nicer :)

crates/ruff_python_codegen/src/stylist.rs

crates/ruff_python_index/src/indexer.rs

## Summary This PR implements the `TokenFlags` which will be stored on each `Token` and certain flags will be set depending on the token kind. Currently, it's equivalent to `AnyStringFlags` but it will help in the future to provide additional information regarding certain tokens like unterminated string, number kinds, etc. The main motivation to add a `TokenFlags` is to store certain information related to the token which will then be used by downstream tools. Currently, the information is only related to string tokens. The downstream tools should not be allowed access to the flags directly, it's an implementation detail. Instead, methods will be provided on `Token` to query certain information. An example can be seen in the follow-up PR (#11592). For example, the `Stylist` and `Indexer` uses the string flags stored on `String`/`FStringStart` token to get certain information. They will be updated to use these flags instead, thus removing the need for `Tok` completely. Prior art in TypeScript: https://github.com/microsoft/TypeScript/blob/16beff101ae1dae0600820ebf22632ac8a40cfc8/src/compiler/types.ts#L2788-L2827

This PR updates the `Stylist` and `Indexer` to get the information from `TokenFlags` instead of the owned token data. This removes the need for `Tok` completely. Both `Stylist` and `Indexer` are now constructed using the parsed program. This PR also removes the final few references to `Tok` and related structs. This means that clippy will now be useful and a follow-up PR will fix all the errors.

## Summary This PR implements the `TokenFlags` which will be stored on each `Token` and certain flags will be set depending on the token kind. Currently, it's equivalent to `AnyStringFlags` but it will help in the future to provide additional information regarding certain tokens like unterminated string, number kinds, etc. The main motivation to add a `TokenFlags` is to store certain information related to the token which will then be used by downstream tools. Currently, the information is only related to string tokens. The downstream tools should not be allowed access to the flags directly, it's an implementation detail. Instead, methods will be provided on `Token` to query certain information. An example can be seen in the follow-up PR (#11592). For example, the `Stylist` and `Indexer` uses the string flags stored on `String`/`FStringStart` token to get certain information. They will be updated to use these flags instead, thus removing the need for `Tok` completely. Prior art in TypeScript: https://github.com/microsoft/TypeScript/blob/16beff101ae1dae0600820ebf22632ac8a40cfc8/src/compiler/types.ts#L2788-L2827

This PR updates the `Stylist` and `Indexer` to get the information from `TokenFlags` instead of the owned token data. This removes the need for `Tok` completely. Both `Stylist` and `Indexer` are now constructed using the parsed program. This PR also removes the final few references to `Tok` and related structs. This means that clippy will now be useful and a follow-up PR will fix all the errors.

## Summary This PR implements the `TokenFlags` which will be stored on each `Token` and certain flags will be set depending on the token kind. Currently, it's equivalent to `AnyStringFlags` but it will help in the future to provide additional information regarding certain tokens like unterminated string, number kinds, etc. The main motivation to add a `TokenFlags` is to store certain information related to the token which will then be used by downstream tools. Currently, the information is only related to string tokens. The downstream tools should not be allowed access to the flags directly, it's an implementation detail. Instead, methods will be provided on `Token` to query certain information. An example can be seen in the follow-up PR (#11592). For example, the `Stylist` and `Indexer` uses the string flags stored on `String`/`FStringStart` token to get certain information. They will be updated to use these flags instead, thus removing the need for `Tok` completely. Prior art in TypeScript: https://github.com/microsoft/TypeScript/blob/16beff101ae1dae0600820ebf22632ac8a40cfc8/src/compiler/types.ts#L2788-L2827

This PR updates the `Stylist` and `Indexer` to get the information from `TokenFlags` instead of the owned token data. This removes the need for `Tok` completely. Both `Stylist` and `Indexer` are now constructed using the parsed program. This PR also removes the final few references to `Tok` and related structs. This means that clippy will now be useful and a follow-up PR will fix all the errors.

## 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.

dhruvmanila added the internal An internal refactor or improvement label May 29, 2024

dhruvmanila force-pushed the dhruv/comment-ranges branch from 12c3707 to d49b4fc Compare May 29, 2024 05:57

dhruvmanila force-pushed the dhruv/indexer-stylist branch from 89450df to 73289f8 Compare May 29, 2024 06:01

dhruvmanila marked this pull request as ready for review May 29, 2024 06:05

dhruvmanila requested a review from MichaReiser as a code owner May 29, 2024 06:05

dhruvmanila mentioned this pull request May 29, 2024

Implement TokenFlags stored on each Token #11578

Merged

dhruvmanila force-pushed the dhruv/comment-ranges branch from d49b4fc to 817ef3e Compare May 29, 2024 06:13

dhruvmanila requested a review from AlexWaygood as a code owner May 29, 2024 06:13

dhruvmanila force-pushed the dhruv/indexer-stylist branch from 73289f8 to 5fb1bab Compare May 29, 2024 06:14

MichaReiser approved these changes May 29, 2024

View reviewed changes

Base automatically changed from dhruv/comment-ranges to dhruv/parser-phase-2 May 29, 2024 08:34

Update Stylist, Indexer to use tokens from parsed

c48a5a1

dhruvmanila force-pushed the dhruv/indexer-stylist branch from 5fb1bab to c48a5a1 Compare May 29, 2024 08:34

Construct stylist and indexer from tokens

cd40644

dhruvmanila merged commit 06d6feb into dhruv/parser-phase-2 May 29, 2024
2 of 5 checks passed

dhruvmanila deleted the dhruv/indexer-stylist branch May 29, 2024 08:41

dhruvmanila mentioned this pull request May 31, 2024

☂️ Remove dependencies of Tok from downstream tools #11401

Closed

23 tasks

dhruvmanila mentioned this pull request May 31, 2024

Maintain synchronicity between the lexer and the parser #11457

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update `Stylist`, `Indexer` to use tokens from parsed output #11592

Update `Stylist`, `Indexer` to use tokens from parsed output #11592

dhruvmanila commented May 29, 2024 •

edited

Loading

MichaReiser May 29, 2024

Update Stylist, Indexer to use tokens from parsed output #11592

Update Stylist, Indexer to use tokens from parsed output #11592

Conversation

dhruvmanila commented May 29, 2024 • edited Loading

Summary

MichaReiser May 29, 2024

Choose a reason for hiding this comment

Update `Stylist`, `Indexer` to use tokens from parsed output #11592

Update `Stylist`, `Indexer` to use tokens from parsed output #11592

dhruvmanila commented May 29, 2024 •

edited

Loading