{"author":"Google Inc.","author_email":null,"bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Console","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Quality Assurance"],"description":"# YAPF\n\n

\n $\"PyPI$ \n $\"Build$ \n $\"Actions$ \n $\"Coverage$ \n

\n\n\n## Introduction\n\nYAPF is a Python formatter based on [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html)\n(developed by Daniel Jasper). In essence, the algorithm takes the code and\ncalculates the best formatting that conforms to the configured style. It takes\naway a lot of the drudgery of maintaining your code.\n\nThe ultimate goal is that the code YAPF produces is as good as the code that a\nprogrammer would write if they were following the style guide.\n\n> **Note**\n> YAPF is not an official Google product (experimental or otherwise), it is\n> just code that happens to be owned by Google.\n\n\n## Installation\n\nTo install YAPF from PyPI:\n\n```bash\n$ pip install yapf\n```\n\nYAPF is still considered in \"beta\" stage, and the released version may change\noften; therefore, the best way to keep up-to-date with the latest development\nis to clone this repository or install directly from github:\n\n```bash\n$ pip install git+https://github.com/google/yapf.git\n```\n\nNote that if you intend to use YAPF as a command-line tool rather than as a\nlibrary, installation is not necessary. YAPF supports being run as a directory\nby the Python interpreter. If you cloned/unzipped YAPF into `DIR`, it's\npossible to run:\n\n```bash\n$ PYTHONPATH=DIR python DIR/yapf [options] ...\n```\n\n## Using YAPF within your favorite editor\nYAPF is supported by multiple editors via community extensions or plugins. See [Editor Support](EDITOR%20SUPPORT.md) for more info.\n\n## Required Python versions\n\nYAPF supports Python 3.7+.\n\n\n## Usage\n\n```console\nusage: yapf [-h] [-v] [-d | -i | -q] [-r | -l START-END] [-e PATTERN]\n [--style STYLE] [--style-help] [--no-local-style] [-p] [-m] [-vv]\n [files ...]\n\nFormatter for Python code.\n\npositional arguments:\n files reads from stdin when no files are specified.\n\noptional arguments:\n -h, --help show this help message and exit\n -v, --version show program's version number and exit\n -d, --diff print the diff for the fixed source\n -i, --in-place make changes to files in place\n -q, --quiet output nothing and set return value\n -r, --recursive run recursively over directories\n -l START-END, --lines START-END\n range of lines to reformat, one-based\n -e PATTERN, --exclude PATTERN\n patterns for files to exclude from formatting\n --style STYLE specify formatting style: either a style name (for\n example \"pep8\" or \"google\"), or the name of a file\n with style settings. The default is pep8 unless a\n .style.yapf or setup.cfg or pyproject.toml file\n located in the same directory as the source or one of\n its parent directories (for stdin, the current\n directory is used).\n --style-help show style settings and exit; this output can be saved\n to .style.yapf to make your settings permanent\n --no-local-style don't search for local style definition\n -p, --parallel run YAPF in parallel when formatting multiple files.\n -m, --print-modified print out file names of modified files\n -vv, --verbose print out file names while processing\n```\n\n\n### Return Codes\n\nNormally YAPF returns zero on successful program termination and non-zero\notherwise.\n\nIf `--diff` is supplied, YAPF returns zero when no changes were necessary,\nnon-zero otherwise (including program error). You can use this in a CI workflow\nto test that code has been YAPF-formatted.\n\n### Excluding files from formatting (.yapfignore or pyproject.toml)\n\nIn addition to exclude patterns provided on commandline, YAPF looks for\nadditional patterns specified in a file named `.yapfignore` or `pyproject.toml`\nlocated in the working directory from which YAPF is invoked.\n\n`.yapfignore`'s syntax is similar to UNIX's filename pattern matching:\n\n```\n* matches everything\n? matches any single character\n[seq] matches any character in seq\n[!seq] matches any character not in seq\n```\n\nNote that no entry should begin with `./`.\n\nIf you use `pyproject.toml`, exclude patterns are specified by `ignore_patterns` key\nin `[tool.yapfignore]` section. For example:\n\n```ini\n[tool.yapfignore]\nignore_patterns = [\n \"temp/**/*.py\",\n \"temp2/*.py\"\n]\n```\n\n\nFormatting style\n================\n\nThe formatting style used by YAPF is configurable and there are many \"knobs\"\nthat can be used to tune how YAPF does formatting. See the `style.py` module\nfor the full list.\n\nTo control the style, run YAPF with the `--style` argument. It accepts one of\nthe predefined styles (e.g., `pep8` or `google`), a path to a configuration\nfile that specifies the desired style, or a dictionary of key/value pairs.\n\nThe config file is a simple listing of (case-insensitive) `key = value` pairs\nwith a `[style]` heading. For example:\n\n```ini\n[style]\nbased_on_style = pep8\nspaces_before_comment = 4\nsplit_before_logical_operator = true\n```\n\nThe `based_on_style` setting determines which of the predefined styles this\ncustom style is based on (think of it like subclassing). Four\nstyles are predefined:\n\n- `pep8` (default)\n- `google` (based off of the [Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md))\n- `yapf` (for use with Google open source projects)\n- `facebook`\n\nSee `_STYLE_NAME_TO_FACTORY` in [`style.py`](https://github.com/google/yapf/blob/main/yapf/yapflib/style.py) for details.\n\nIt's also possible to do the same on the command line with a dictionary. For\nexample:\n\n```bash\n--style='{based_on_style: pep8, indent_width: 2}'\n```\n\nThis will take the `pep8` base style and modify it to have two space\nindentations.\n\nYAPF will search for the formatting style in the following manner:\n\n1. Specified on the command line\n2. In the `[style]` section of a `.style.yapf` file in either the current\n directory or one of its parent directories.\n3. In the `[yapf]` section of a `setup.cfg` file in either the current\n directory or one of its parent directories.\n4. In the `[tool.yapf]` section of a `pyproject.toml` file in either the current\n directory or one of its parent directories.\n5. In the `[style]` section of a `~/.config/yapf/style` file in your home\n directory.\n\nIf none of those files are found, the default style PEP8 is used.\n\n\nExample\n=======\n\nAn example of the type of formatting that YAPF can do, it will take this ugly\ncode:\n\n```python\nx = { 'a':37,'b':42,\n\n'c':927}\n\ny = 'hello ''world'\nz = 'hello '+'world'\na = 'hello {}'.format('world')\nclass foo ( object ):\n def f (self ):\n return 37*-+2\n def g(self, x,y=42):\n return y\ndef f ( a ) :\n return 37+-+a[42-x : y**3]\n```\n\nand reformat it into:\n\n```python\nx = {'a': 37, 'b': 42, 'c': 927}\n\ny = 'hello ' 'world'\nz = 'hello ' + 'world'\na = 'hello {}'.format('world')\n\n\nclass foo(object):\n def f(self):\n return 37 * -+2\n\n def g(self, x, y=42):\n return y\n\n\ndef f(a):\n return 37 + -+a[42 - x:y**3]\n```\n\n\n## Example as a module\n\nThe two main APIs for calling YAPF are `FormatCode` and `FormatFile`, these\nshare several arguments which are described below:\n\n```python\n>>> from yapf.yapflib.yapf_api import FormatCode # reformat a string of code\n\n>>> formatted_code, changed = FormatCode(\"f ( a = 1, b = 2 )\")\n>>> formatted_code\n'f(a=1, b=2)\\n'\n>>> changed\nTrue\n```\n\nA `style_config` argument: Either a style name or a path to a file that\ncontains formatting style settings. If None is specified, use the default style\nas set in `style.DEFAULT_STYLE_FACTORY`.\n\n```python\n>>> FormatCode(\"def g():\\n return True\", style_config='pep8')[0]\n'def g():\\n return True\\n'\n```\n\nA `lines` argument: A list of tuples of lines (ints), [start, end], that we\nwant to format. The lines are 1-based indexed. It can be used by third-party\ncode (e.g., IDEs) when reformatting a snippet of code rather than a whole file.\n\n```python\n>>> FormatCode(\"def g( ):\\n a=1\\n b = 2\\n return a==b\", lines=[(1, 1), (2, 3)])[0]\n'def g():\\n a = 1\\n b = 2\\n return a==b\\n'\n```\n\nA `print_diff` (bool): Instead of returning the reformatted source, return a\ndiff that turns the formatted source into reformatted source.\n\n```diff\n>>> print(FormatCode(\"a==b\", filename=\"foo.py\", print_diff=True)[0])\n--- foo.py (original)\n+++ foo.py (reformatted)\n@@ -1 +1 @@\n-a==b\n+a == b\n```\n\nNote: the `filename` argument for `FormatCode` is what is inserted into the\ndiff, the default is ``.\n\n`FormatFile` returns reformatted code from the passed file along with its encoding:\n\n```python\n>>> from yapf.yapflib.yapf_api import FormatFile # reformat a file\n\n>>> print(open(\"foo.py\").read()) # contents of file\na==b\n\n>>> reformatted_code, encoding, changed = FormatFile(\"foo.py\")\n>>> formatted_code\n'a == b\\n'\n>>> encoding\n'utf-8'\n>>> changed\nTrue\n```\n\nThe `in_place` argument saves the reformatted code back to the file:\n\n```python\n>>> FormatFile(\"foo.py\", in_place=True)[:2]\n(None, 'utf-8')\n\n>>> print(open(\"foo.py\").read()) # contents of file (now fixed)\na == b\n```\n\n\n## Formatting diffs\n\nOptions:\n\n```console\nusage: yapf-diff [-h] [-i] [-p NUM] [--regex PATTERN] [--iregex PATTERN][-v]\n [--style STYLE] [--binary BINARY]\n\nThis script reads input from a unified diff and reformats all the changed\nlines. This is useful to reformat all the lines touched by a specific patch.\nExample usage for git/svn users:\n\n git diff -U0 --no-color --relative HEAD^ | yapf-diff -i\n svn diff --diff-cmd=diff -x-U0 | yapf-diff -p0 -i\n\nIt should be noted that the filename contained in the diff is used\nunmodified to determine the source file to update. Users calling this script\ndirectly should be careful to ensure that the path in the diff is correct\nrelative to the current working directory.\n\noptional arguments:\n -h, --help show this help message and exit\n -i, --in-place apply edits to files instead of displaying a diff\n -p NUM, --prefix NUM strip the smallest prefix containing P slashes\n --regex PATTERN custom pattern selecting file paths to reformat\n (case sensitive, overrides -iregex)\n --iregex PATTERN custom pattern selecting file paths to reformat\n (case insensitive, overridden by -regex)\n -v, --verbose be more verbose, ineffective without -i\n --style STYLE specify formatting style: either a style name (for\n example \"pep8\" or \"google\"), or the name of a file\n with style settings. The default is pep8 unless a\n .style.yapf or setup.cfg or pyproject.toml file\n located in the same directory as the source or one of\n its parent directories (for stdin, the current\n directory is used).\n --binary BINARY location of binary to use for YAPF\n```\n\n## Python features not yet supported\n* Python 3.12 – [PEP 695 – Type Parameter Syntax](https://peps.python.org/pep-0695/) – [YAPF #1170](https://github.com/google/yapf/issues/1170)\n* Python 3.12 – [PEP 701 – Syntactic formalization of f-strings](https://peps.python.org/pep-0701/) – [YAPF #1136](https://github.com/google/yapf/issues/1136)\n\n## Knobs\n\n#### `ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT`\n\n> Align closing bracket with visual indentation.\n\n#### `ALLOW_MULTILINE_LAMBDAS`\n\n> Allow lambdas to be formatted on more than one line.\n\n#### `ALLOW_MULTILINE_DICTIONARY_KEYS`\n\n> Allow dictionary keys to exist on multiple lines. For example:\n\n```python\n x = {\n ('this is the first element of a tuple',\n 'this is the second element of a tuple'):\n value,\n }\n```\n\n#### `ALLOW_SPLIT_BEFORE_DEFAULT_OR_NAMED_ASSIGNS`\n\n> Allow splitting before a default / named assignment in an argument list.\n\n#### `ALLOW_SPLIT_BEFORE_DICT_VALUE`\n\n> Allow splits before the dictionary value.\n\n#### `ARITHMETIC_PRECEDENCE_INDICATION`\n\n> Let spacing indicate operator precedence. For example:\n\n```python\n a = 1 * 2 + 3 / 4\n b = 1 / 2 - 3 * 4\n c = (1 + 2) * (3 - 4)\n d = (1 - 2) / (3 + 4)\n e = 1 * 2 - 3\n f = 1 + 2 + 3 + 4\n```\n\n> will be formatted as follows to indicate precedence:\n\n```python\n a = 1*2 + 3/4\n b = 1/2 - 3*4\n c = (1+2) * (3-4)\n d = (1-2) / (3+4)\n e = 1*2 - 3\n f = 1 + 2 + 3 + 4\n```\n\n#### `BLANK_LINES_AROUND_TOP_LEVEL_DEFINITION`\n\n> Sets the number of desired blank lines surrounding top-level function and\n> class definitions. For example:\n\n```python\n class Foo:\n pass\n # <------ having two blank lines here\n # <------ is the default setting\n class Bar:\n pass\n```\n\n#### `BLANK_LINE_BEFORE_CLASS_DOCSTRING`\n\n> Insert a blank line before a class-level docstring.\n\n#### `BLANK_LINE_BEFORE_MODULE_DOCSTRING`\n\n> Insert a blank line before a module docstring.\n\n#### `BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF`\n\n> Insert a blank line before a `def` or `class` immediately nested within\n> another `def` or `class`. For example:\n\n```python\n class Foo:\n # <------ this blank line\n def method():\n pass\n```\n\n#### `BLANK_LINES_BETWEEN_TOP_LEVEL_IMPORTS_AND_VARIABLES`\n\n> Sets the number of desired blank lines between top-level imports and\n> variable definitions. Useful for compatibility with tools like isort.\n\n#### `COALESCE_BRACKETS`\n\n> Do not split consecutive brackets. Only relevant when\n> `DEDENT_CLOSING_BRACKETS` or `INDENT_CLOSING_BRACKETS` is set. For example:\n\n```python\n call_func_that_takes_a_dict(\n {\n 'key1': 'value1',\n 'key2': 'value2',\n }\n )\n```\n\n> would reformat to:\n\n```python\n call_func_that_takes_a_dict({\n 'key1': 'value1',\n 'key2': 'value2',\n })\n```\n\n#### `COLUMN_LIMIT`\n\n> The column limit (or max line-length)\n\n#### `CONTINUATION_ALIGN_STYLE`\n\n> The style for continuation alignment. Possible values are:\n\n> - `SPACE`: Use spaces for continuation alignment. This is default\n> behavior.\n> - `FIXED`: Use fixed number (`CONTINUATION_INDENT_WIDTH`) of columns\n> (i.e. `CONTINUATION_INDENT_WIDTH`/`INDENT_WIDTH` tabs or\n> `CONTINUATION_INDENT_WIDTH` spaces) for continuation alignment.\n> - `VALIGN-RIGHT`: Vertically align continuation lines to multiple of\n> `INDENT_WIDTH` columns. Slightly right (one tab or a few spaces) if cannot\n> vertically align continuation lines with indent characters.\n\n#### `CONTINUATION_INDENT_WIDTH`\n\n> Indent width used for line continuations.\n\n#### `DEDENT_CLOSING_BRACKETS`\n\n> Put closing brackets on a separate line, dedented, if the bracketed\n> expression can't fit in a single line. Applies to all kinds of brackets,\n> including function definitions and calls. For example:\n\n```python\n config = {\n 'key1': 'value1',\n 'key2': 'value2',\n } # <--- this bracket is dedented and on a separate line\n\n time_series = self.remote_client.query_entity_counters(\n entity='dev3246.region1',\n key='dns.query_latency_tcp',\n transform=Transformation.AVERAGE(window=timedelta(seconds=60)),\n start_ts=now()-timedelta(days=3),\n end_ts=now(),\n ) # <--- this bracket is dedented and on a separate line\n```\n\n#### `DISABLE_ENDING_COMMA_HEURISTIC`\n\n> Disable the heuristic which places each list element on a separate line if\n> the list is comma-terminated.\n>\n> Note: The behavior of this flag changed in v0.40.3. Before, if this flag\n> was true, we would split lists that contained a trailing comma or a\n> comment. Now, we have a separate flag, `DISABLE_SPLIT_LIST_WITH_COMMENT`,\n> that controls splitting when a list contains a comment. To get the old\n> behavior, set both flags to true. More information in\n> [CHANGELOG.md](CHANGELOG.md#new-disable_split_list_with_comment-flag).\n\n#### `DISABLE_SPLIT_LIST_WITH_COMMENT`\n\n> Don't put every element on a new line within a list that contains\n> interstitial comments.\n>\n> Without this flag (default):\n>\n> ```\n> [\n> a,\n> b, #\n> c\n> ]\n> ```\n>\n> With this flag:\n>\n> ```\n> [\n> a, b, #\n> c\n> ]\n> ```\n>\n> This mirrors the behavior of clang-format and is useful for forming\n> \"logical groups\" of elements in a list. It also works in function\n> declarations.\n\n#### `EACH_DICT_ENTRY_ON_SEPARATE_LINE`\n\n> Place each dictionary entry onto its own line.\n\n#### `FORCE_MULTILINE_DICT`\n\n> Respect `EACH_DICT_ENTRY_ON_SEPARATE_LINE` even if the line is shorter than\n> `COLUMN_LIMIT`.\n\n#### `I18N_COMMENT`\n\n> The regex for an internationalization comment. The presence of this comment\n> stops reformatting of that line, because the comments are required to be\n> next to the string they translate.\n\n#### `I18N_FUNCTION_CALL`\n\n> The internationalization function call names. The presence of this function\n> stops reformatting on that line, because the string it has cannot be moved\n> away from the i18n comment.\n\n#### `INDENT_BLANK_LINES`\n\n> Set to `True` to prefer indented blank lines rather than empty\n\n#### `INDENT_CLOSING_BRACKETS`\n\n> Put closing brackets on a separate line, indented, if the bracketed\n> expression can't fit in a single line. Applies to all kinds of brackets,\n> including function definitions and calls. For example:\n\n```python\n config = {\n 'key1': 'value1',\n 'key2': 'value2',\n } # <--- this bracket is indented and on a separate line\n\n time_series = self.remote_client.query_entity_counters(\n entity='dev3246.region1',\n key='dns.query_latency_tcp',\n transform=Transformation.AVERAGE(window=timedelta(seconds=60)),\n start_ts=now()-timedelta(days=3),\n end_ts=now(),\n ) # <--- this bracket is indented and on a separate line\n```\n\n#### `INDENT_DICTIONARY_VALUE`\n\n> Indent the dictionary value if it cannot fit on the same line as the\n> dictionary key. For example:\n\n```python\n config = {\n 'key1':\n 'value1',\n 'key2': value1 +\n value2,\n }\n```\n\n#### `INDENT_WIDTH`\n\n> The number of columns to use for indentation.\n\n#### `JOIN_MULTIPLE_LINES`\n\n> Join short lines into one line. E.g., single line `if` statements.\n\n#### `NO_SPACES_AROUND_SELECTED_BINARY_OPERATORS`\n\n> Do not include spaces around selected binary operators. For example:\n\n```python\n 1 + 2 * 3 - 4 / 5\n```\n\n> will be formatted as follows when configured with `*`, `/`:\n\n```python\n 1 + 2*3 - 4/5\n```\n\n#### `SPACE_BETWEEN_ENDING_COMMA_AND_CLOSING_BRACKET`\n\n> Insert a space between the ending comma and closing bracket of a list, etc.\n\n#### `SPACE_INSIDE_BRACKETS`\n\n Use spaces inside brackets, braces, and parentheses. For example:\n\n```python\n method_call( 1 )\n my_dict[ 3 ][ 1 ][ get_index( *args, **kwargs ) ]\n my_set = { 1, 2, 3 }\n```\n\n#### `SPACES_AROUND_DEFAULT_OR_NAMED_ASSIGN`\n\n> Set to `True` to prefer spaces around the assignment operator for default\n> or keyword arguments.\n\n#### `SPACES_AROUND_DICT_DELIMITERS`\n\n> Adds a space after the opening '{' and before the ending '}' dict delimiters.\n\n```python\n {1: 2}\n```\n\n> will be formatted as:\n\n```python\n { 1: 2 }\n```\n\n#### `SPACES_AROUND_LIST_DELIMITERS`\n\n> Adds a space after the opening '[' and before the ending ']' list delimiters.\n\n```python\n [1, 2]\n```\n\n> will be formatted as:\n\n```python\n [ 1, 2 ]\n```\n\n#### `SPACES_AROUND_POWER_OPERATOR`\n\n> Set to `True` to prefer using spaces around `**`.\n\n#### `SPACES_AROUND_SUBSCRIPT_COLON`\n\n> Use spaces around the subscript / slice operator. For example:\n\n```python\n my_list[1 : 10 : 2]\n```\n\n##### `SPACES_AROUND_TUPLE_DELIMITERS`\n\n> Adds a space after the opening '(' and before the ending ')' tuple delimiters.\n\n```python\n (1, 2, 3)\n```\n\n> will be formatted as:\n\n```python\n ( 1, 2, 3 )\n```\n\n#### `SPACES_BEFORE_COMMENT`\n\n> The number of spaces required before a trailing comment.\n> This can be a single value (representing the number of spaces\n> before each trailing comment) or list of values (representing\n> alignment column values; trailing comments within a block will\n> be aligned to the first column value that is greater than the maximum\n> line length within the block).\n\n> **Note:** Lists of values may need to be quoted in some contexts\n> (eg. shells or editor config files).\n\n> For example, with `spaces_before_comment=5`:\n\n```python\n 1 + 1 # Adding values\n```\n\n> will be formatted as:\n\n```python\n 1 + 1 # Adding values <-- 5 spaces between the end of the statement and comment\n```\n\n> with `spaces_before_comment=\"15, 20\"`:\n\n```python\n 1 + 1 # Adding values\n two + two # More adding\n\n longer_statement # This is a longer statement\n short # This is a shorter statement\n\n a_very_long_statement_that_extends_beyond_the_final_column # Comment\n short # This is a shorter statement\n```\n\n> will be formatted as:\n\n```python\n 1 + 1 # Adding values <-- end of line comments in block aligned to col 15\n two + two # More adding\n\n longer_statement # This is a longer statement <-- end of line comments in block aligned to col 20\n short # This is a shorter statement\n\n a_very_long_statement_that_extends_beyond_the_final_column # Comment <-- the end of line comments are aligned based on the line length\n short # This is a shorter statement\n```\n\n#### `SPLIT_ALL_COMMA_SEPARATED_VALUES`\n\n> If a comma separated list (`dict`, `list`, `tuple`, or function `def`) is\n> on a line that is too long, split such that each element is on a separate\n> line.\n\n#### `SPLIT_ALL_TOP_LEVEL_COMMA_SEPARATED_VALUES`\n\n> Variation on `SPLIT_ALL_COMMA_SEPARATED_VALUES` in which, if a\n> subexpression with a comma fits in its starting line, then the\n> subexpression is not split. This avoids splits like the one for\n> `b` in this code:\n\n```python\n abcdef(\n aReallyLongThing: int,\n b: [Int,\n Int])\n```\n\n> with the new knob this is split as:\n\n```python\n abcdef(\n aReallyLongThing: int,\n b: [Int, Int])\n```\n\n#### `SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED`\n\n> Split before arguments if the argument list is terminated by a comma.\n\n#### `SPLIT_BEFORE_ARITHMETIC_OPERATOR`\n\n> Set to `True` to prefer splitting before `+`, `-`, `*`, `/`, `//`, or `@`\n> rather than after.\n\n#### `SPLIT_BEFORE_BITWISE_OPERATOR`\n\n> Set to `True` to prefer splitting before `&`, `|` or `^` rather than after.\n\n#### `SPLIT_BEFORE_CLOSING_BRACKET`\n\n> Split before the closing bracket if a `list` or `dict` literal doesn't fit\n> on a single line.\n\n#### `SPLIT_BEFORE_DICT_SET_GENERATOR`\n\n> Split before a dictionary or set generator (`comp_for`). For example, note\n> the split before the `for`:\n\n```python\n foo = {\n variable: 'Hello world, have a nice day!'\n for variable in bar if variable != 42\n }\n```\n\n#### `SPLIT_BEFORE_DOT`\n\n> Split before the `.` if we need to split a longer expression:\n\n```python\n foo = ('This is a really long string: {}, {}, {}, {}'.format(a, b, c, d))\n```\n\n> would reformat to something like:\n\n```python\n foo = ('This is a really long string: {}, {}, {}, {}'\n .format(a, b, c, d))\n```\n\n#### `SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN`\n\n> Split after the opening paren which surrounds an expression if it doesn't\n> fit on a single line.\n\n#### `SPLIT_BEFORE_FIRST_ARGUMENT`\n\n> If an argument / parameter list is going to be split, then split before the\n> first argument.\n\n#### `SPLIT_BEFORE_LOGICAL_OPERATOR`\n\n> Set to `True` to prefer splitting before `and` or `or` rather than after.\n\n#### `SPLIT_BEFORE_NAMED_ASSIGNS`\n\n> Split named assignments onto individual lines.\n\n#### `SPLIT_COMPLEX_COMPREHENSION`\n\n> For list comprehensions and generator expressions with multiple clauses\n> (e.g multiple `for` calls, `if` filter expressions) and which need to be\n> reflowed, split each clause onto its own line. For example:\n\n```python\n result = [\n a_var + b_var for a_var in xrange(1000) for b_var in xrange(1000)\n if a_var % b_var]\n```\n\n> would reformat to something like:\n\n```python\n result = [\n a_var + b_var\n for a_var in xrange(1000)\n for b_var in xrange(1000)\n if a_var % b_var]\n```\n\n#### `SPLIT_PENALTY_AFTER_OPENING_BRACKET`\n\n> The penalty for splitting right after the opening bracket.\n\n#### `SPLIT_PENALTY_AFTER_UNARY_OPERATOR`\n\n> The penalty for splitting the line after a unary operator.\n\n#### `SPLIT_PENALTY_ARITHMETIC_OPERATOR`\n\n> The penalty of splitting the line around the `+`, `-`, `*`, `/`, `//`, `%`,\n> and `@` operators.\n\n#### `SPLIT_PENALTY_BEFORE_IF_EXPR`\n\n> The penalty for splitting right before an `if` expression.\n\n#### `SPLIT_PENALTY_BITWISE_OPERATOR`\n\n> The penalty of splitting the line around the `&`, `|`, and `^` operators.\n\n#### `SPLIT_PENALTY_COMPREHENSION`\n\n> The penalty for splitting a list comprehension or generator expression.\n\n#### `SPLIT_PENALTY_EXCESS_CHARACTER`\n\n> The penalty for characters over the column limit.\n\n#### `SPLIT_PENALTY_FOR_ADDED_LINE_SPLIT`\n\n> The penalty incurred by adding a line split to the logical line. The more\n> line splits added the higher the penalty.\n\n#### `SPLIT_PENALTY_IMPORT_NAMES`\n\n> The penalty of splitting a list of `import as` names. For example:\n\n```python\n from a_very_long_or_indented_module_name_yada_yad import (long_argument_1,\n long_argument_2,\n long_argument_3)\n```\n\n> would reformat to something like:\n\n```python\n from a_very_long_or_indented_module_name_yada_yad import (\n long_argument_1, long_argument_2, long_argument_3)\n```\n\n#### `SPLIT_PENALTY_LOGICAL_OPERATOR`\n\n> The penalty of splitting the line around the `and` and `or` operators.\n\n#### `USE_TABS`\n\n> Use the Tab character for indentation.\n\n\n## (Potentially) Frequently Asked Questions\n\n### Why does YAPF destroy my awesome formatting?\n\nYAPF tries very hard to get the formatting correct. But for some code, it won't\nbe as good as hand-formatting. In particular, large data literals may become\nhorribly disfigured under YAPF.\n\nThe reasons for this are manyfold. In short, YAPF is simply a tool to help\nwith development. It will format things to coincide with the style guide, but\nthat may not equate with readability.\n\nWhat can be done to alleviate this situation is to indicate regions YAPF should\nignore when reformatting something:\n\n```python\n# yapf: disable\nFOO = {\n # ... some very large, complex data literal.\n}\n\nBAR = [\n # ... another large data literal.\n]\n# yapf: enable\n```\n\nYou can also disable formatting for a single literal like this:\n\n```python\nBAZ = {\n (1, 2, 3, 4),\n (5, 6, 7, 8),\n (9, 10, 11, 12),\n} # yapf: disable\n```\n\nTo preserve the nice dedented closing brackets, use the\n`dedent_closing_brackets` in your style. Note that in this case all\nbrackets, including function definitions and calls, are going to use\nthat style. This provides consistency across the formatted codebase.\n\n### Why Not Improve Existing Tools?\n\nWe wanted to use clang-format's reformatting algorithm. It's very powerful and\ndesigned to come up with the best formatting possible. Existing tools were\ncreated with different goals in mind, and would require extensive modifications\nto convert to using clang-format's algorithm.\n\n### Can I Use YAPF In My Program?\n\nPlease do! YAPF was designed to be used as a library as well as a command line\ntool. This means that a tool or IDE plugin is free to use YAPF.\n\n### I still get non-PEP8 compliant code! Why?\n\nYAPF tries very hard to be fully PEP 8 compliant. However, it is paramount\nto not risk altering the semantics of your code. Thus, YAPF tries to be as\nsafe as possible and does not change the token stream\n(e.g., by adding parentheses).\nAll these cases however, can be easily fixed manually. For instance,\n\n```python\nfrom my_package import my_function_1, my_function_2, my_function_3, my_function_4, my_function_5\n\nFOO = my_variable_1 + my_variable_2 + my_variable_3 + my_variable_4 + my_variable_5 + my_variable_6 + my_variable_7 + my_variable_8\n```\n\nwon't be split, but you can easily get it right by just adding parentheses:\n\n```python\nfrom my_package import (my_function_1, my_function_2, my_function_3,\n my_function_4, my_function_5)\n\nFOO = (my_variable_1 + my_variable_2 + my_variable_3 + my_variable_4 +\n my_variable_5 + my_variable_6 + my_variable_7 + my_variable_8)\n```\n\n\n## Gory Details\n\n### Algorithm Design\n\nThe main data structure in YAPF is the `LogicalLine` object. It holds a list\nof `FormatToken`\\s, that we would want to place on a single line if there\nwere no column limit. An exception being a comment in the middle of an\nexpression statement will force the line to be formatted on more than one line.\nThe formatter works on one `LogicalLine` object at a time.\n\nAn `LogicalLine` typically won't affect the formatting of lines before or\nafter it. There is a part of the algorithm that may join two or more\n`LogicalLine`\\s into one line. For instance, an if-then statement with a\nshort body can be placed on a single line:\n\n```python\nif a == 42: continue\n```\n\nYAPF's formatting algorithm creates a weighted tree that acts as the solution\nspace for the algorithm. Each node in the tree represents the result of a\nformatting decision --- i.e., whether to split or not to split before a token.\nEach formatting decision has a cost associated with it. Therefore, the cost is\nrealized on the edge between two nodes. (In reality, the weighted tree doesn't\nhave separate edge objects, so the cost resides on the nodes themselves.)\n\nFor example, take the following Python code snippet. For the sake of this\nexample, assume that line (1) violates the column limit restriction and needs to\nbe reformatted.\n\n```python\ndef xxxxxxxxxxx(aaaaaaaaaaaa, bbbbbbbbb, cccccccc, dddddddd, eeeeee): # 1\n pass # 2\n```\n\nFor line (1), the algorithm will build a tree where each node (a\n`FormattingDecisionState` object) is the state of the line at that token given\nthe decision to split before the token or not. Note: the `FormatDecisionState`\nobjects are copied by value so each node in the graph is unique and a change in\none doesn't affect other nodes.\n\nHeuristics are used to determine the costs of splitting or not splitting.\nBecause a node holds the state of the tree up to a token's insertion, it can\neasily determine if a splitting decision will violate one of the style\nrequirements. For instance, the heuristic is able to apply an extra penalty to\nthe edge when not splitting between the previous token and the one being added.\n\nThere are some instances where we will never want to split the line, because\ndoing so will always be detrimental (i.e., it will require a backslash-newline,\nwhich is very rarely desirable). For line (1), we will never want to split the\nfirst three tokens: `def`, `xxxxxxxxxxx`, and `(`. Nor will we want to\nsplit between the `)` and the `:` at the end. These regions are said to be\n\"unbreakable.\" This is reflected in the tree by there not being a \"split\"\ndecision (left hand branch) within the unbreakable region.\n\nNow that we have the tree, we determine what the \"best\" formatting is by finding\nthe path through the tree with the lowest cost.\n\nAnd that's it!\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":" Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":"Bill Wendling ","name":"yapf","package_url":"https://pypi.org/project/yapf/","platform":null,"project_url":"https://pypi.org/project/yapf/","project_urls":{"Changelog":"https://github.com/google/yapf/blob/main/CHANGELOG.md","Docs":"https://github.com/google/yapf/blob/main/README.md#yapf","Home":"https://github.com/google/yapf","Issues":"https://github.com/google/yapf/issues"},"provides_extra":null,"release_url":"https://pypi.org/project/yapf/0.43.0/","requires_dist":["platformdirs>=3.5.1","tomli>=2.0.1; python_version < \"3.11\""],"requires_python":">=3.7","summary":"A formatter for Python code","version":"0.43.0","yanked":false,"yanked_reason":null}

Dependencies of yapf (2).
Dependency	Optional
platformdirs	false
tomli	false

Package search

yapf

project_urls

Dependencies

All package metadata

Releases