Trailing own line comments before func or class

[MichaReiser]

Summary

This PR adds special handling for own line comments between a statement and a function or class definition on the module level.

some = statement
# This should be stick to the statement above


# This should be split from the above by two lines
class MyClassWithComplexLeadingComments:
    pass

By default, the # This should be stick to the statement above would become a leading comment
of the class AND the Suite formatting separates the comment by two empty lines from the
previous statement, so that the result becomes:

some = statement


#  This should be stick to the statement above


# This should be split from the above by two lines
class MyClassWithComplexLeadingComments:
     pass

Which is not what we want. The work around is to make the # This should be stick to the statement above
a trailing comment of the previous statement.

Test Plan

You can see that this case is now correctly covered in the Black comments9.py test case

[MichaReiser]

Current dependencies on/for this PR:

• main
  • PR Add basic Constant formatting #4954
    • PR Trailing own line comments before func or class #4921 👈
      • PR Simple lexer for formatter #4922
        • PR Format Function definitions #4951
          • PR Format if statements #4961
            • PR Fix binary expression formatting with leading comments #4964
              • PR Track formatted comments #4979
              • PR perf(formatter): Skip bodies without comments #4978

This comment was auto-generated by Graphite.

[github-actions]

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      5.4±0.02ms     7.6 MB/sec    1.00      5.4±0.03ms     7.6 MB/sec
formatter/numpy/ctypeslib.py               1.00   1071.6±3.26µs    15.5 MB/sec    1.00   1075.4±9.25µs    15.5 MB/sec
formatter/numpy/globals.py                 1.01    125.7±1.37µs    23.5 MB/sec    1.00    124.7±0.13µs    23.7 MB/sec
formatter/pydantic/types.py                1.01      2.4±0.01ms    10.5 MB/sec    1.00      2.4±0.01ms    10.6 MB/sec
linter/all-rules/large/dataset.py          1.01     14.2±0.53ms     2.9 MB/sec    1.00     14.0±0.09ms     2.9 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.4±0.01ms     5.0 MB/sec    1.01      3.4±0.02ms     4.9 MB/sec
linter/all-rules/numpy/globals.py          1.00    418.2±0.42µs     7.1 MB/sec    1.01    420.7±0.47µs     7.0 MB/sec
linter/all-rules/pydantic/types.py         1.00      5.8±0.01ms     4.4 MB/sec    1.00      5.9±0.01ms     4.4 MB/sec
linter/default-rules/large/dataset.py      1.00      6.8±0.02ms     6.0 MB/sec    1.00      6.7±0.02ms     6.0 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1457.2±3.56µs    11.4 MB/sec    1.01  1467.0±11.39µs    11.4 MB/sec
linter/default-rules/numpy/globals.py      1.00    161.5±0.23µs    18.3 MB/sec    1.00    161.8±4.26µs    18.2 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.0±0.00ms     8.4 MB/sec    1.00      3.0±0.02ms     8.4 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.21      6.1±0.04ms     6.7 MB/sec    1.00      5.0±0.03ms     8.1 MB/sec
formatter/numpy/ctypeslib.py               1.18  1142.4±11.59µs    14.6 MB/sec    1.00   968.6±14.46µs    17.2 MB/sec
formatter/numpy/globals.py                 1.09    123.4±1.30µs    23.9 MB/sec    1.00    113.3±2.59µs    26.1 MB/sec
formatter/pydantic/types.py                1.17      2.6±0.02ms     9.8 MB/sec    1.00      2.2±0.03ms    11.4 MB/sec
linter/all-rules/large/dataset.py          1.02     12.5±0.17ms     3.2 MB/sec    1.00     12.3±0.10ms     3.3 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.02      3.2±0.03ms     5.2 MB/sec    1.00      3.2±0.02ms     5.3 MB/sec
linter/all-rules/numpy/globals.py          1.02    324.7±8.10µs     9.1 MB/sec    1.00    317.4±4.18µs     9.3 MB/sec
linter/all-rules/pydantic/types.py         1.01      5.3±0.09ms     4.8 MB/sec    1.00      5.3±0.06ms     4.8 MB/sec
linter/default-rules/large/dataset.py      1.02      6.2±0.06ms     6.5 MB/sec    1.00      6.1±0.03ms     6.6 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01  1287.2±18.48µs    12.9 MB/sec    1.00  1280.3±10.60µs    13.0 MB/sec
linter/default-rules/numpy/globals.py      1.00    135.7±1.41µs    21.7 MB/sec    1.01    136.6±1.85µs    21.6 MB/sec
linter/default-rules/pydantic/types.py     1.00      2.8±0.02ms     9.1 MB/sec    1.00      2.8±0.04ms     9.2 MB/sec