Use BestFits for non-fluent attribute chains #6817

MichaReiser · 2023-08-23T12:10:18Z

Summary

This is the last part of #6271. It implements the overlong parenthesizing for attribute chains (and call expressions).

The code changes are minimal. The main reason for this being its own PR is to assess the performance implication (and compatibility win)

Closes #6271

Test Plan

Base

project	similarity index
cpython	0.76058
django	0.99894
transformers	0.99842
twine	0.99929
typeshed	0.99953
warehouse	0.99632
zulip	0.99909

This PR

project	similarity index
cpython	0.76061
django	0.99898
transformers	0.99842
twine	0.99929
typeshed	0.99953
warehouse	0.99637
zulip	0.99920

MichaReiser · 2023-08-23T12:10:23Z

Current dependencies on/for this PR:

main
- PR Extend BestFitting with mode #6814
  - PR Fix Printer group modes #6815
    - PR Maybe parenthesize long constants and names #6816
      - PR Use BestFits for non-fluent attribute chains #6817 👈
        
        PR Add tab width option #6848
        
        PR Printer: Slice based queue and stack #6819

This comment was auto-generated by Graphite.

github-actions · 2023-08-23T12:57:21Z

PR Check Results

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      3.6±0.03ms    11.3 MB/sec    1.12      4.0±0.02ms    10.1 MB/sec
formatter/numpy/ctypeslib.py               1.00    750.6±5.37µs    22.2 MB/sec    1.09    815.8±5.79µs    20.4 MB/sec
formatter/numpy/globals.py                 1.00     78.7±0.91µs    37.5 MB/sec    1.00     78.9±2.81µs    37.4 MB/sec
formatter/pydantic/types.py                1.00   1539.8±9.87µs    16.6 MB/sec    1.06  1627.7±17.14µs    15.7 MB/sec
linter/all-rules/large/dataset.py          1.00     10.4±0.04ms     3.9 MB/sec    1.01     10.5±0.03ms     3.9 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      2.9±0.01ms     5.8 MB/sec    1.00      2.9±0.01ms     5.8 MB/sec
linter/all-rules/numpy/globals.py          1.03    329.3±5.37µs     9.0 MB/sec    1.00    320.9±1.09µs     9.2 MB/sec
linter/all-rules/pydantic/types.py         1.00      5.4±0.02ms     4.7 MB/sec    1.00      5.4±0.02ms     4.7 MB/sec
linter/default-rules/large/dataset.py      1.01      5.5±0.02ms     7.4 MB/sec    1.00      5.5±0.01ms     7.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01   1180.6±2.41µs    14.1 MB/sec    1.00   1173.3±3.49µs    14.2 MB/sec
linter/default-rules/numpy/globals.py      1.01    124.1±0.26µs    23.8 MB/sec    1.00    123.2±0.24µs    23.9 MB/sec
linter/default-rules/pydantic/types.py     1.00      2.5±0.01ms    10.2 MB/sec    1.00      2.5±0.01ms    10.2 MB/sec

Windows

group                                      main                                    pr
-----                                      ----                                    --
formatter/large/dataset.py                 1.00      4.7±0.20ms     8.6 MB/sec     1.12      5.3±0.18ms     7.6 MB/sec
formatter/numpy/ctypeslib.py               1.00   984.9±57.81µs    16.9 MB/sec     1.13  1112.0±56.50µs    15.0 MB/sec
formatter/numpy/globals.py                 1.00    100.0±5.41µs    29.5 MB/sec     1.03    102.7±6.29µs    28.7 MB/sec
formatter/pydantic/types.py                1.00      2.1±0.10ms    12.4 MB/sec     1.08      2.2±0.14ms    11.5 MB/sec
linter/all-rules/large/dataset.py          1.14     17.2±0.56ms     2.4 MB/sec     1.00     15.1±0.43ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.09      4.6±0.24ms     3.6 MB/sec     1.00      4.2±0.17ms     4.0 MB/sec
linter/all-rules/numpy/globals.py          1.00   524.5±26.30µs     5.6 MB/sec     1.03   539.6±27.55µs     5.5 MB/sec
linter/all-rules/pydantic/types.py         1.10      8.8±0.60ms     2.9 MB/sec     1.00      8.0±0.31ms     3.2 MB/sec
linter/default-rules/large/dataset.py      1.00      8.5±0.22ms     4.8 MB/sec     1.02      8.6±0.27ms     4.7 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1811.3±104.88µs     9.2 MB/sec    1.01  1824.3±65.32µs     9.1 MB/sec
linter/default-rules/numpy/globals.py      1.00   224.2±10.03µs    13.2 MB/sec     1.03    231.0±9.34µs    12.8 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.9±0.16ms     6.6 MB/sec     1.00      3.9±0.18ms     6.6 MB/sec

MichaReiser · 2023-08-23T16:40:07Z

crates/ruff_python_formatter/src/expression/expr_constant.rs

@@ -107,7 +106,8 @@ pub(super) fn is_multiline_string(constant: &ExprConstant, source: &str) -> bool
        let quotes =
            StringQuotes::parse(&contents[TextRange::new(prefix.text_len(), contents.text_len())]);

-        quotes.is_some_and(StringQuotes::is_triple) && contents.contains(['\n', '\r'])
+        quotes.is_some_and(StringQuotes::is_triple)
+            && memchr::memchr2(b'\n', b'\r', contents.as_bytes()).is_some()


This helped offsetting the performance regression a bit

crates/ruff_python_formatter/src/expression/expr_constant.rs

+                // For asserts statements where the constant is the message and the test starts with a parenthesized node
+                //
+                // ```python
+                // assert [
+                //      a,
+                //      b,
+                //      c,
+                // ] == expected, (
+                //      "Message"
+                //  )
+                // ```
+                // split in the following order:
+                //
+                // 1. By the opening parentheses of the test
+                // 2. Add parentheses around the message
+                // 3. Add parentheses around the test
+                //


This was referenced Aug 23, 2023

Extend BestFitting with mode #6814

Merged

Fix Printer group modes #6815

Merged

This was referenced Aug 23, 2023

Maybe parenthesize long constants and names #6816

Merged

Formatter: Unstable call arguments comment formatting #6818

Closed

MichaReiser force-pushed the maybe-parenthesize-constants-and-names branch from aa7e59b to 9ab2cb5 Compare August 23, 2023 13:33

MichaReiser force-pushed the best-fits-call-expr branch from a658f3b to ffc115e Compare August 23, 2023 13:33

MichaReiser mentioned this pull request Aug 23, 2023

Printer: Slice based queue and stack #6819

Merged

MichaReiser changed the title ~~Use BestFits for non-call chain call expressions~~ Use BestFits for non-fluent call expressions Aug 23, 2023

MichaReiser force-pushed the maybe-parenthesize-constants-and-names branch 3 times, most recently from 701c645 to d50042b Compare August 23, 2023 16:21

MichaReiser changed the title ~~Use BestFits for non-fluent call expressions~~ Use BestFits for non-fluent attribute chains Aug 23, 2023

MichaReiser force-pushed the best-fits-call-expr branch from 767304d to cb56080 Compare August 23, 2023 16:39

MichaReiser commented Aug 23, 2023

View reviewed changes

MichaReiser force-pushed the maybe-parenthesize-constants-and-names branch from d50042b to c8cb472 Compare August 23, 2023 16:54

MichaReiser force-pushed the best-fits-call-expr branch from cb56080 to c2861ef Compare August 23, 2023 16:55

MichaReiser force-pushed the maybe-parenthesize-constants-and-names branch 3 times, most recently from 56f175a to 697d820 Compare August 23, 2023 17:27

MichaReiser force-pushed the best-fits-call-expr branch 2 times, most recently from e251a2e to 7609f59 Compare August 23, 2023 21:15

MichaReiser commented Aug 23, 2023

View reviewed changes

MichaReiser force-pushed the maybe-parenthesize-constants-and-names branch from 697d820 to 33a6c16 Compare August 24, 2023 09:38

MichaReiser force-pushed the best-fits-call-expr branch from 7609f59 to a15564f Compare August 24, 2023 09:43

Base automatically changed from maybe-parenthesize-constants-and-names to main August 24, 2023 09:47

MichaReiser added 3 commits August 24, 2023 11:50

Use BestFits for non-call chain call expressions

223278a

Discard changes to crates/ruff_python_formatter/src/lib.rs

058c573

Use BestFits for non-call chain call expressions

92ce7de

MichaReiser force-pushed the best-fits-call-expr branch from a15564f to 92ce7de Compare August 24, 2023 09:51

MichaReiser added the formatter Related to the formatter label Aug 24, 2023

MichaReiser marked this pull request as ready for review August 24, 2023 09:51

MichaReiser mentioned this pull request Aug 24, 2023

Add tab width option #6848

Merged

konstin approved these changes Aug 24, 2023

View reviewed changes

MichaReiser merged commit 1cd7790 into main Aug 24, 2023
17 checks passed

MichaReiser deleted the best-fits-call-expr branch August 24, 2023 12:09

MichaReiser mentioned this pull request Oct 25, 2023

Formatter undocumented deviation: No wrap in long return #8182

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use BestFits for non-fluent attribute chains #6817

Use BestFits for non-fluent attribute chains #6817

MichaReiser commented Aug 23, 2023 •

edited

Loading

MichaReiser commented Aug 23, 2023 •

edited

Loading

github-actions bot commented Aug 23, 2023 •

edited

Loading

MichaReiser Aug 23, 2023

This comment was marked as outdated.

Use BestFits for non-fluent attribute chains #6817

Use BestFits for non-fluent attribute chains #6817

Conversation

MichaReiser commented Aug 23, 2023 • edited Loading

Summary

Test Plan

MichaReiser commented Aug 23, 2023 • edited Loading

github-actions bot commented Aug 23, 2023 • edited Loading

PR Check Results

Benchmark

Linux

Windows

MichaReiser Aug 23, 2023

Choose a reason for hiding this comment

This comment was marked as outdated.

MichaReiser commented Aug 23, 2023 •

edited

Loading

MichaReiser commented Aug 23, 2023 •

edited

Loading

github-actions bot commented Aug 23, 2023 •

edited

Loading