(fix) SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED: skip comment

google · Dec 10, 2024 · 849ed5d · 849ed5d
1 parent bb83461
commit 849ed5d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/yapf/yapflib/format_decision_state.py b/yapf/yapflib/format_decision_state.py
@@ -390,6 +390,10 @@ def SurroundedByParens(token):
       if opening and opening.previous_token and opening.previous_token.is_name:
         if previous.value in '(,':
           if opening.matching_bracket.previous_token.value == ',':
+            if current.is_comment:
+              # Don't require splitting before a comment, since it may be
+              # related to the current line.
+              return False
             return True
 
     if (style.Get('SPLIT_BEFORE_NAMED_ASSIGNS') and not current.is_comment and

diff --git a/yapftests/reformatter_basic_test.py b/yapftests/reformatter_basic_test.py
@@ -2336,6 +2336,10 @@ def _pack_results_for_constraint_or(cls, combination, constraints):
 
   def testSplittingArgumentsTerminatedByComma(self):
     unformatted_code = textwrap.dedent("""\
+        class Class(  # comment
+            object,):
+          pass
+
         function_name(argument_name_1=1, argument_name_2=2, argument_name_3=3)
 
         function_name(argument_name_1=1, argument_name_2=2, argument_name_3=3,)
@@ -2351,6 +2355,12 @@ def testSplittingArgumentsTerminatedByComma(self):
         r =f0 (a=1,)
     """)  # noqa
     expected_formatted_code = textwrap.dedent("""\
+        class Class(  # comment
+            object,
+        ):
+          pass
+
+
         function_name(argument_name_1=1, argument_name_2=2, argument_name_3=3)
 
         function_name(