Formatter: Improve single-with item formatting for Python 3.8 or older by MichaReiser · Pull Request #10276 · astral-sh/ruff

MichaReiser · 2024-03-07T15:30:16Z

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

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, ...):

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.

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

github-actions · 2024-03-07T15:41:01Z

`ruff-ecosystem` results

Formatter (stable)

ℹ️ ecosystem check detected format changes. (+2 -2 lines in 1 file in 1 projects; 42 projects unchanged)

rotki/rotki (+2 -2 lines across 1 file)

rotkehlchen/rotkehlchen.py~L1213

         if oracle != HistoricalPriceOracle.CRYPTOCOMPARE:
             return  # only for cryptocompare for now
 
-        with (
-            contextlib.suppress(UnknownAsset)
+        with contextlib.suppress(
+            UnknownAsset
         ):  # if suppress -> assets are not crypto or fiat, so we can't query cryptocompare  # noqa: E501
             self.cryptocompare.create_cache(
                 from_asset=from_asset,

Formatter (preview)

ℹ️ ecosystem check detected format changes. (+8 -7 lines in 2 files in 2 projects; 41 projects unchanged)

mlflow/mlflow (+6 -5 lines across 1 file)

ruff format --preview

examples/flower_classifier/score_images_spark.py~L81

 @cli_args.MODEL_URI
 @click.argument("data-path")
 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() as spark:
+    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()
+    ) as spark:
         # ignore spark log output
         spark.sparkContext.setLogLevel("OFF")
         print(score_model(spark, data_path, model_uri))

rotki/rotki (+2 -2 lines across 1 file)

ruff format --preview

rotkehlchen/rotkehlchen.py~L1211

         if oracle != HistoricalPriceOracle.CRYPTOCOMPARE:
             return  # only for cryptocompare for now
 
-        with (
-            contextlib.suppress(UnknownAsset)
+        with contextlib.suppress(
+            UnknownAsset
         ):  # if suppress -> assets are not crypto or fiat, so we can't query cryptocompare  # noqa: E501
             self.cryptocompare.create_cache(
                 from_asset=from_asset,

MichaReiser · 2024-03-07T17:45:00Z

crates/ruff_python_formatter/tests/snapshots/format@statement__with.py.snap

+-with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as c:
+with (
+    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
+) as c:


This change might be controversial. I would say it's not ideal but the best we can do with the limitations given by Python 3.8, other than not parenthesizing and exceeding the configured line width.

charliermarsh

This seems reasonable to me.

astral-sh#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

MichaReiser added formatter Related to the formatter preview Related to preview mode features labels Mar 7, 2024

MichaReiser changed the base branch from main to fix-with-item-parenthesizing March 7, 2024 15:30

MichaReiser force-pushed the fix-with-item-parenthesizing branch from 6b290c0 to 25ada0a Compare March 7, 2024 16:43

MichaReiser force-pushed the single-with-item-pre-39 branch from 02bae56 to 4932a2d Compare March 7, 2024 16:56

MichaReiser commented Mar 7, 2024

View reviewed changes

MichaReiser force-pushed the single-with-item-pre-39 branch from 4932a2d to cde6584 Compare March 7, 2024 17:45

MichaReiser changed the title ~~single with item pre 39~~ Formatter: Improve single-with item formatting for Python 3.8 or older Mar 7, 2024

MichaReiser force-pushed the fix-with-item-parenthesizing branch 3 times, most recently from 4100b9f to a42c365 Compare March 8, 2024 11:30

MichaReiser force-pushed the single-with-item-pre-39 branch from cde6584 to f8937a3 Compare March 8, 2024 11:40

MichaReiser marked this pull request as ready for review March 8, 2024 11:40

MichaReiser requested a review from charliermarsh March 8, 2024 16:12

charliermarsh force-pushed the fix-with-item-parenthesizing branch from a42c365 to f9416ea Compare March 8, 2024 23:41

Base automatically changed from fix-with-item-parenthesizing to main March 8, 2024 23:48

Improve single with item pre 3.9 formatting

c00f4bd

charliermarsh force-pushed the single-with-item-pre-39 branch from f8937a3 to c00f4bd Compare March 8, 2024 23:49

charliermarsh approved these changes Mar 8, 2024

View reviewed changes

charliermarsh enabled auto-merge (squash) March 8, 2024 23:53

charliermarsh merged commit b64f2ea into main Mar 8, 2024

charliermarsh deleted the single-with-item-pre-39 branch March 8, 2024 23:56

johnslavik mentioned this pull request Mar 15, 2024

Bump ruff-pre-commit to v0.3.2 python-poetry/cleo#412

Merged

MichaReiser mentioned this pull request Sep 16, 2024

Ruff 2025 style guide #13371

Closed

29 tasks

BrewTestBot mentioned this pull request Jan 9, 2025

ruff 0.9.0 Homebrew/homebrew-core#203745

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Formatter: Improve single-with item formatting for Python 3.8 or older#10276

Formatter: Improve single-with item formatting for Python 3.8 or older#10276
charliermarsh merged 1 commit intomainfrom
single-with-item-pre-39

MichaReiser commented Mar 7, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Mar 7, 2024 •

edited

Loading

Uh oh!

MichaReiser Mar 7, 2024

Uh oh!

charliermarsh left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

MichaReiser commented Mar 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

github-actions bot commented Mar 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ruff-ecosystem results

Formatter (stable)

Formatter (preview)

Uh oh!

MichaReiser Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

charliermarsh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MichaReiser commented Mar 7, 2024 •

edited

Loading

github-actions bot commented Mar 7, 2024 •

edited

Loading

`ruff-ecosystem` results