Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED for one-item named argument list #1160

Merged
merged 2 commits into from
Oct 10, 2023
Merged

Fix SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED for one-item named argument list #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98916b7
Fix SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED for one-item named argument…
alexey-pelykh Oct 6, 2023
5593287
Merge branch 'main' into fix/split_arguments_when_comma_terminated-si…
bwendling Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
### Changes
- Remove dependency on importlib-metadata
- Remove dependency on tomli when using >= py311

### Fixed
- Fix SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED for one-item named argument lists
by taking precedence over SPLIT_BEFORE_NAMED_ASSIGNS.

## [0.40.2] 2023-09-22
### Changes
Expand Down
19 changes: 10 additions & 9 deletions yapf/yapflib/format_decision_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,16 @@ def SurroundedByParens(token):

###########################################################################
# Argument List Splitting

if style.Get('SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED'):
# Split before arguments in a function call or definition if the
# arguments are terminated by a comma.
opening = _GetOpeningBracket(current)
if opening and opening.previous_token and opening.previous_token.is_name:
if previous.value in '(,':
if opening.matching_bracket.previous_token.value == ',':
return True

if (style.Get('SPLIT_BEFORE_NAMED_ASSIGNS') and not current.is_comment and
subtypes.DEFAULT_OR_NAMED_ASSIGN_ARG_LIST in current.subtypes):
if (previous.value not in {'=', ':', '*', '**'} and
Expand Down Expand Up @@ -409,15 +419,6 @@ def SurroundedByParens(token):
self._ArgumentListHasDictionaryEntry(current)):
return True

if style.Get('SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED'):
# Split before arguments in a function call or definition if the
# arguments are terminated by a comma.
opening = _GetOpeningBracket(current)
if opening and opening.previous_token and opening.previous_token.is_name:
if previous.value in '(,':
if opening.matching_bracket.previous_token.value == ',':
return True

if ((current.is_name or current.value in {'*', '**'}) and
previous.value == ','):
# If we have a function call within an argument list and it won't fit on
Expand Down
6 changes: 6 additions & 0 deletions yapftests/reformatter_basic_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2274,6 +2274,8 @@ def testSplittingArgumentsTerminatedByComma(self):
r =f0 (1, 2,3,)

r =f0 (1,)

r =f0 (a=1,)
""") # noqa
expected_formatted_code = textwrap.dedent("""\
function_name(argument_name_1=1, argument_name_2=2, argument_name_3=3)
Expand Down Expand Up @@ -2306,6 +2308,10 @@ def testSplittingArgumentsTerminatedByComma(self):
r = f0(
1,
)

r = f0(
a=1,
)
""")

try:
Expand Down