mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-07-24 05:25:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Don't move type param opening parenthesis comment (#8163)

Browse source 
## Summary

This PR fixes the issue to avoid collapsing the type param declaration
if
there's a comment after the opening parenthesis. For example,

```python
type foo[  # comment
    A,
    B
] = int
```

Here, we'll preserve the comment on the same line as is being done for
other
similar type of nodes.

## Test Plan

Add a new test case for it, update the snapshots, and validate the
ecosystem
check.

### Formatter ecosystem

#### `main`

| project | similarity index | total files | changed files |

|----------------|------------------:|------------------:|------------------:|
| cpython | 0.75803 | 1799 | 1647 |
| django | 0.99983 | 2772 | 34 |
| home-assistant | 0.99953 | 10596 | 186 |
| poetry | 0.99891 | 317 | 17 |
| transformers | 0.99966 | 2657 | 330 |
| twine | 1.00000 | 33 | 0 |
| typeshed | 0.99978 | 3669 | 20 |
| warehouse | 0.99977 | 654 | 13 |
| zulip | 0.99970 | 1459 | 22 |

#### `dhruv/type-params`

| project | similarity index | total files | changed files |

|----------------|------------------:|------------------:|------------------:|
| cpython | 0.75803 | 1799 | 1647 |
| django | 0.99983 | 2772 | 34 |
| home-assistant | 0.99953 | 10596 | 186 |
| poetry | 0.99891 | 317 | 17 |
| transformers | 0.99966 | 2657 | 330 |
| twine | 1.00000 | 33 | 0 |
| typeshed | 0.99978 | 3669 | 20 |
| warehouse | 0.99977 | 654 | 13 |
| zulip | 0.99970 | 1459 | 22 |

fixes: #8162
This commit is contained in:
Dhruv Manilawala 2023-10-24 17:32:27 +05:30 • committed by GitHub
parent 9feb86caa4
commit 2e81b9c391
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_value.py.snap
View file

@ -327,7 +327,9 @@ f3 = { # f3
# Non-empty parentheses: These are not allowed without a value
def f1[T](): # f1
def f1[ # f1
T
]():
pass

8
crates/ruff_python_formatter/tests/snapshots/format@statement__type_alias.py.snap
View file

@ -87,6 +87,10 @@ type type_params_comments[ # trailing open bracket comment
D, # trailing comment
# leading close bracket comment
] = int # trailing value comment
type type_params_single_comment[ # trailing open bracket comment
A,
B
] = int
type type_params_all_kinds[type_var, *type_var_tuple, **param_spec] = int
# type variable bounds
@ -201,6 +205,10 @@ type type_params_comments[ # trailing open bracket comment
D, # trailing comment
# leading close bracket comment
] = int # trailing value comment
type type_params_single_comment[ # trailing open bracket comment
A,
B,
] = int
type type_params_all_kinds[type_var, *type_var_tuple, **param_spec] = int
# type variable bounds