Bill Wendling | dcafd5f | 2015-09-12 15:26:03 -0700 | [diff] [blame] | 1 | # Change Log |
| 2 | # All notable changes to this project will be documented in this file. |
| 3 | # This project adheres to [Semantic Versioning](http://semver.org/). |
| 4 | |
Bill Wendling | 4922549 | 2018-07-01 23:02:35 -0700 | [diff] [blame] | 5 | ## [0.23.0] UNRELEASED |
| 6 | ### Added |
| 7 | - `DISABLE_ENDING_COMMA_HEURISTIC` is a new knob to disable the heuristic which |
| 8 | splits a list onto separate lines if the list is comma-terminated. |
Bill Wendling | 19dbc7a | 2018-05-21 14:29:10 -0700 | [diff] [blame] | 9 | ### Fixed |
| 10 | - There's no need to increase N_TOKENS. In fact, it causes other things which |
| 11 | use lib2to3 to fail if called from YAPF. |
Bill Wendling | a1001b1 | 2018-07-01 22:25:30 -0700 | [diff] [blame] | 12 | - Change the exception message instead of creating a new one that's just a |
| 13 | clone. |
Bill Wendling | 19dbc7a | 2018-05-21 14:29:10 -0700 | [diff] [blame] | 14 | |
Bill Wendling | d52ae2a | 2018-05-15 22:24:24 -0700 | [diff] [blame] | 15 | ## [0.22.0] 2018-05-15 |
Dan Porter | 61d8809 | 2018-03-22 12:52:16 +0000 | [diff] [blame] | 16 | ### Added |
| 17 | - The `BLANK_LINE_BEFORE_MODULE_DOCSTRING` knob adds a blank line before a |
| 18 | module's docstring. |
cardenb | 83a62ad | 2018-05-14 22:54:12 -0700 | [diff] [blame] | 19 | - The `SPLIT_ALL_COMMA_SEPARATED_VALUES` knob causes all lists, tuples, dicts |
| 20 | function defs, etc... to split on all values, instead of maximizing the |
| 21 | number of elements on each line, when not able to fit on a single line. |
Bill Wendling | 3bab584 | 2018-03-26 22:26:06 -0700 | [diff] [blame] | 22 | ### Changed |
| 23 | - Improve the heuristic we use to determine when to split at the start of a |
| 24 | function call. First check whether or not all elements can fit in the space |
| 25 | without wrapping. If not, then we split. |
Bill Wendling | 2b0b2ca | 2018-03-26 22:56:55 -0700 | [diff] [blame] | 26 | - Check all of the elements of a tuple. Similarly to how arguments are |
| 27 | analyzed. This allows tuples to be split more rationally. |
Bill Wendling | 8f8c5f5 | 2018-03-27 13:43:11 -0700 | [diff] [blame] | 28 | - Adjust splitting penalties around arithmetic operators so that the code can |
| 29 | flow more freely. The code must flow! |
Bill Wendling | 4ddb2fe | 2018-03-27 15:31:54 -0700 | [diff] [blame] | 30 | - Try to meld an argument list's closing parenthesis to the last argument. |
Bill Wendling | d5df208 | 2018-03-26 23:25:45 -0700 | [diff] [blame] | 31 | ### Fixed |
| 32 | - Attempt to determine if long lambdas are allowed. This can be done on a |
| 33 | case-by-case basis with a "pylint" disable comment. |
Bill Wendling | 3d9e998 | 2018-03-27 00:15:30 -0700 | [diff] [blame] | 34 | - A comment before a decorator isn't part of the decorator's line. |
Bill Wendling | d059cc4 | 2018-03-30 20:45:14 -0700 | [diff] [blame] | 35 | - Only force a new wrapped line after a comment in a decorator when it's the |
| 36 | first token in the decorator. |
Dan Porter | 61d8809 | 2018-03-22 12:52:16 +0000 | [diff] [blame] | 37 | |
Bill Wendling | 06a2340 | 2018-03-18 20:42:05 -0700 | [diff] [blame] | 38 | ## [0.21.0] 2018-03-18 |
Patryk Zawadzki | 6d79f13 | 2018-02-13 16:31:25 +0100 | [diff] [blame] | 39 | ### Added |
| 40 | - Introduce a new option of formatting multiline literals. Add |
| 41 | `SPLIT_BEFORE_CLOSING_BRACKET` knob to control whether closing bracket should |
| 42 | get their own line. |
Yinyin L | a56072f | 2018-03-05 02:04:34 +0800 | [diff] [blame] | 43 | - Added `CONTINUATION_ALIGN_STYLE` knob to choose continuation alignment style |
| 44 | when `USE_TABS` is enabled. |
Markus Gerstel | 52ca45a | 2018-02-14 17:07:35 +0000 | [diff] [blame] | 45 | - Add 'BLANK_LINES_AROUND_TOP_LEVEL_DEFINITION' knob to control the number |
| 46 | of blank lines between top-level function and class definitions. |
Bill Wendling | 338c1c4 | 2018-03-14 23:59:49 -0700 | [diff] [blame] | 47 | ### Fixed |
| 48 | - Don't split ellipses. |
Patryk Zawadzki | 6d79f13 | 2018-02-13 16:31:25 +0100 | [diff] [blame] | 49 | |
Bill Wendling | 6e83cf3 | 2018-02-12 13:22:47 -0800 | [diff] [blame] | 50 | ## [0.20.2] 2018-02-12 |
Bill Wendling | 9e3dc4e | 2018-01-24 11:19:24 -0800 | [diff] [blame] | 51 | ### Changed |
| 52 | - Improve the speed at which files are excluded by ignoring them earlier. |
Bill Wendling | 6ae096b | 2018-01-25 22:22:31 -0800 | [diff] [blame] | 53 | - Allow dictionaries to stay on a single line if they only have one entry |
Bill Wendling | d377549 | 2018-01-14 17:43:10 -0800 | [diff] [blame] | 54 | ### Fixed |
| 55 | - Use tabs when constructing a continuation line when `USE_TABS` is enabled. |
Bill Wendling | 7c316cc | 2018-01-24 12:35:26 -0800 | [diff] [blame] | 56 | - A dictionary entry may not end in a colon, but may be an "unpacking" |
| 57 | operation: `**foo`. Take that into accound and don't split after the |
| 58 | unpacking operator. |
Bill Wendling | d377549 | 2018-01-14 17:43:10 -0800 | [diff] [blame] | 59 | |
Bill Wendling | 06c973f | 2018-01-13 22:04:00 -0800 | [diff] [blame] | 60 | ## [0.20.1] 2018-01-13 |
Bill Wendling | a0de11a | 2017-12-17 23:58:02 -0800 | [diff] [blame] | 61 | ### Fixed |
| 62 | - Don't treat 'None' as a keyword if calling a function on it, like '__ne__()'. |
Petter Strandmark | 4d2bee0 | 2018-01-10 21:42:37 +0100 | [diff] [blame] | 63 | - use_tabs=True always uses a single tab per indentation level; spaces are |
| 64 | used for aligning vertically after that. |
Bill Wendling | 06c973f | 2018-01-13 22:04:00 -0800 | [diff] [blame] | 65 | - Relax the split of a paren at the end of an if statement. With |
delirious-lettuce | b795f6d | 2018-01-16 20:38:46 -0700 | [diff] [blame] | 66 | `dedent_closing_brackets` option requires that it be able to split there. |
Bill Wendling | a0de11a | 2017-12-17 23:58:02 -0800 | [diff] [blame] | 67 | |
Bill Wendling | 0b8364e | 2017-11-14 23:45:50 -0800 | [diff] [blame] | 68 | ## [0.20.0] 2017-11-14 |
Matthew Suozzo | f021105 | 2017-11-01 17:52:28 -0400 | [diff] [blame] | 69 | ### Added |
| 70 | - Improve splitting of comprehensions and generators. Add |
| 71 | `SPLIT_PENALTY_COMPREHENSION` knob to control preference for keeping |
| 72 | comprehensions on a single line and `SPLIT_COMPLEX_COMPREHENSION` to enable |
| 73 | splitting each clause of complex comprehensions onto its own line. |
Bill Wendling | 8c07cc1 | 2017-10-16 00:37:58 -0700 | [diff] [blame] | 74 | ### Changed |
| 75 | - Take into account a named function argument when determining if we should |
| 76 | split before the first argument in a function call. |
Bill Wendling | 1dc75ac | 2017-10-16 02:45:46 -0700 | [diff] [blame] | 77 | - Split before the first argument in a function call if the arguments contain a |
| 78 | dictionary that doesn't fit on a single line. |
Bill Wendling | b1c7ca8 | 2017-10-21 00:02:49 -0700 | [diff] [blame] | 79 | - Improve splitting of elements in a tuple. We want to split if there's a |
| 80 | function call in the tuple that doesn't fit on the line. |
Bill Wendling | 7bfc0a9 | 2017-10-16 03:22:19 -0700 | [diff] [blame] | 81 | ### Fixed |
| 82 | - Enforce spaces between ellipses and keywords. |
Bill Wendling | bd9d955 | 2017-10-16 22:45:17 -0700 | [diff] [blame] | 83 | - When calculating the split penalty for a "trailer", process the child nodes |
| 84 | afterwards because their penalties may change. For example if a list |
| 85 | comprehension is an argument. |
Bill Wendling | d404b70 | 2017-10-16 23:16:14 -0700 | [diff] [blame] | 86 | - Don't enforce a split before a comment after the opening of a container if it |
| 87 | doesn't it on the current line. We try hard not to move such comments around. |
Bill Wendling | ca46e86 | 2017-10-24 00:46:11 -0700 | [diff] [blame] | 88 | - Use a TextIOWrapper when reading from stdin in Python3. This is necessary for |
| 89 | some encodings, like cp936, used on Windows. |
Matthew Suozzo | 2112ad2 | 2017-10-29 18:23:03 -0400 | [diff] [blame] | 90 | - Remove the penalty for a split before the first argument in a function call |
| 91 | where the only argument is a generator expression. |
Bill Wendling | 8c07cc1 | 2017-10-16 00:37:58 -0700 | [diff] [blame] | 92 | |
Bill Wendling | 4d9b905 | 2017-10-14 15:02:31 -0700 | [diff] [blame] | 93 | ## [0.19.0] 2017-10-14 |
Bill Wendling | 9680f73 | 2017-10-09 01:11:38 -0700 | [diff] [blame] | 94 | ### Added |
| 95 | - Added `SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN` that enforces a split |
| 96 | after the opening paren of an expression that's surrounded by parens. |
Bill Wendling | 5f83cfb | 2017-10-08 01:12:27 -0700 | [diff] [blame] | 97 | ### Changed |
| 98 | - Split before the ending bracket of a comma-terminated tuple / argument list |
| 99 | if it's not a single element tuple / arg list. |
Bill Wendling | ba55eb1 | 2017-09-19 14:30:02 -0700 | [diff] [blame] | 100 | ### Fixed |
| 101 | - Prefer to split after a comma in an argument list rather than in the middle |
| 102 | of an argument. |
Bill Wendling | 61f93c3 | 2017-10-01 00:35:30 -0700 | [diff] [blame] | 103 | - A non-multiline string may have newlines if it contains continuation markers |
| 104 | itself. Don't add a newline after the string when retaining the vertical |
| 105 | space. |
Bill Wendling | 9df211b | 2017-10-01 01:12:22 -0700 | [diff] [blame] | 106 | - Take into account the "async" keyword when determining if we must split |
| 107 | before the first argument. |
Bill Wendling | 7491187 | 2017-10-04 02:59:30 -0700 | [diff] [blame] | 108 | - Increase affinity for "atom" arguments in function calls. This helps prevent |
| 109 | lists from being separated when they don't need to be. |
Bill Wendling | b00e4f6 | 2017-10-07 03:22:12 -0700 | [diff] [blame] | 110 | - Don't place a dictionary argument on its own line if it's the last argument |
| 111 | in the function call where that function is part of a builder-style call. |
Bill Wendling | a531f21 | 2017-10-12 15:58:29 -0700 | [diff] [blame] | 112 | - Append the "var arg" type to a star in a star_expr. |
Bill Wendling | ba55eb1 | 2017-09-19 14:30:02 -0700 | [diff] [blame] | 113 | |
Bill Wendling | 7ef7e14 | 2017-09-18 16:59:48 -0700 | [diff] [blame] | 114 | ## [0.18.0] 2017-09-18 |
Bill Wendling | 8a3b71f | 2017-08-26 02:34:03 -0700 | [diff] [blame] | 115 | ### Added |
| 116 | - Option `ALLOW_SPLIT_BEFORE_DICT_VALUE` allows a split before a value. If |
| 117 | False, then it won't be split even if it goes over the column limit. |
Bill Wendling | 855860e | 2017-08-24 21:31:33 -0700 | [diff] [blame] | 118 | ### Changed |
| 119 | - Use spaces around the '=' in a typed name argument to align with 3.6 syntax. |
Bill Wendling | 8012f59 | 2017-08-21 01:23:18 -0700 | [diff] [blame] | 120 | ### Fixed |
| 121 | - Allow semicolons if the line is disabled. |
Bouwe Andela | f6dba62 | 2017-08-21 21:33:23 +0200 | [diff] [blame] | 122 | - Fix issue where subsequent comments at decreasing levels of indentation |
| 123 | were improperly aligned and/or caused output with invalid syntax. |
Bill Wendling | 562e04c | 2017-08-23 02:32:11 -0700 | [diff] [blame] | 124 | - Fix issue where specifying a line range removed a needed line before a |
| 125 | comment. |
Bill Wendling | 6e7f5a8 | 2017-08-24 20:15:08 -0700 | [diff] [blame] | 126 | - Fix spacing between unary operators if one is 'not'. |
Bill Wendling | 578854b | 2017-08-24 22:26:59 -0700 | [diff] [blame] | 127 | - Indent the dictionary value correctly if there's a multi-line key. |
Bill Wendling | 8ee1b53 | 2017-09-06 13:58:32 -0700 | [diff] [blame] | 128 | - Don't remove needed spacing before a comment in a dict when in "chromium" |
| 129 | style. |
Bill Wendling | 6412ce7 | 2017-09-18 16:18:48 -0700 | [diff] [blame] | 130 | - Increase indent for continuation line with same indent as next logical line |
| 131 | with 'async with' statement. |
Bill Wendling | 8012f59 | 2017-08-21 01:23:18 -0700 | [diff] [blame] | 132 | |
Bill Wendling | 5f73720 | 2017-08-20 22:03:12 -0700 | [diff] [blame] | 133 | ## [0.17.0] 2017-08-20 |
Jiri Kuncar | f14bd17 | 2017-07-21 09:45:31 +0200 | [diff] [blame] | 134 | ### Added |
| 135 | - Option `NO_SPACES_AROUND_SELECTED_BINARY_OPERATORS` prevents adding spaces |
| 136 | around selected binary operators, in accordance with the current style guide. |
Kevin Cox | c565e83 | 2017-07-21 13:50:47 +0100 | [diff] [blame] | 137 | ### Changed |
| 138 | - Adjust blank lines on formatting boundaries when using the `--lines` option. |
Bill Wendling | 71d9b2e | 2017-08-01 13:38:54 -0700 | [diff] [blame] | 139 | - Return 1 if a diff changed the code. This is in line with how GNU diff acts. |
Max Vorobev | 3b90311 | 2017-08-26 14:43:48 +0300 | [diff] [blame] | 140 | - Add `-vv` flag to print out file names as they are processed |
Richard Wall | acad4ce | 2017-08-04 15:08:40 +0100 | [diff] [blame] | 141 | ### Fixed |
| 142 | - Corrected how `DEDENT_CLOSING_BRACKETS` and `COALESCE_BRACKETS` interacted. |
Bill Wendling | b0de56d | 2017-08-12 15:21:12 -0700 | [diff] [blame] | 143 | - Fix return value to return a boolean. |
Anton Yuzhaninov | db85e87 | 2017-07-19 22:45:45 -0400 | [diff] [blame] | 144 | - Correct vim plugin not to clobber edited code if yapf returns an error. |
Justin Huang | 767edac | 2017-08-12 17:36:41 -0700 | [diff] [blame] | 145 | - Ensured comma-terminated tuples with multiple elements are split onto separate lines. |
Kevin Cox | c565e83 | 2017-07-21 13:50:47 +0100 | [diff] [blame] | 146 | |
Bill Wendling | 4aa43d8 | 2017-07-13 00:45:39 -0700 | [diff] [blame] | 147 | ## [0.16.3] 2017-07-13 |
Bill Wendling | 81a6d84 | 2017-07-12 23:58:17 -0700 | [diff] [blame] | 148 | ### Changed |
delirious-lettuce | b795f6d | 2018-01-16 20:38:46 -0700 | [diff] [blame] | 149 | - Add filename information to a ParseError exception. |
Bill Wendling | 77ca21d | 2017-03-28 00:41:18 -0700 | [diff] [blame] | 150 | ### Fixed |
Bill Wendling | 4aa43d8 | 2017-07-13 00:45:39 -0700 | [diff] [blame] | 151 | - A token that ends in a continuation marker may have more than one newline in |
| 152 | it, thus changing its "lineno" value. This can happen if multiple |
| 153 | continuation markers are used with no intervening tokens. Adjust the line |
| 154 | number to account for the lines covered by those markers. |
| 155 | - Make sure to split after a comment even for "pseudo" parentheses. |
| 156 | |
| 157 | ## [0.16.2] 2017-05-19 |
| 158 | ### Fixed |
Bill Wendling | 77ca21d | 2017-03-28 00:41:18 -0700 | [diff] [blame] | 159 | - Treat expansion operators ('*', '**') in a similar way to function calls to |
| 160 | avoid splitting directly after the opening parenthesis. |
| 161 | - Increase the penalty for splitting after the start of a tuple. |
Bill Wendling | e67e353 | 2017-03-31 00:43:00 -0700 | [diff] [blame] | 162 | - Increase penalty for excess characters. |
Bill Wendling | 16becc5 | 2017-04-02 19:52:49 -0700 | [diff] [blame] | 163 | - Check that we have enough children before trying to access them all. |
Bill Wendling | da3697c | 2017-04-13 00:32:09 -0700 | [diff] [blame] | 164 | - Remove trailing whitespaces from comments. |
Bill Wendling | a36bb6d | 2017-04-16 18:51:53 -0700 | [diff] [blame] | 165 | - Split before a function call in a list if the full list isn't able to fit on |
| 166 | a single line. |
Bill Wendling | 1cfcbd1 | 2017-04-17 19:38:28 -0700 | [diff] [blame] | 167 | - Trying not to split around the '=' of a named assign. |
Bill Wendling | 81a6d84 | 2017-07-12 23:58:17 -0700 | [diff] [blame] | 168 | - Changed split before the first argument behavior to ignore compound |
| 169 | statements like if and while, but not function declarations. |
| 170 | - Changed coalesce brackets not to line split before closing bracket. |
Bill Wendling | 77ca21d | 2017-03-28 00:41:18 -0700 | [diff] [blame] | 171 | |
Bill Wendling | 5ca3109 | 2017-03-22 11:41:07 -0700 | [diff] [blame] | 172 | ## [0.16.1] 2017-03-22 |
Bill Wendling | 5a1e331 | 2017-02-14 18:40:43 -0800 | [diff] [blame] | 173 | ### Changed |
| 174 | - Improved performance of cloning the format decision state object. This |
| 175 | improved the time in one *large* case from 273.485s to 234.652s. |
Bill Wendling | c2f520c | 2017-02-15 22:03:18 -0800 | [diff] [blame] | 176 | - Relax the requirement that a named argument needs to be on one line. Going |
| 177 | over the column limit is more of an issue to pylint than putting named args |
| 178 | on multiple lines. |
Bill Wendling | 79b82ef | 2017-02-17 00:24:51 -0800 | [diff] [blame] | 179 | - Don't make splitting penalty decisions based on the original formatting. This |
| 180 | can and does lead to non-stable formatting, where yapf will reformat the same |
| 181 | code in different ways. |
Bill Wendling | a952966 | 2017-02-06 21:47:39 -0800 | [diff] [blame] | 182 | ### Fixed |
| 183 | - Ensure splitting of arguments if there's a named assign present. |
Bill Wendling | 56f0fb6 | 2017-02-06 22:58:05 -0800 | [diff] [blame] | 184 | - Prefer to coalesce opening brackets if it's not at the beginning of a |
| 185 | function call. |
Bill Wendling | 313c65a | 2017-02-17 01:56:45 -0800 | [diff] [blame] | 186 | - Prefer not to squish all of the elements in a function call over to the |
| 187 | right-hand side. Split the arguments instead. |
Bill Wendling | 257c1b0 | 2017-02-20 15:32:29 -0800 | [diff] [blame] | 188 | - We need to split a dictionary value if the first element is a comment anyway, |
| 189 | so don't force the split here. It's forced elsewhere. |
CaselIT | d69801d | 2017-02-21 13:45:13 +0100 | [diff] [blame] | 190 | - Ensure tabs are used for continued indentation when USE_TABS is True. |
Bill Wendling | a952966 | 2017-02-06 21:47:39 -0800 | [diff] [blame] | 191 | |
Bill Wendling | 873039e | 2017-02-05 20:24:46 -0800 | [diff] [blame] | 192 | ## [0.16.0] 2017-02-05 |
Bill Wendling | 0e9b321 | 2017-01-31 14:41:00 -0800 | [diff] [blame] | 193 | ### Added |
| 194 | - The `EACH_DICT_ENTRY_ON_SEPARATE_LINE` knob indicates that each dictionary |
| 195 | entry should be in separate lines if the full dictionary isn't able to fit on |
| 196 | a single line. |
| 197 | - The `SPLIT_BEFORE_DICT_SET_GENERATOR` knob splits before the `for` part of a |
| 198 | dictionary/set generator. |
Bill Wendling | 9f49752 | 2017-02-04 04:39:47 -0800 | [diff] [blame] | 199 | - The `BLANK_LINE_BEFORE_CLASS_DOCSTRING` knob adds a blank line before a |
| 200 | class's docstring. |
Bill Wendling | 8d32136 | 2017-02-05 18:29:26 -0800 | [diff] [blame] | 201 | - The `ALLOW_MULTILINE_DICTIONARY_KEYS` knob allows dictionary keys to span |
| 202 | more than one line. |
Bill Wendling | 94962e5 | 2017-02-04 04:07:19 -0800 | [diff] [blame] | 203 | ### Fixed |
| 204 | - Split before all entries in a dict/set or list maker when comma-terminated, |
| 205 | even if there's only one entry. |
Adrian Tejn Kern | bfee67d | 2017-02-05 08:36:02 +0100 | [diff] [blame] | 206 | - Will now try to set O_BINARY mode on stdout under Windows and Python 2. |
| 207 | - Avoid unneeded newline transformation when writing formatted code to |
| 208 | output on (affects only Python 2) |
Bill Wendling | 0e9b321 | 2017-01-31 14:41:00 -0800 | [diff] [blame] | 209 | |
Bill Wendling | 3d470dd | 2017-01-29 19:45:13 -0800 | [diff] [blame] | 210 | ## [0.15.2] 2017-01-29 |
Bill Wendling | bf63118 | 2017-01-24 15:34:35 -0800 | [diff] [blame] | 211 | ### Fixed |
| 212 | - Don't perform a global split when a named assign is part of a function call |
| 213 | which itself is an argument to a function call. I.e., don't cause 'a' to |
| 214 | split here: |
| 215 | |
| 216 | func(a, b, c, d(x, y, z=42)) |
Bill Wendling | b64e702 | 2017-01-25 09:44:41 -0800 | [diff] [blame] | 217 | - Allow splitting inside a subscript if it's a logical or bitwise operating. |
| 218 | This should keep the subscript mostly contiguous otherwise. |
Bill Wendling | bf63118 | 2017-01-24 15:34:35 -0800 | [diff] [blame] | 219 | |
Bill Wendling | 5d7b361 | 2017-01-21 23:43:35 -0800 | [diff] [blame] | 220 | ## [0.15.1] 2017-01-21 |
Bill Wendling | 672ece0 | 2017-01-14 16:35:48 -0800 | [diff] [blame] | 221 | ### Fixed |
| 222 | - Don't insert a space between a type hint and the '=' sign. |
Bill Wendling | b57e71c | 2017-01-14 16:51:35 -0800 | [diff] [blame] | 223 | - The '@' operator can be used in Python 3 for matrix multiplication. Give the |
| 224 | '@' in the decorator a DECORATOR subtype to distinguish it. |
Bill Wendling | fd30b91 | 2017-01-15 16:45:24 -0800 | [diff] [blame] | 225 | - Encourage the formatter to split at the beginning of an argument list instead |
| 226 | of in the middle. Especially if the middle is an empty parameter list. This |
| 227 | adjusts the affinity of binary and comparison operators. In particular, the |
| 228 | "not in" and other such operators don't want to have a split after it (or |
| 229 | before it) if at all possible. |
Bill Wendling | 672ece0 | 2017-01-14 16:35:48 -0800 | [diff] [blame] | 230 | |
Bill Wendling | 61061f6 | 2017-01-12 20:58:55 -0800 | [diff] [blame] | 231 | ## [0.15.0] 2017-01-12 |
| 232 | ### Added |
| 233 | - Keep type annotations intact as much as possible. Don't try to split the over |
delirious-lettuce | b795f6d | 2018-01-16 20:38:46 -0700 | [diff] [blame] | 234 | multiple lines. |
Bill Wendling | b50a6b2 | 2016-11-27 17:06:58 -0800 | [diff] [blame] | 235 | ### Fixed |
| 236 | - When determining if each element in a dictionary can fit on a single line, we |
| 237 | are skipping dictionary entries. However, we need to ignore comments in our |
| 238 | calculations and implicitly concatenated strings, which are already placed on |
| 239 | separate lines. |
Bill Wendling | 596300d | 2016-11-28 13:08:57 -0800 | [diff] [blame] | 240 | - Allow text before a "pylint" comment. |
Bill Wendling | eb979f3 | 2016-11-28 13:16:04 -0800 | [diff] [blame] | 241 | - Also allow text before a "yapf: (disable|enable)" comment. |
Bill Wendling | b50a6b2 | 2016-11-27 17:06:58 -0800 | [diff] [blame] | 242 | |
Bill Wendling | 544a281 | 2016-11-21 15:29:19 -0800 | [diff] [blame] | 243 | ## [0.14.0] 2016-11-21 |
Bill Wendling | 61061f6 | 2017-01-12 20:58:55 -0800 | [diff] [blame] | 244 | ### Added |
Diogo de Campos | 2f246c0 | 2016-10-06 14:04:38 +0200 | [diff] [blame] | 245 | - formatting can be run in parallel using the "-p" / "--parallel" flags. |
Bill Wendling | 6041f22 | 2016-11-02 01:07:39 -0700 | [diff] [blame] | 246 | ### Fixed |
| 247 | - "not in" and "is not" should be subtyped as binary operators. |
Bill Wendling | ccea10e | 2016-11-08 16:26:21 -0800 | [diff] [blame] | 248 | - A non-Node dictionary value may have a comment before it. In those cases, we |
| 249 | want to avoid encompassing only the comment in pseudo parens. So we include |
| 250 | the actual value as well. |
Bill Wendling | f728653 | 2016-11-16 17:52:50 -0800 | [diff] [blame] | 251 | - Adjust calculation so that pseudo-parentheses don't count towards the total |
| 252 | line length. |
Bill Wendling | 508694b | 2016-11-20 23:52:52 -0800 | [diff] [blame] | 253 | - Don't count a dictionary entry as not fitting on a single line in a |
| 254 | dictionary. |
Bill Wendling | 47c3e4f | 2016-11-21 15:25:09 -0800 | [diff] [blame] | 255 | - Don't count pseudo-parentheses in the length of the line. |
Bill Wendling | 6041f22 | 2016-11-02 01:07:39 -0700 | [diff] [blame] | 256 | |
Bill Wendling | 35d6b7c | 2016-10-22 01:18:51 -0700 | [diff] [blame] | 257 | ## [0.13.2] 2016-10-22 |
| 258 | ### Fixed |
| 259 | - REGRESSION: A comment may have a prefix with newlines in it. When calculating |
| 260 | the prefix indent, we cannot take the newlines into account. Otherwise, the |
| 261 | comment will be misplaced causing the code to fail. |
| 262 | |
Bill Wendling | f3e0965 | 2016-10-17 14:26:41 -0700 | [diff] [blame] | 263 | ## [0.13.1] 2016-10-17 |
| 264 | ### Fixed |
| 265 | - Correct emitting a diff that was accidentally removed. |
| 266 | |
Bill Wendling | 31f8213 | 2016-10-16 22:54:01 -0700 | [diff] [blame] | 267 | ## [0.13.0] 2016-10-16 |
Bill Wendling | cec6b19 | 2016-10-16 00:30:02 -0500 | [diff] [blame] | 268 | ### Added |
| 269 | - Added support to retain the original line endings of the source code. |
| 270 | |
Bill Wendling | a5a52e2 | 2016-10-11 13:40:38 -0700 | [diff] [blame] | 271 | ### Fixed |
| 272 | - Functions or classes with comments before them were reformatting the comments |
| 273 | even if the code was supposed to be ignored by the formatter. We now don't |
| 274 | adjust the whitespace before a function's comment if the comment is a |
| 275 | "disabled" line. We also don't count "# yapf: {disable|enable}" as a disabled |
| 276 | line, which seems logical. |
Bill Wendling | e6c9357 | 2016-10-11 20:26:23 -0700 | [diff] [blame] | 277 | - It's not really more readable to split before a dictionary value if it's part |
| 278 | of a dictionary comprehension. |
Bill Wendling | 556f915 | 2016-10-13 01:27:38 -0700 | [diff] [blame] | 279 | - Enforce two blank lines after a function or class definition, even before a |
Bill Wendling | 7cc4d18 | 2016-10-13 11:26:26 -0700 | [diff] [blame] | 280 | comment. (But not between a decorator and a comment.) This is related to PEP8 |
| 281 | error E305. |
Bill Wendling | 0d372eb | 2016-10-14 00:36:21 -0700 | [diff] [blame] | 282 | - Remove O(n^2) algorithm from the line disabling logic. |
Bill Wendling | a5a52e2 | 2016-10-11 13:40:38 -0700 | [diff] [blame] | 283 | |
Bill Wendling | c2620f9 | 2016-10-09 20:40:15 -0700 | [diff] [blame] | 284 | ## [0.12.2] 2016-10-09 |
Bill Wendling | 293cb6c | 2016-10-02 16:46:11 -0700 | [diff] [blame] | 285 | ### Fixed |
| 286 | - If `style.SetGlobalStyle(<create pre-defined style>)` was called and then |
| 287 | `yapf_api.FormatCode` was called, the style set by the first call would be |
| 288 | lost, because it would return the style created by `DEFAULT_STYLE_FACTORY`, |
| 289 | which is set to PEP8 by default. Fix this by making the first call set which |
| 290 | factory we call as the "default" style. |
Bill Wendling | 85b5a63 | 2016-10-03 20:30:43 -0700 | [diff] [blame] | 291 | - Don't force a split before non-function call arguments. |
Bill Wendling | 261c79a | 2016-10-03 20:58:08 -0700 | [diff] [blame] | 292 | - A dictionary being used as an argument to a function call and which can exist |
| 293 | on a single line shouldn't be split. |
Bill Wendling | 35edcbd | 2016-10-03 22:33:34 -0700 | [diff] [blame] | 294 | - Don't rely upon the original line break to determine if we should split |
Bill Wendling | c18abac | 2016-10-03 22:49:52 -0700 | [diff] [blame] | 295 | before the elements in a container. Especially split if there's a comment in |
| 296 | the container. |
Bill Wendling | 690132a | 2016-10-04 22:55:47 -0700 | [diff] [blame] | 297 | - Don't add spaces between star and args in a lambda expression. |
Bill Wendling | eef8fbd | 2016-10-05 00:34:25 -0700 | [diff] [blame] | 298 | - If a nested data structure terminates in a comma, then split before the first |
| 299 | element, but only if there's more than one element in the list. |
Bill Wendling | 293cb6c | 2016-10-02 16:46:11 -0700 | [diff] [blame] | 300 | |
| 301 | ## [0.12.1] 2016-10-02 |
Bill Wendling | 1960ffc | 2016-10-01 23:57:05 -0700 | [diff] [blame] | 302 | ### Changed |
| 303 | - Dictionary values will be placed on the same line as the key if *all* of the |
| 304 | elements in the dictionary can be placed on one line. Otherwise, the |
| 305 | dictionary values will be placed on the next line. |
| 306 | |
Bill Wendling | e041244 | 2016-09-28 02:19:31 -0700 | [diff] [blame] | 307 | ### Fixed |
| 308 | - Prefer to split before a terminating r-paren in an argument list if the line |
| 309 | would otherwise go over the column limit. |
Bill Wendling | 21836ef | 2016-09-28 19:13:16 -0700 | [diff] [blame] | 310 | - Split before the first key in a dictionary if the dictionary cannot fit on a |
| 311 | single line. |
Bill Wendling | 6199707 | 2016-09-30 00:45:59 -0700 | [diff] [blame] | 312 | - Don't count "pylint" comments when determining if the line goes over the |
| 313 | column limit. |
Bill Wendling | 0e70357 | 2016-10-01 23:02:32 -0700 | [diff] [blame] | 314 | - Don't count the argument list of a lambda as a named assign in a function |
| 315 | call. |
Bill Wendling | e041244 | 2016-09-28 02:19:31 -0700 | [diff] [blame] | 316 | |
Bill Wendling | 1b91963 | 2016-09-25 16:03:04 -0700 | [diff] [blame] | 317 | ## [0.12.0] 2016-09-25 |
Bill Wendling | 90eab55 | 2016-08-19 23:47:23 -0700 | [diff] [blame] | 318 | ### Added |
| 319 | - Support formatting of typed names. Typed names are formatted a similar way to |
| 320 | how named arguments are formatted, except that there's a space after the |
| 321 | colon. |
Alexander Lenz | 5fda36a | 2016-08-26 17:27:57 +0200 | [diff] [blame] | 322 | - Add a knob, 'SPACES_AROUND_DEFAULT_OR_NAMED_ASSIGN', to allow adding spaces |
| 323 | around the assign operator on default or named assigns. |
Bill Wendling | 90eab55 | 2016-08-19 23:47:23 -0700 | [diff] [blame] | 324 | |
Bill Wendling | 7c7f603 | 2016-08-31 10:46:33 -0700 | [diff] [blame] | 325 | ## Changed |
| 326 | - Turn "verification" off by default for external APIs. |
Bill Wendling | f0dd0a4 | 2016-09-25 15:54:02 -0700 | [diff] [blame] | 327 | - If a function call in an argument list won't fit on the current line but will |
| 328 | fit on a line by itself, then split before the call so that it won't be split |
| 329 | up unnecessarily. |
Bill Wendling | 7c7f603 | 2016-08-31 10:46:33 -0700 | [diff] [blame] | 330 | |
Bill Wendling | a6fb6f7 | 2016-09-17 14:39:26 -0700 | [diff] [blame] | 331 | ## Fixed |
| 332 | - Don't add space after power operator if the next operator's a unary operator. |
| 333 | |
Bill Wendling | 79ee44a | 2016-08-17 00:33:02 -0700 | [diff] [blame] | 334 | ## [0.11.1] 2016-08-17 |
Bill Wendling | 7b87b0a | 2016-08-17 00:01:56 -0700 | [diff] [blame] | 335 | ### Changed |
| 336 | - Issue #228: Return exit code 0 on success, regardless of whether files were |
| 337 | changed. (Previously, 0 meant success with no files |
| 338 | modified, and 2 meant success with at least one file modified.) |
| 339 | |
Bill Wendling | f4de4c6 | 2016-07-21 00:08:29 -0700 | [diff] [blame] | 340 | ### Fixed |
| 341 | - Enforce splitting each element in a dictionary if comma terminated. |
Bill Wendling | b8d20bd | 2016-08-05 23:44:23 -0700 | [diff] [blame] | 342 | - It's okay to split in the middle of a dotted name if the whole expression is |
| 343 | going to go over the column limit. |
Bill Wendling | 15edda2 | 2016-08-15 17:04:26 -0700 | [diff] [blame] | 344 | - Asynchronous functions were going missing if they were preceded by a comment |
| 345 | (a what? exactly). The asynchronous function processing wasn't taking the |
| 346 | comment into account and thus skipping the whole function. |
Bill Wendling | 7b87b0a | 2016-08-17 00:01:56 -0700 | [diff] [blame] | 347 | - The splitting of arguments when comma terminated had a conflict. The split |
| 348 | penalty of the closing bracket was set to the maximum, but it shouldn't be if |
| 349 | the closing bracket is preceded by a comma. |
Reece Hart | 039c0b5 | 2016-08-11 13:46:15 -0700 | [diff] [blame] | 350 | |
Bill Wendling | 1d8638e | 2016-07-17 00:06:01 -0700 | [diff] [blame] | 351 | ## [0.11.0] 2016-07-17 |
Ben Plotnick | 7e08829 | 2016-06-09 18:29:56 -0700 | [diff] [blame] | 352 | ### Added |
| 353 | - The COALESCE_BRACKETS knob prevents splitting consecutive brackets when |
| 354 | DEDENT_CLOSING_BRACKETS is set. |
Bill Wendling | 61e80c0 | 2016-07-14 16:50:10 -0700 | [diff] [blame] | 355 | - Don't count "pylint" directives as exceeding the column limit. |
Ben Plotnick | 7e08829 | 2016-06-09 18:29:56 -0700 | [diff] [blame] | 356 | |
Bill Wendling | 3363671 | 2016-07-16 02:49:28 -0700 | [diff] [blame] | 357 | ### Changed |
| 358 | - We split all of the arguments to a function call if there's a named argument. |
Bill Wendling | 2df2928 | 2016-07-16 17:23:41 -0700 | [diff] [blame] | 359 | In this case, we want to split after the opening bracket too. This makes |
Bill Wendling | 3363671 | 2016-07-16 02:49:28 -0700 | [diff] [blame] | 360 | things look a bit better. |
| 361 | |
Bill Wendling | 4761b18 | 2016-07-03 00:11:14 -0700 | [diff] [blame] | 362 | ### Fixed |
| 363 | - When retaining format of a multiline string with Chromium style, make sure |
| 364 | that the multiline string doesn't mess up where the following comma ends up. |
Bill Wendling | 821a36f | 2016-07-13 23:02:16 -0700 | [diff] [blame] | 365 | - Correct for when 'lib2to3' smooshes comments together into the same DEDENT |
| 366 | node. |
Bill Wendling | 4761b18 | 2016-07-03 00:11:14 -0700 | [diff] [blame] | 367 | |
Bill Wendling | 7521d4b | 2016-06-14 01:35:38 -0700 | [diff] [blame] | 368 | ## [0.10.0] 2016-06-14 |
Dracony | e582d63 | 2016-06-05 11:48:26 +0200 | [diff] [blame] | 369 | ### Added |
| 370 | - Add a knob, 'USE_TABS', to allow using tabs for indentation. |
Bill Wendling | 184c2de | 2016-06-13 03:21:04 -0700 | [diff] [blame] | 371 | |
Bill Wendling | b0285ba | 2016-05-31 16:10:59 -0700 | [diff] [blame] | 372 | ### Changed |
| 373 | - Performance enhancements. |
| 374 | |
Dracony | e582d63 | 2016-06-05 11:48:26 +0200 | [diff] [blame] | 375 | ### Fixed |
Bill Wendling | d02b592 | 2016-06-03 23:48:19 -0700 | [diff] [blame] | 376 | - Don't split an import list if it's not surrounded by parentheses. |
| 377 | |
Bill Wendling | 90f361f | 2016-05-29 16:13:10 -0700 | [diff] [blame] | 378 | ## [0.9.0] 2016-05-29 |
Bill Wendling | a6988c3 | 2016-05-22 18:47:11 -0700 | [diff] [blame] | 379 | ### Added |
Bill Wendling | 1e16159 | 2016-05-23 16:34:03 -0700 | [diff] [blame] | 380 | - Added a knob (SPLIT_PENALTY_BEFORE_IF_EXPR) to adjust the split penalty |
| 381 | before an if expression. This allows the user to place a list comprehension |
| 382 | all on one line. |
| 383 | - Added a knob (SPLIT_BEFORE_FIRST_ARGUMENT) that encourages splitting before |
| 384 | the first element of a list of arguments or parameters if they are going to |
| 385 | be split anyway. |
Bill Wendling | 86e5178 | 2016-05-24 00:47:44 -0700 | [diff] [blame] | 386 | - Added a knob (SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED) splits arguments to a |
| 387 | function if the list is terminated by a comma. |
Bill Wendling | a6988c3 | 2016-05-22 18:47:11 -0700 | [diff] [blame] | 388 | |
Bill Wendling | 7edb384 | 2016-05-21 15:07:54 -0700 | [diff] [blame] | 389 | ### Fixed |
| 390 | - Don't split before a first element list argument as we would before a first |
| 391 | element function call. |
Bill Wendling | e8a8569 | 2016-05-21 23:57:20 -0700 | [diff] [blame] | 392 | - Don't penalize when we must split a line. |
Bill Wendling | 283f4ea | 2016-05-23 16:19:15 -0700 | [diff] [blame] | 393 | - Allow splitting before the single argument in a function call. |
Bill Wendling | 7edb384 | 2016-05-21 15:07:54 -0700 | [diff] [blame] | 394 | |
Bill Wendling | d2a585d | 2016-05-21 00:41:24 -0700 | [diff] [blame] | 395 | ## [0.8.2] 2016-05-21 |
Bill Wendling | 72cd234 | 2016-05-19 01:28:58 -0700 | [diff] [blame] | 396 | ### Fixed |
| 397 | - Prefer not to split after the opening of a subscript. |
Bill Wendling | 1e179bb | 2016-05-19 01:51:34 -0700 | [diff] [blame] | 398 | - Don't add space before the 'await' keyword if it's preceded by an opening |
| 399 | paren. |
Bill Wendling | 4b6cead | 2016-05-19 11:33:38 -0700 | [diff] [blame] | 400 | - When we're setting the split penalty for a continuous list, we don't want to |
| 401 | mistake a comment at the end of that list as part of the list. |
Bill Wendling | da6ab27 | 2016-05-19 21:45:34 -0700 | [diff] [blame] | 402 | - When calculating blank lines, don't assume the last seen object was a class |
| 403 | or function when we're in a class or function. |
Bill Wendling | f61861d | 2016-05-21 00:36:27 -0700 | [diff] [blame] | 404 | - Don't count the closing scope when determining if the current scope is the |
| 405 | last scope on the line. |
Bill Wendling | 72cd234 | 2016-05-19 01:28:58 -0700 | [diff] [blame] | 406 | |
Bill Wendling | de2c5b2 | 2016-05-18 21:10:29 -0700 | [diff] [blame] | 407 | ## [0.8.1] 2016-05-18 |
Bill Wendling | 8f1d140 | 2016-05-14 19:22:48 -0700 | [diff] [blame] | 408 | ### Fixed |
| 409 | - 'SPLIT_BEFORE_LOGICAL_OPERATOR' wasn't working correctly. The penalty was |
| 410 | being set incorrectly when it was part of a larger construct. |
Bill Wendling | 99cbd56 | 2016-05-15 18:41:12 -0700 | [diff] [blame] | 411 | - Don't separate a keyword, like "await", from a left paren. |
Bill Wendling | 311c087 | 2016-05-18 01:51:12 -0700 | [diff] [blame] | 412 | - Don't rely upon the original tokens' line number to determine if we should |
| 413 | perform splitting in Facebook mode. The line number isn't the line number of |
| 414 | the reformatted token, but the line number where it was in the original code. |
| 415 | Instead, we need to carefully determine if the line is liabel to be split and |
| 416 | act accordingly. |
Bill Wendling | 8f1d140 | 2016-05-14 19:22:48 -0700 | [diff] [blame] | 417 | |
Bill Wendling | fe7a4ac | 2016-05-10 23:51:57 -0700 | [diff] [blame] | 418 | ## [0.8.0] 2016-05-10 |
Bill Wendling | 9dc7908 | 2016-05-10 00:23:53 -0700 | [diff] [blame] | 419 | ### Added |
Bill Wendling | 43eaa75 | 2016-05-12 01:25:20 -0700 | [diff] [blame] | 420 | - Add a knob, 'SPACES_AROUND_POWER_OPERATOR', to allow adding spaces around the |
| 421 | power operator. |
Bill Wendling | 9dc7908 | 2016-05-10 00:23:53 -0700 | [diff] [blame] | 422 | |
Bill Wendling | f015a3c | 2016-04-21 20:14:24 -0700 | [diff] [blame] | 423 | ### Fixed |
| 424 | - There shouldn't be a space between a decorator and an intervening comment. |
Bill Wendling | 3e15d00 | 2016-04-28 00:16:32 -0700 | [diff] [blame] | 425 | - If we split before a bitwise operator, then we assume that the programmer |
| 426 | knows what they're doing, more or less, and so we enforce a split before said |
| 427 | operator if one exists in the original program. |
Bill Wendling | adf1d44 | 2016-05-10 01:03:50 -0700 | [diff] [blame] | 428 | - Strengthen the bond between a keyword and value argument. |
Bill Wendling | 93c42d9 | 2016-05-10 23:35:57 -0700 | [diff] [blame] | 429 | - Don't add a blank line after a multiline string. |
Bill Wendling | cae1edd | 2016-05-10 23:49:19 -0700 | [diff] [blame] | 430 | - If the "for" part of a list comprehension can exist on the starting line |
| 431 | without going over the column limit, then let it remain there. |
Bill Wendling | f015a3c | 2016-04-21 20:14:24 -0700 | [diff] [blame] | 432 | |
Bill Wendling | 8d36eb8 | 2016-04-21 02:33:36 -0700 | [diff] [blame] | 433 | ## [0.7.1] 2016-04-21 |
Bill Wendling | 4dc472d | 2016-04-10 03:03:55 -0700 | [diff] [blame] | 434 | ### Fixed |
| 435 | - Don't rewrite the file if there are no changes. |
Bill Wendling | ac00a25 | 2016-04-12 05:31:03 -0700 | [diff] [blame] | 436 | - Ensure the proper number of blank lines before an async function. |
Bill Wendling | c4a4965 | 2016-04-13 13:42:43 -0700 | [diff] [blame] | 437 | - Split after a bitwise operator when in PEP 8 mode. |
Bill Wendling | 423759f | 2016-04-14 21:14:20 -0700 | [diff] [blame] | 438 | - Retain the splitting within a dictionary data literal between the key and |
| 439 | value. |
Bill Wendling | 9882f3d | 2016-04-21 02:29:35 -0700 | [diff] [blame] | 440 | - Try to keep short function calls all on one line even if they're part of a |
| 441 | larger series of tokens. This stops us from splitting too much. |
Bill Wendling | 4dc472d | 2016-04-10 03:03:55 -0700 | [diff] [blame] | 442 | |
Bill Wendling | defe5f3 | 2016-04-09 22:29:51 -0700 | [diff] [blame] | 443 | ## [0.7.0] 2016-04-09 |
Bill Wendling | 2e58851 | 2016-03-13 01:02:47 -0800 | [diff] [blame] | 444 | ### Added |
Bill Wendling | 5758e4d | 2016-03-19 03:38:48 -0700 | [diff] [blame] | 445 | - Support for Python 3.5. |
| 446 | - Add 'ALLOW_MULTILINE_LAMBDAS' which allows lambdas to be formatted onto |
| 447 | multiple lines. |
Bill Wendling | 2e58851 | 2016-03-13 01:02:47 -0800 | [diff] [blame] | 448 | |
| 449 | ### Fixed |
| 450 | - Lessen penalty for splitting before a dictionary keyword. |
Bill Wendling | 90a2aa5 | 2016-03-20 02:25:13 -0700 | [diff] [blame] | 451 | - Formatting of trailing comments on disabled formatting lines. |
Bill Wendling | 2064d88 | 2016-04-09 22:21:15 -0700 | [diff] [blame] | 452 | - Disable / enable formatting at end of multi-line comment. |
Bill Wendling | 2e58851 | 2016-03-13 01:02:47 -0800 | [diff] [blame] | 453 | |
Bill Wendling | 0bca2aa | 2016-03-06 20:44:14 -0800 | [diff] [blame] | 454 | ## [0.6.3] 2016-03-06 |
| 455 | ### Changed |
| 456 | - Documentation updated. |
| 457 | |
Bill Wendling | 95e47b9 | 2015-11-04 22:58:30 -0800 | [diff] [blame] | 458 | ### Fixed |
| 459 | - Fix spacing of multiline comments when formatting is disabled. |
| 460 | |
Bill Wendling | 9ffd815 | 2015-11-01 17:49:25 -0800 | [diff] [blame] | 461 | ## [0.6.2] 2015-11-01 |
Bill Wendling | 6e8ca7b | 2015-10-25 01:16:43 -0700 | [diff] [blame] | 462 | ### Changed |
| 463 | - Look at the 'setup.cfg' file to see if it contains style information for |
| 464 | YAPF. |
Bill Wendling | 169790e | 2015-10-25 03:13:13 -0700 | [diff] [blame] | 465 | - Look at the '~/.config/yapf/style' file to see if it contains global style |
| 466 | information for YAPF. |
Bill Wendling | 6e8ca7b | 2015-10-25 01:16:43 -0700 | [diff] [blame] | 467 | |
Bill Wendling | 57ffbbb | 2015-10-25 00:20:14 -0700 | [diff] [blame] | 468 | ### Fixed |
| 469 | - Make lists that can fit on one line more likely to stay together. |
Bill Wendling | 5091fa6 | 2015-10-28 01:51:53 -0700 | [diff] [blame] | 470 | - Correct formatting of '*args' and '**kwargs' when there are default values in |
| 471 | the argument list. |
Bill Wendling | 57ffbbb | 2015-10-25 00:20:14 -0700 | [diff] [blame] | 472 | |
Bill Wendling | 348b2f3 | 2015-10-24 03:20:10 -0700 | [diff] [blame] | 473 | ## [0.6.1] 2015-10-24 |
Bill Wendling | 3a3cb6d | 2015-10-20 13:40:27 -0700 | [diff] [blame] | 474 | ### Fixed |
| 475 | - Make sure to align comments in data literals correctly. Also make sure we |
| 476 | don't count a "#." in a string as an i18n comment. |
Bill Wendling | a6b57a6 | 2015-10-20 13:57:52 -0700 | [diff] [blame] | 477 | - Retain proper vertical spacing before comments in a data literal. |
Bill Wendling | 843e48c | 2015-10-20 16:53:08 -0700 | [diff] [blame] | 478 | - Make sure that continuations from a compound statement are distinguished from |
| 479 | the succeeding line. |
Bill Wendling | 81e37b6 | 2015-10-21 13:18:29 -0700 | [diff] [blame] | 480 | - Ignore preceding comments when calculating what is a "dictonary maker". |
Bill Wendling | a558572 | 2015-10-21 15:32:22 -0700 | [diff] [blame] | 481 | - Add a small penalty for splitting before a closing bracket. |
Bill Wendling | dbcf342 | 2015-10-21 22:11:15 -0700 | [diff] [blame] | 482 | - Ensure that a space is enforced after we remove a pseudo-paren that's between |
| 483 | two names, keywords, numbers, etc. |
Bill Wendling | f885672 | 2015-10-21 23:53:29 -0700 | [diff] [blame] | 484 | - Increase the penalty for splitting after a pseudo-paren. This could lead to |
| 485 | less readable code in some circumstances. |
Bill Wendling | 3a3cb6d | 2015-10-20 13:40:27 -0700 | [diff] [blame] | 486 | |
Bill Wendling | 7ef492b | 2015-10-18 14:43:06 -0700 | [diff] [blame] | 487 | ## [0.6.0] 2015-10-18 |
Bill Wendling | a5cef8e | 2015-10-15 21:42:03 -0700 | [diff] [blame] | 488 | ### Added |
| 489 | - Add knob to indent the dictionary value if there is a split before it. |
| 490 | |
Bill Wendling | cec6696 | 2015-10-17 04:08:23 -0700 | [diff] [blame] | 491 | ### Changed |
| 492 | - No longer check that a file is a "Python" file unless the '--recursive' flag |
| 493 | is specified. |
| 494 | - No longer allow the user to specify a directory unless the '--recursive' flag |
| 495 | is specified. |
| 496 | |
Bill Wendling | c87690c | 2015-10-11 16:45:21 -0700 | [diff] [blame] | 497 | ### Fixed |
| 498 | - When determining if we should split a dictionary's value to a new line, use |
| 499 | the longest entry instead of the total dictionary's length. This allows the |
| 500 | formatter to reformat the dictionary in a more consistent manner. |
Bill Wendling | 0946c0f | 2015-10-12 00:42:30 -0700 | [diff] [blame] | 501 | - Improve how list comprehensions are formatted. Make splitting dependent upon |
| 502 | whether the "comp_for" or "comp_if" goes over the column limit. |
Bill Wendling | 43bdc7b | 2015-10-12 14:25:30 -0700 | [diff] [blame] | 503 | - Don't over indent if expression hanging indents if we expect to dedent the |
| 504 | closing bracket. |
Bill Wendling | c1052c6 | 2015-10-15 03:12:28 -0700 | [diff] [blame] | 505 | - Improve splitting heuristic when the first argument to a function call is |
| 506 | itself a function call with arguments. In cases like this, the remaining |
| 507 | arguments to the function call would look badly aligned, even though they are |
| 508 | techincally correct (the best kind of correct!). |
Bill Wendling | b1037b5 | 2015-10-15 22:38:19 -0700 | [diff] [blame] | 509 | - Improve splitting heuristic more so that if the first argument to a function |
| 510 | call is a data literal that will go over the column limit, then we want to |
| 511 | split before it. |
Bill Wendling | 8d8f512 | 2015-10-16 11:46:23 -0700 | [diff] [blame] | 512 | - Remove spaces around '**' operator. |
Bill Wendling | f8325e6 | 2015-10-16 15:38:54 -0700 | [diff] [blame] | 513 | - Retain formatting of comments in the middle of an expression. |
Bill Wendling | 454cef6 | 2015-10-18 03:49:03 -0700 | [diff] [blame] | 514 | - Don't add a newline to an empty file. |
Bill Wendling | 7ef492b | 2015-10-18 14:43:06 -0700 | [diff] [blame] | 515 | - Over indent a function's parameter list if it's not distinguished from the |
| 516 | body of the function. |
Bill Wendling | c87690c | 2015-10-11 16:45:21 -0700 | [diff] [blame] | 517 | |
Bill Wendling | 2aff7fc | 2015-10-11 14:08:10 -0700 | [diff] [blame] | 518 | ## [0.5.0] 2015-10-11 |
Bill Wendling | d03c99f | 2015-10-08 21:06:07 -0700 | [diff] [blame] | 519 | ### Added |
| 520 | - Add option to exclude files/directories from formatting. |
Bill Wendling | 5c60873 | 2015-10-10 23:39:16 -0700 | [diff] [blame] | 521 | - Add a knob to control whether import names are split after the first '('. |
Bill Wendling | d03c99f | 2015-10-08 21:06:07 -0700 | [diff] [blame] | 522 | |
Bill Wendling | a7e3f50 | 2015-10-08 00:23:40 -0700 | [diff] [blame] | 523 | ### Fixed |
| 524 | - Indent the continuation of an if-then statement when it's not distinguished |
| 525 | from the body of the if-then. |
Bill Wendling | 1ce18c7 | 2015-10-10 23:12:16 -0700 | [diff] [blame] | 526 | - Allow for sensible splitting of array indices where appropriate. |
Bill Wendling | be974d8 | 2015-10-11 01:04:00 -0700 | [diff] [blame] | 527 | - Prefer to not split before the ending bracket of an atom. This produces |
| 528 | better code in most cases. |
Bill Wendling | bbd148c | 2015-10-11 01:45:24 -0700 | [diff] [blame] | 529 | - Corrected how horizontal spaces were presevered in a disabled region. |
Bill Wendling | a7e3f50 | 2015-10-08 00:23:40 -0700 | [diff] [blame] | 530 | |
Bill Wendling | 967c3b2 | 2015-10-07 22:20:18 -0700 | [diff] [blame] | 531 | ## [0.4.0] 2015-10-07 |
Ćukasz Langa | 9408987 | 2015-09-22 16:02:26 -0700 | [diff] [blame] | 532 | ### Added |
| 533 | - Support for dedenting closing brackets, "facebook" style. |
| 534 | |
Bill Wendling | 25c8e60 | 2015-10-04 20:48:35 -0700 | [diff] [blame] | 535 | ### Fixed |
| 536 | - Formatting of tokens after a multiline string didn't retain their horizontal |
| 537 | spacing. |
| 538 | |
Bill Wendling | 06865ab | 2015-09-30 01:25:47 -0700 | [diff] [blame] | 539 | ## [0.3.1] 2015-09-30 |
| 540 | ### Fixed |
| 541 | - Format closing scope bracket correctly when indentation size changes. |
| 542 | |
Bill Wendling | a690a62 | 2015-09-20 12:38:50 -0700 | [diff] [blame] | 543 | ## [0.3.0] 2015-09-20 |
| 544 | ### Added |
| 545 | - Return a 2 if the source changed, 1 on error, and 0 for no change. |
| 546 | |
| 547 | ### Fixed |
| 548 | - Make sure we format if the "lines" specified are in the middle of a |
| 549 | statement. |
| 550 | |
Bill Wendling | 9adfa0c | 2015-09-13 05:37:30 -0700 | [diff] [blame] | 551 | ## [0.2.9] - 2015-09-13 |
| 552 | ### Fixed |
| 553 | - Formatting of multiple files. It was halting after formatting the first file. |
| 554 | |
Bill Wendling | dcafd5f | 2015-09-12 15:26:03 -0700 | [diff] [blame] | 555 | ## [0.2.8] - 2015-09-12 |
| 556 | ### Added |
| 557 | - Return a non-zero exit code if the source was changed. |
| 558 | - Add bitwise operator splitting penalty and prefer to split before bitwise |
| 559 | operators. |
| 560 | |
| 561 | ### Fixed |
| 562 | - Retain vertical spacing between disabled and enabled lines. |
| 563 | - Split only at start of named assign. |
| 564 | - Retain comment position when formatting is disabled. |
| 565 | - Honor splitting before or after logical ops. |