ruff/crates/ruff_python_formatter/src
Micha Reiser bcf745c5ba
Replace verbatim text with NOT_YET_IMPLEMENTED (#4904)
<!--
Thank you for contributing to Ruff! To help us out with reviewing, please consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

This PR replaces the `verbatim_text` builder with a `not_yet_implemented` builder that emits `NOT_YET_IMPLEMENTED_<NodeKind>` for not yet implemented nodes. 

The motivation for this change is that partially formatting compound statements can result in incorrectly indented code, which is a syntax error:

```python
def func_no_args():
  a; b; c
  if True: raise RuntimeError
  if False: ...
  for i in range(10):
    print(i)
    continue
```

Get's reformatted to

```python
def func_no_args():
    a; b; c
    if True: raise RuntimeError
    if False: ...
    for i in range(10):
    print(i)
    continue
```

because our formatter does not yet support `for` statements and just inserts the text from the source. 

## Downsides

Using an identifier will not work in all situations. For example, an identifier is invalid in an `Arguments ` position. That's why I kept `verbatim_text` around and e.g. use it in the `Arguments` formatting logic where incorrect indentations are impossible (to my knowledge). Meaning, `verbatim_text` we can opt in to `verbatim_text` when we want to iterate quickly on nodes that we don't want to provide a full implementation yet and using an identifier would be invalid. 

## Upsides

Running this on main discovered stability issues with the newline handling that were previously "hidden" because of the verbatim formatting. I guess that's an upside :)

## Test Plan

None?
2023-06-07 14:57:25 +02:00
..
comments Format binary expressions (#4862) 2023-06-06 08:34:53 +00:00
expression Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
module Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
other Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
pattern Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
snapshots Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
statement Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
builders.rs Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
cli.rs Add a formatter CLI for debugging (#4809) 2023-06-05 07:33:33 +00:00
context.rs Format binary expressions (#4862) 2023-06-06 08:34:53 +00:00
generated.rs Generate FormatRule definitions (#4724) 2023-06-01 08:38:53 +02:00
lib.rs Replace verbatim text with NOT_YET_IMPLEMENTED (#4904) 2023-06-07 14:57:25 +02:00
main.rs Add a formatter CLI for debugging (#4809) 2023-06-05 07:33:33 +00:00
prelude.rs Suite formatting and JoinNodesBuilder (#4805) 2023-06-02 14:14:38 +00:00
trivia.rs Correctly handle newlines after/before comments (#4895) 2023-06-07 14:49:43 +02:00