mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-24 05:26:23 +00:00
Formatter: Improve single-with item formatting for Python 3.8 or older (#10276)
## Summary This PR changes how we format `with` statements with a single with item for Python 3.8 or older. This change is not compatible with Black. This is how we format a single-item with statement today ```python def run(data_path, model_uri): with pyspark.sql.SparkSession.builder.config( key="spark.python.worker.reuse", value=True ).config(key="spark.ui.enabled", value=False).master( "local-cluster[2, 1, 1024]" ).getOrCreate(): # ignore spark log output spark.sparkContext.setLogLevel("OFF") print(score_model(spark, data_path, model_uri)) ``` This is different than how we would format the same expression if it is inside any other clause header (`while`, `if`, ...): ```python def run(data_path, model_uri): while ( pyspark.sql.SparkSession.builder.config( key="spark.python.worker.reuse", value=True ) .config(key="spark.ui.enabled", value=False) .master("local-cluster[2, 1, 1024]") .getOrCreate() ): # ignore spark log output spark.sparkContext.setLogLevel("OFF") print(score_model(spark, data_path, model_uri)) ``` Which seems inconsistent to me. This PR changes the formatting of the single-item with Python 3.8 or older to match that of other clause headers. ```python def run(data_path, model_uri): with ( pyspark.sql.SparkSession.builder.config( key="spark.python.worker.reuse", value=True ) .config(key="spark.ui.enabled", value=False) .master("local-cluster[2, 1, 1024]") .getOrCreate() ): # ignore spark log output spark.sparkContext.setLogLevel("OFF") print(score_model(spark, data_path, model_uri)) ``` According to our versioning policy, this style change is gated behind a preview flag. ## Test Plan See added tests. Added
This commit is contained in:
parent
4bce801065
commit
b64f2ea401
5 changed files with 167 additions and 4 deletions
|
@ -324,6 +324,16 @@ with (
|
|||
)
|
||||
):
|
||||
pass
|
||||
|
||||
with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb:
|
||||
pass
|
||||
|
||||
with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b:
|
||||
pass
|
||||
|
||||
if True:
|
||||
with anyio.CancelScope(shield=True) if get_running_loop() else contextlib.nullcontext() as b:
|
||||
pass
|
||||
```
|
||||
|
||||
## Outputs
|
||||
|
@ -688,6 +698,121 @@ with open(
|
|||
"/etc/hosts" # This is an incredibly long comment that has been replaced for sanitization
|
||||
):
|
||||
pass
|
||||
|
||||
with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb:
|
||||
pass
|
||||
|
||||
with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b:
|
||||
pass
|
||||
|
||||
if True:
|
||||
with anyio.CancelScope(
|
||||
shield=True
|
||||
) if get_running_loop() else contextlib.nullcontext() as b:
|
||||
pass
|
||||
```
|
||||
|
||||
|
||||
#### Preview changes
|
||||
```diff
|
||||
--- Stable
|
||||
+++ Preview
|
||||
@@ -49,7 +49,9 @@
|
||||
with a: # should remove brackets
|
||||
pass
|
||||
|
||||
-with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as c:
|
||||
+with (
|
||||
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
||||
+) as c:
|
||||
pass
|
||||
|
||||
|
||||
@@ -214,7 +216,9 @@
|
||||
pass
|
||||
|
||||
# Breaking of with items.
|
||||
-with test as ( # bar # foo
|
||||
+with (
|
||||
+ test # bar
|
||||
+) as ( # foo
|
||||
# test
|
||||
foo
|
||||
):
|
||||
@@ -226,7 +230,9 @@
|
||||
):
|
||||
pass
|
||||
|
||||
-with test as ( # bar # foo # baz
|
||||
+with (
|
||||
+ test # bar
|
||||
+) as ( # foo # baz
|
||||
# test
|
||||
foo
|
||||
):
|
||||
@@ -279,7 +285,9 @@
|
||||
) as b:
|
||||
pass
|
||||
|
||||
-with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b:
|
||||
+with (
|
||||
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
||||
+) as b:
|
||||
pass
|
||||
|
||||
with (
|
||||
@@ -322,15 +330,19 @@
|
||||
pass
|
||||
|
||||
if True:
|
||||
- with anyio.CancelScope(
|
||||
- shield=True
|
||||
- ) if get_running_loop() else contextlib.nullcontext():
|
||||
+ with (
|
||||
+ anyio.CancelScope(shield=True)
|
||||
+ if get_running_loop()
|
||||
+ else contextlib.nullcontext()
|
||||
+ ):
|
||||
pass
|
||||
|
||||
if True:
|
||||
- with anyio.CancelScope(
|
||||
- shield=True
|
||||
- ) if get_running_loop() else contextlib.nullcontext() as c:
|
||||
+ with (
|
||||
+ anyio.CancelScope(shield=True)
|
||||
+ if get_running_loop()
|
||||
+ else contextlib.nullcontext()
|
||||
+ ) as c:
|
||||
pass
|
||||
|
||||
with Child(aaaaaaaaa, bbbbbbbbbbbbbbb, cccccc), Document(
|
||||
@@ -344,14 +356,20 @@
|
||||
):
|
||||
pass
|
||||
|
||||
-with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb:
|
||||
+with (
|
||||
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
||||
+):
|
||||
pass
|
||||
|
||||
-with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b:
|
||||
+with (
|
||||
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
||||
+) as b:
|
||||
pass
|
||||
|
||||
if True:
|
||||
- with anyio.CancelScope(
|
||||
- shield=True
|
||||
- ) if get_running_loop() else contextlib.nullcontext() as b:
|
||||
+ with (
|
||||
+ anyio.CancelScope(shield=True)
|
||||
+ if get_running_loop()
|
||||
+ else contextlib.nullcontext()
|
||||
+ ) as b:
|
||||
pass
|
||||
```
|
||||
|
||||
|
||||
|
@ -1093,4 +1218,23 @@ with open(
|
|||
"/etc/hosts" # This is an incredibly long comment that has been replaced for sanitization
|
||||
):
|
||||
pass
|
||||
|
||||
with (
|
||||
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
||||
):
|
||||
pass
|
||||
|
||||
with (
|
||||
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
|
||||
+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b
|
||||
):
|
||||
pass
|
||||
|
||||
if True:
|
||||
with (
|
||||
anyio.CancelScope(shield=True)
|
||||
if get_running_loop()
|
||||
else contextlib.nullcontext() as b
|
||||
):
|
||||
pass
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue