Feature align assignment #1030

lizawang · 2022-10-03T14:05:33Z

Hello all yapf founders!

I have some new features I want to share with the yapf community.

The alignment feature added is referred to the yapf function _AlignTrailingComments(final_lines).

The knobs

The main functions for all the knobs are added in reformatter.py.

knob: ALIGN_ASSIGNMENT

This is an option to align the assignment and augmented assignment operators of different variable assignment lines in the same block.

For the case when there are two assignment operators on one line, only the first assignment operator is aligned:
```
timeend   = record[ "timeend" ] = ts_end
self      = "xyz"
tablename = "treditab"
```
New block starts with new alignment. There are 5 cases that are featured to indicate a new block:
- If there is any blank line in between:
```
a   = 1
abc = 2

b  = 3
bc = 4
```
- If there is any comment line in between:
```
a   = 1
abc = 2
# comment
b  = 3
bc = 4
```
- If there is any if/ while/ for line or function definition def line in between:
```
a   = 1
abc = 2
if condition == None:
    var = ''
b  = 3
bc = 4
```
- If there is any object(e.g. a dictionary, a list, a argument list, a set, a function call) that with its items on newlines after '=' in between:
```
tablename = "treditab"
list      = [
    {
        "field"    : "ediid",
        "type"     : "text",
        "required" : True,
        "html"     : {},
    }
]
test = "another block"
```
- If there is any variable assignment lines with different indentation in between:
```
a   = 1
abc = 2
if condition == None:
    var       += ''
    var_long  -= 4
b  = 3
bc = 4
```

knob: NEW_ALIGNMENT_AFTER_COMMENTLINE

This option is made under the consideration that some programmers may prefer to remain the alignment with comment lines inside.

If it is set False, a comment line in between won't create a new alignment block. Entries before and after the comment line/lines will align with their assignment operators.

Preparations

To make the alignment functions possible, some other changes are made to other files.

format_token.py: necessary boolean functions are added, is_assign, is_augassign.

Finally

In the end, the knobs are added into the style.py and tests for each one are also updated in yapftests folder.

style.py: all the 2 knobs are set to be False by default.
Unitests are added into reformatter_basic_test.py.

bwendling

This has way too many reformatting changes in it. Please make sure that the new options aren't enabled by default. Also please make sure that you're using the correct formatting style for YAPF.

bwendling · 2023-11-28T21:24:24Z

README.rst

+ .. code-block:: python
+
+ fields =
+ {


This opening bracket should be on the first line.

bwendling · 2023-11-28T21:24:42Z

CHANGELOG

@@ -2,6 +2,10 @@
 # All notable changes to this project will be documented in this file.
 # This project adheres to [Semantic Versioning](http://semver.org/).

+## [0.41.1] 2022-08-30
+### Added
+- Add 4 new knobs to align assignment operators and dictionary colons. They are align_assignment, align_argument_assignment, align_dict_colon and new_alignment_after_commentline.


Please reflow this to 80-columns.

bwendling · 2023-11-28T21:25:13Z

yapf/pytree/split_penalty.py

@@ -89,7 +89,7 @@ def Visit_classdef(self, node): # pylint: disable=invalid-name
 if len(node.children) > 4:
 # opening '('
 _SetUnbreakable(node.children[2])
- # ':'
+  # ':'


I don't know why this is here...

bwendling · 2023-11-28T21:25:27Z

yapf/pytree/subtype_assigner.py

@@ -240,6 +240,7 @@ def Visit_argument(self, node): # pylint: disable=invalid-name
 # argument ::=
 # test [comp_for] | test '=' test
 self._ProcessArgLists(node)
+ #TODO add a subtype to each argument?


Please remove any TODO comments.

bwendling · 2023-11-28T21:26:29Z

yapf/yapflib/format_token.py

+
+ @property
+ def is_augassign(self):
+ augassigns = {


Please use a frozenset and move this out of the method into the class itself.

bwendling · 2023-11-28T21:28:08Z

yapf/yapflib/reformatter.py

@@ -394,6 +398,172 @@ def _AlignTrailingComments(final_lines):
 final_lines_index += 1


+def _AlignAssignment(final_lines):


This function is very long. Please split it up into smaller functions so that it's more readable.

bwendling · 2023-11-28T21:29:19Z

yapf/yapflib/style.py

+ it will start new block alignment."""),
+ NEW_ALIGNMENT_AFTER_COMMENTLINE=textwrap.dedent("""\
+ Start new assignment or colon alignment when there is a newline comment in between."""
+ ),


Please don't leave the ending paren in that place. :-)

I'm also not a fan of this knob's name. Maybe something like ALIGN_ASSIGNMENT_AFTER_COMMENTS.

bwendling · 2023-11-28T21:29:45Z

yapf/yapflib/style.py

@@ -54,6 +54,13 @@ def SetGlobalStyle(style):
 _STYLE_HELP = dict(
 ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT=textwrap.dedent("""\
 Align closing bracket with visual indentation."""),
+ ALIGN_ASSIGNMENT=textwrap.dedent("""\


Please add the examples to these knobs.

Also the knobs should be alphabetized.

bwendling · 2023-11-28T21:31:52Z

yapftests/format_token_test.py

@@ -15,10 +15,11 @@

 import unittest

-from lib2to3 import pytree
+from lib2to3 import pytree, pygram


I don't think you need this change.

bwendling · 2023-11-28T21:32:00Z

yapftests/format_token_test.py

 from lib2to3.pgen2 import token

 from yapf.yapflib import format_token
+from yapf.pytree import subtype_assigner


Or this change.

lizawang and others added 10 commits August 18, 2022 10:40

features to align assignment operators and dictionary colons

f62d929

update the changelog and readme

7a7de67

small fixes

94cca9b

Update README.rst

2ecde17

fix readme

e2181d8

fix readme

4275bb7

fix align_dict_colon

82f1326

add test for the case when the dict starts with a comment

6c273dc

branch for assignment alignment

db00217

run the assignment align over the yapf codes

beec868

bwendling reviewed Nov 16, 2022

View reviewed changes

lizawang added 2 commits January 3, 2023 10:30

change the format back to yapf-based

aa3f8a7

change the format back to yapf-based 2

ad90616

bwendling reviewed Nov 28, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature align assignment #1030

Feature align assignment #1030

lizawang commented Oct 3, 2022 •

edited

bwendling left a comment

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

bwendling Nov 28, 2023

		@@ -394,6 +398,172 @@ def _AlignTrailingComments(final_lines):
		final_lines_index += 1


		def _AlignAssignment(final_lines):

Feature align assignment #1030

Are you sure you want to change the base?

Feature align assignment #1030

Conversation

lizawang commented Oct 3, 2022 • edited

Hello all yapf founders!

The knobs

knob: ALIGN_ASSIGNMENT

knob: NEW_ALIGNMENT_AFTER_COMMENTLINE

Preparations

Finally

bwendling left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizawang commented Oct 3, 2022 •

edited