|
| 1 | +# https://github.com/google/yapf |
| 2 | +# current version used in this repo |
| 3 | +# yapf==0.20.0 |
| 4 | + |
| 5 | + |
| 6 | +[style] |
| 7 | +# Align closing bracket with visual indentation. |
| 8 | +ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT=True |
| 9 | + |
| 10 | +# Allow lambdas to be formatted on more than one line. |
| 11 | +ALLOW_MULTILINE_LAMBDAS=False |
| 12 | + |
| 13 | +# Allow dictionary keys to exist on multiple lines. For example: |
| 14 | +# |
| 15 | +# x = { |
| 16 | +# ('this is the first element of a tuple', |
| 17 | +# 'this is the second element of a tuple'): |
| 18 | +# value, |
| 19 | +# } |
| 20 | +ALLOW_MULTILINE_DICTIONARY_KEYS=False |
| 21 | + |
| 22 | +# Insert a blank line before a 'def' or 'class' immediately nested |
| 23 | +# within another 'def' or 'class'. For example: |
| 24 | +# |
| 25 | +# class Foo: |
| 26 | +# # <------ this blank line |
| 27 | +# def method(): |
| 28 | +# ... |
| 29 | +BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF=True |
| 30 | + |
| 31 | +# Insert a blank line before a class-level docstring. |
| 32 | +BLANK_LINE_BEFORE_CLASS_DOCSTRING=True |
| 33 | + |
| 34 | +# Do not split consecutive brackets. Only relevant when |
| 35 | +# dedent_closing_brackets is set. For example: |
| 36 | +# |
| 37 | +# call_func_that_takes_a_dict( |
| 38 | +# { |
| 39 | +# 'key1': 'value1', |
| 40 | +# 'key2': 'value2', |
| 41 | +# } |
| 42 | +# ) |
| 43 | +# |
| 44 | +# would reformat to: |
| 45 | +# |
| 46 | +# call_func_that_takes_a_dict({ |
| 47 | +# 'key1': 'value1', |
| 48 | +# 'key2': 'value2', |
| 49 | +# }) |
| 50 | +COALESCE_BRACKETS=True |
| 51 | + |
| 52 | +# The column limit. |
| 53 | +COLUMN_LIMIT=80 |
| 54 | + |
| 55 | +# Indent width used for line continuations. |
| 56 | +CONTINUATION_INDENT_WIDTH=4 |
| 57 | + |
| 58 | +# Put closing brackets on a separate line, dedented, if the bracketed |
| 59 | +# expression can't fit in a single line. Applies to all kinds of |
| 60 | +# brackets, including function definitions and calls. For example: |
| 61 | +# |
| 62 | +# config = { |
| 63 | +# 'key1': 'value1', |
| 64 | +# 'key2': 'value2', |
| 65 | +# } # <--- this bracket is dedented and on a separate line |
| 66 | +# |
| 67 | +# time_series = self.remote_client.query_entity_counters( |
| 68 | +# entity='dev3246.region1', |
| 69 | +# key='dns.query_latency_tcp', |
| 70 | +# transform=Transformation.AVERAGE(window=timedelta(seconds=60)), |
| 71 | +# start_ts=now()-timedelta(days=3), |
| 72 | +# end_ts=now(), |
| 73 | +# ) # <--- this bracket is dedented and on a separate line |
| 74 | +DEDENT_CLOSING_BRACKETS=False |
| 75 | + |
| 76 | +# Place each dictionary entry onto its own line. |
| 77 | +EACH_DICT_ENTRY_ON_SEPARATE_LINE=False |
| 78 | + |
| 79 | +# The regex for an i18n comment. The presence of this comment stops |
| 80 | +# reformatting of that line, because the comments are required to be |
| 81 | +# next to the string they translate. |
| 82 | +I18N_COMMENT= |
| 83 | + |
| 84 | +# The i18n function call names. The presence of this function stops |
| 85 | +# reformattting on that line, because the string it has cannot be moved |
| 86 | +# away from the i18n comment. |
| 87 | +I18N_FUNCTION_CALL=["_", "ugettext", "gettext"] |
| 88 | + |
| 89 | +# Indent the dictionary value if it cannot fit on the same line as the |
| 90 | +# dictionary key. For example: |
| 91 | +# |
| 92 | +# config = { |
| 93 | +# 'key1': |
| 94 | +# 'value1', |
| 95 | +# 'key2': value1 + |
| 96 | +# value2, |
| 97 | +# } |
| 98 | +INDENT_DICTIONARY_VALUE=False |
| 99 | + |
| 100 | +# The number of columns to use for indentation. |
| 101 | +INDENT_WIDTH=4 |
| 102 | + |
| 103 | +# Join short lines into one line. E.g., single line 'if' statements. |
| 104 | +JOIN_MULTIPLE_LINES=True |
| 105 | + |
| 106 | +# Use spaces around the power operator. |
| 107 | +SPACES_AROUND_POWER_OPERATOR=True |
| 108 | + |
| 109 | +# Do not include spaces around selected binary operators. For example: |
| 110 | +# 1 + 2 * 3 - 4 / 5 |
| 111 | +# will be formatted as follows when configured with a value "*,/": |
| 112 | +# 1 + 2*3 - 4/5 |
| 113 | +NO_SPACES_AROUND_SELECTED_BINARY_OPERATORS=False |
| 114 | + |
| 115 | +# Set to True to prefer spaces around the assignment operator for |
| 116 | +# default or keyword arguments. |
| 117 | +SPACES_AROUND_DEFAULT_OR_NAMED_ASSIGN=False |
| 118 | + |
| 119 | +# The number of spaces required before a trailing comment. |
| 120 | +SPACES_BEFORE_COMMENT=2 |
| 121 | + |
| 122 | +# Insert a space between the ending comma and closing bracket of a list, |
| 123 | +# etc. |
| 124 | +SPACE_BETWEEN_ENDING_COMMA_AND_CLOSING_BRACKET=False |
| 125 | + |
| 126 | +# Split before arguments if the argument list is terminated by a |
| 127 | +# comma. |
| 128 | +SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED=True |
| 129 | + |
| 130 | +# Set to True to prefer splitting before '&', '|' or '^' rather than |
| 131 | +# after. |
| 132 | +SPLIT_BEFORE_BITWISE_OPERATOR=False |
| 133 | + |
| 134 | +# Split before a dictionary or set generator (comp_for). For example, |
| 135 | +# note the split before the for: |
| 136 | +# |
| 137 | +# foo = { |
| 138 | +# variable: 'Hello world, have a nice day!' |
| 139 | +# for variable in bar if variable != 42 |
| 140 | +# } |
| 141 | +SPLIT_BEFORE_DICT_SET_GENERATOR=True |
| 142 | + |
| 143 | +# Split after the opening paren which surrounds an expression if it doesn't fit on a single line. |
| 144 | +SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN=True |
| 145 | + |
| 146 | +# If an argument / parameter list is going to be split, then split |
| 147 | +# before the first argument. |
| 148 | +SPLIT_BEFORE_FIRST_ARGUMENT=True |
| 149 | + |
| 150 | +# Set to True to prefer splitting before 'and' or 'or' rather than |
| 151 | +# after. |
| 152 | +SPLIT_BEFORE_LOGICAL_OPERATOR=False |
| 153 | + |
| 154 | +# Split named assignments onto individual lines. |
| 155 | +SPLIT_BEFORE_NAMED_ASSIGNS=False |
| 156 | + |
| 157 | +# For list comprehensions and generator expressions with multiple clauses |
| 158 | +SPLIT_COMPLEX_COMPREHENSION=False |
| 159 | + |
| 160 | +# The penalty for splitting right after the opening bracket. |
| 161 | +SPLIT_PENALTY_AFTER_OPENING_BRACKET=2000 |
| 162 | + |
| 163 | +# The penalty for splitting the line after a unary operator. |
| 164 | +SPLIT_PENALTY_AFTER_UNARY_OPERATOR=10000 |
| 165 | + |
| 166 | +# The penalty for splitting right before an if expression. |
| 167 | +SPLIT_PENALTY_BEFORE_IF_EXPR=0 |
| 168 | + |
| 169 | +# The penalty of splitting the line around the '&', '|', and '^' |
| 170 | +# operators. |
| 171 | +SPLIT_PENALTY_BITWISE_OPERATOR=300 |
| 172 | + |
| 173 | +# The penalty for splitting a list comprehension or generator expression. |
| 174 | +SPLIT_PENALTY_COMPREHENSION=80 |
| 175 | + |
| 176 | +# The penalty for characters over the column limit. |
| 177 | +SPLIT_PENALTY_EXCESS_CHARACTER=2600 |
| 178 | + |
| 179 | +# The penalty incurred by adding a line split to the unwrapped |
| 180 | +# line. The more line splits added the higher the penalty. |
| 181 | +SPLIT_PENALTY_FOR_ADDED_LINE_SPLIT=30 |
| 182 | + |
| 183 | +# The penalty of splitting a list of "import as" names. For example: |
| 184 | +# |
| 185 | +# from a_very_long_or_indented_module_name_yada_yad import (long_argument_1, |
| 186 | +# long_argument_2, |
| 187 | +# long_argument_3) |
| 188 | +# |
| 189 | +# would reformat to something like: |
| 190 | +# |
| 191 | +# from a_very_long_or_indented_module_name_yada_yad import ( |
| 192 | +# long_argument_1, long_argument_2, long_argument_3) |
| 193 | +SPLIT_PENALTY_IMPORT_NAMES=0 |
| 194 | + |
| 195 | +# The penalty of splitting the line around the 'and' and 'or' |
| 196 | +# operators. |
| 197 | +SPLIT_PENALTY_LOGICAL_OPERATOR=300 |
| 198 | + |
| 199 | +# Use the Tab character for indentation. |
| 200 | +USE_TABS=False |
| 201 | + |
| 202 | +# Allow splits before the dictionary value. |
| 203 | +ALLOW_SPLIT_BEFORE_DICT_VALUE=False |
0 commit comments