BorderBan/client-py
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions
client-py/venv/lib/python3.12/site-packages/yapf-0.43.0.dist-info/METADATA
borderban 56f7e25fed 1.0
2026-05-02 13:34:53 +05:00

1305 lines
46 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Metadata-Version: 2.1
Name: yapf
Version: 0.43.0
Summary: A formatter for Python code
Author: Google Inc.
Maintainer-email: Bill Wendling <morbo@google.com>
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.
Project-URL: Home, https://github.com/google/yapf
Project-URL: Changelog, https://github.com/google/yapf/blob/main/CHANGELOG.md
Project-URL: Docs, https://github.com/google/yapf/blob/main/README.md#yapf
Project-URL: Issues, https://github.com/google/yapf/issues
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: platformdirs >=3.5.1
Requires-Dist: tomli >=2.0.1 ; python_version < "3.11"
# YAPF
<p align="center">
<a href="https://badge.fury.io/py/yapf"><img alt="PyPI Version" src="https://badge.fury.io/py/yapf.svg"></a>
<a href="https://github.com/google/yapf/actions/workflows/ci.yml"><img alt="Build Status" src="https://github.com/google/yapf/actions/workflows/ci.yml/badge.svg"></a>
<a href="https://github.com/google/yapf/actions/workflows/pre-commit.yml"><img alt="Actions Status" src="https://github.com/google/yapf/actions/workflows/pre-commit.yml/badge.svg"></a>
<a href="https://coveralls.io/github/google/yapf?branch=main"><img alt="Coverage Status" src="https://coveralls.io/repos/github/google/yapf/badge.svg?branch=main"></a>
</p>
## Introduction
YAPF is a Python formatter based on [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html)
(developed by Daniel Jasper). In essence, the algorithm takes the code and
calculates the best formatting that conforms to the configured style. It takes
away a lot of the drudgery of maintaining your code.
The ultimate goal is that the code YAPF produces is as good as the code that a
programmer would write if they were following the style guide.
> **Note**
> YAPF is not an official Google product (experimental or otherwise), it is
> just code that happens to be owned by Google.
## Installation
To install YAPF from PyPI:
```bash
$ pip install yapf
```
YAPF is still considered in "beta" stage, and the released version may change
often; therefore, the best way to keep up-to-date with the latest development
is to clone this repository or install directly from github:
```bash
$ pip install git+https://github.com/google/yapf.git
```
Note that if you intend to use YAPF as a command-line tool rather than as a
library, installation is not necessary. YAPF supports being run as a directory
by the Python interpreter. If you cloned/unzipped YAPF into `DIR`, it's
possible to run:
```bash
$ PYTHONPATH=DIR python DIR/yapf [options] ...
```
## Using YAPF within your favorite editor
YAPF is supported by multiple editors via community extensions or plugins. See [Editor Support](EDITOR%20SUPPORT.md) for more info.
## Required Python versions
YAPF supports Python 3.7+.
## Usage
```console
usage: yapf [-h] [-v] [-d | -i | -q] [-r | -l START-END] [-e PATTERN]
[--style STYLE] [--style-help] [--no-local-style] [-p] [-m] [-vv]
[files ...]
Formatter for Python code.
positional arguments:
files reads from stdin when no files are specified.
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-d, --diff print the diff for the fixed source
-i, --in-place make changes to files in place
-q, --quiet output nothing and set return value
-r, --recursive run recursively over directories
-l START-END, --lines START-END
range of lines to reformat, one-based
-e PATTERN, --exclude PATTERN
patterns for files to exclude from formatting
--style STYLE specify formatting style: either a style name (for
example "pep8" or "google"), or the name of a file
with style settings. The default is pep8 unless a
.style.yapf or setup.cfg or pyproject.toml file
located in the same directory as the source or one of
its parent directories (for stdin, the current
directory is used).
--style-help show style settings and exit; this output can be saved
to .style.yapf to make your settings permanent
--no-local-style don't search for local style definition
-p, --parallel run YAPF in parallel when formatting multiple files.
-m, --print-modified print out file names of modified files
-vv, --verbose print out file names while processing
```
### Return Codes
Normally YAPF returns zero on successful program termination and non-zero
otherwise.
If `--diff` is supplied, YAPF returns zero when no changes were necessary,
non-zero otherwise (including program error). You can use this in a CI workflow
to test that code has been YAPF-formatted.
### Excluding files from formatting (.yapfignore or pyproject.toml)
In addition to exclude patterns provided on commandline, YAPF looks for
additional patterns specified in a file named `.yapfignore` or `pyproject.toml`
located in the working directory from which YAPF is invoked.
`.yapfignore`'s syntax is similar to UNIX's filename pattern matching:
```
* matches everything
? matches any single character
[seq] matches any character in seq
[!seq] matches any character not in seq
```
Note that no entry should begin with `./`.
If you use `pyproject.toml`, exclude patterns are specified by `ignore_patterns` key
in `[tool.yapfignore]` section. For example:
```ini
[tool.yapfignore]
ignore_patterns = [
"temp/**/*.py",
"temp2/*.py"
]
```
Formatting style
================
The formatting style used by YAPF is configurable and there are many "knobs"
that can be used to tune how YAPF does formatting. See the `style.py` module
for the full list.
To control the style, run YAPF with the `--style` argument. It accepts one of
the predefined styles (e.g., `pep8` or `google`), a path to a configuration
file that specifies the desired style, or a dictionary of key/value pairs.
The config file is a simple listing of (case-insensitive) `key = value` pairs
with a `[style]` heading. For example:
```ini
[style]
based_on_style = pep8
spaces_before_comment = 4
split_before_logical_operator = true
```
The `based_on_style` setting determines which of the predefined styles this
custom style is based on (think of it like subclassing). Four
styles are predefined:
- `pep8` (default)
- `google` (based off of the [Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md))
- `yapf` (for use with Google open source projects)
- `facebook`
See `_STYLE_NAME_TO_FACTORY` in [`style.py`](https://github.com/google/yapf/blob/main/yapf/yapflib/style.py) for details.
It's also possible to do the same on the command line with a dictionary. For
example:
```bash
--style='{based_on_style: pep8, indent_width: 2}'
```
This will take the `pep8` base style and modify it to have two space
indentations.
YAPF will search for the formatting style in the following manner:
1. Specified on the command line
2. In the `[style]` section of a `.style.yapf` file in either the current
directory or one of its parent directories.
3. In the `[yapf]` section of a `setup.cfg` file in either the current
directory or one of its parent directories.
4. In the `[tool.yapf]` section of a `pyproject.toml` file in either the current
directory or one of its parent directories.
5. In the `[style]` section of a `~/.config/yapf/style` file in your home
directory.
If none of those files are found, the default style PEP8 is used.
Example
=======
An example of the type of formatting that YAPF can do, it will take this ugly
code:
```python
x = { 'a':37,'b':42,
'c':927}
y = 'hello ''world'
z = 'hello '+'world'
a = 'hello {}'.format('world')
class foo ( object ):
def f (self ):
return 37*-+2
def g(self, x,y=42):
return y
def f ( a ) :
return 37+-+a[42-x : y**3]
```
and reformat it into:
```python
x = {'a': 37, 'b': 42, 'c': 927}
y = 'hello ' 'world'
z = 'hello ' + 'world'
a = 'hello {}'.format('world')
class foo(object):
def f(self):
return 37 * -+2
def g(self, x, y=42):
return y
def f(a):
return 37 + -+a[42 - x:y**3]
```
## Example as a module
The two main APIs for calling YAPF are `FormatCode` and `FormatFile`, these
share several arguments which are described below:
```python
>>> from yapf.yapflib.yapf_api import FormatCode # reformat a string of code
>>> formatted_code, changed = FormatCode("f ( a = 1, b = 2 )")
>>> formatted_code
'f(a=1, b=2)\n'
>>> changed
True
```
A `style_config` argument: Either a style name or a path to a file that
contains formatting style settings. If None is specified, use the default style
as set in `style.DEFAULT_STYLE_FACTORY`.
```python
>>> FormatCode("def g():\n return True", style_config='pep8')[0]
'def g():\n return True\n'
```
A `lines` argument: A list of tuples of lines (ints), [start, end], that we
want to format. The lines are 1-based indexed. It can be used by third-party
code (e.g., IDEs) when reformatting a snippet of code rather than a whole file.
```python
>>> FormatCode("def g( ):\n a=1\n b = 2\n return a==b", lines=[(1, 1), (2, 3)])[0]
'def g():\n a = 1\n b = 2\n return a==b\n'
```
A `print_diff` (bool): Instead of returning the reformatted source, return a
diff that turns the formatted source into reformatted source.
```diff
>>> print(FormatCode("a==b", filename="foo.py", print_diff=True)[0])
--- foo.py (original)
+++ foo.py (reformatted)
@@ -1 +1 @@
-a==b
+a == b
```
Note: the `filename` argument for `FormatCode` is what is inserted into the
diff, the default is `<unknown>`.
`FormatFile` returns reformatted code from the passed file along with its encoding:
```python
>>> from yapf.yapflib.yapf_api import FormatFile # reformat a file
>>> print(open("foo.py").read()) # contents of file
a==b
>>> reformatted_code, encoding, changed = FormatFile("foo.py")
>>> formatted_code
'a == b\n'
>>> encoding
'utf-8'
>>> changed
True
```
The `in_place` argument saves the reformatted code back to the file:
```python
>>> FormatFile("foo.py", in_place=True)[:2]
(None, 'utf-8')
>>> print(open("foo.py").read()) # contents of file (now fixed)
a == b
```
## Formatting diffs
Options:
```console
usage: yapf-diff [-h] [-i] [-p NUM] [--regex PATTERN] [--iregex PATTERN][-v]
[--style STYLE] [--binary BINARY]
This script reads input from a unified diff and reformats all the changed
lines. This is useful to reformat all the lines touched by a specific patch.
Example usage for git/svn users:
git diff -U0 --no-color --relative HEAD^ | yapf-diff -i
svn diff --diff-cmd=diff -x-U0 | yapf-diff -p0 -i
It should be noted that the filename contained in the diff is used
unmodified to determine the source file to update. Users calling this script
directly should be careful to ensure that the path in the diff is correct
relative to the current working directory.
optional arguments:
-h, --help show this help message and exit
-i, --in-place apply edits to files instead of displaying a diff
-p NUM, --prefix NUM strip the smallest prefix containing P slashes
--regex PATTERN custom pattern selecting file paths to reformat
(case sensitive, overrides -iregex)
--iregex PATTERN custom pattern selecting file paths to reformat
(case insensitive, overridden by -regex)
-v, --verbose be more verbose, ineffective without -i
--style STYLE specify formatting style: either a style name (for
example "pep8" or "google"), or the name of a file
with style settings. The default is pep8 unless a
.style.yapf or setup.cfg or pyproject.toml file
located in the same directory as the source or one of
its parent directories (for stdin, the current
directory is used).
--binary BINARY location of binary to use for YAPF
```
## Python features not yet supported
* Python 3.12 – [PEP 695 – Type Parameter Syntax](https://peps.python.org/pep-0695/) – [YAPF #1170](https://github.com/google/yapf/issues/1170)
* 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)
## Knobs
#### `ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT`
> Align closing bracket with visual indentation.
#### `ALLOW_MULTILINE_LAMBDAS`
> Allow lambdas to be formatted on more than one line.
#### `ALLOW_MULTILINE_DICTIONARY_KEYS`
> Allow dictionary keys to exist on multiple lines. For example:
```python
x = {
('this is the first element of a tuple',
'this is the second element of a tuple'):
value,
}
```
#### `ALLOW_SPLIT_BEFORE_DEFAULT_OR_NAMED_ASSIGNS`
> Allow splitting before a default / named assignment in an argument list.
#### `ALLOW_SPLIT_BEFORE_DICT_VALUE`
> Allow splits before the dictionary value.
#### `ARITHMETIC_PRECEDENCE_INDICATION`
> Let spacing indicate operator precedence. For example:
```python
a = 1 * 2 + 3 / 4
b = 1 / 2 - 3 * 4
c = (1 + 2) * (3 - 4)
d = (1 - 2) / (3 + 4)
e = 1 * 2 - 3
f = 1 + 2 + 3 + 4
```
> will be formatted as follows to indicate precedence:
```python
a = 1*2 + 3/4
b = 1/2 - 3*4
c = (1+2) * (3-4)
d = (1-2) / (3+4)
e = 1*2 - 3
f = 1 + 2 + 3 + 4
```
#### `BLANK_LINES_AROUND_TOP_LEVEL_DEFINITION`
> Sets the number of desired blank lines surrounding top-level function and
> class definitions. For example:
```python
class Foo:
pass
# <------ having two blank lines here
# <------ is the default setting
class Bar:
pass
```
#### `BLANK_LINE_BEFORE_CLASS_DOCSTRING`
> Insert a blank line before a class-level docstring.
#### `BLANK_LINE_BEFORE_MODULE_DOCSTRING`
> Insert a blank line before a module docstring.
#### `BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF`
> Insert a blank line before a `def` or `class` immediately nested within
> another `def` or `class`. For example:
```python
class Foo:
# <------ this blank line
def method():
pass
```
#### `BLANK_LINES_BETWEEN_TOP_LEVEL_IMPORTS_AND_VARIABLES`
> Sets the number of desired blank lines between top-level imports and
> variable definitions. Useful for compatibility with tools like isort.
#### `COALESCE_BRACKETS`
> Do not split consecutive brackets. Only relevant when
> `DEDENT_CLOSING_BRACKETS` or `INDENT_CLOSING_BRACKETS` is set. For example:
```python
call_func_that_takes_a_dict(
{
'key1': 'value1',
'key2': 'value2',
}
)
```
> would reformat to:
```python
call_func_that_takes_a_dict({
'key1': 'value1',
'key2': 'value2',
})
```
#### `COLUMN_LIMIT`
> The column limit (or max line-length)
#### `CONTINUATION_ALIGN_STYLE`
> The style for continuation alignment. Possible values are:
> - `SPACE`: Use spaces for continuation alignment. This is default
> behavior.
> - `FIXED`: Use fixed number (`CONTINUATION_INDENT_WIDTH`) of columns
> (i.e. `CONTINUATION_INDENT_WIDTH`/`INDENT_WIDTH` tabs or
> `CONTINUATION_INDENT_WIDTH` spaces) for continuation alignment.
> - `VALIGN-RIGHT`: Vertically align continuation lines to multiple of
> `INDENT_WIDTH` columns. Slightly right (one tab or a few spaces) if cannot
> vertically align continuation lines with indent characters.
#### `CONTINUATION_INDENT_WIDTH`
> Indent width used for line continuations.
#### `DEDENT_CLOSING_BRACKETS`
> Put closing brackets on a separate line, dedented, if the bracketed
> expression can't fit in a single line. Applies to all kinds of brackets,
> including function definitions and calls. For example:
```python
config = {
'key1': 'value1',
'key2': 'value2',
} # <--- this bracket is dedented and on a separate line
time_series = self.remote_client.query_entity_counters(
entity='dev3246.region1',
key='dns.query_latency_tcp',
transform=Transformation.AVERAGE(window=timedelta(seconds=60)),
start_ts=now()-timedelta(days=3),
end_ts=now(),
) # <--- this bracket is dedented and on a separate line
```
#### `DISABLE_ENDING_COMMA_HEURISTIC`
> Disable the heuristic which places each list element on a separate line if
> the list is comma-terminated.
>
> Note: The behavior of this flag changed in v0.40.3. Before, if this flag
> was true, we would split lists that contained a trailing comma or a
> comment. Now, we have a separate flag, `DISABLE_SPLIT_LIST_WITH_COMMENT`,
> that controls splitting when a list contains a comment. To get the old
> behavior, set both flags to true. More information in
> [CHANGELOG.md](CHANGELOG.md#new-disable_split_list_with_comment-flag).
#### `DISABLE_SPLIT_LIST_WITH_COMMENT`
> Don't put every element on a new line within a list that contains
> interstitial comments.
>
> Without this flag (default):
>
> ```
> [
> a,
> b, #
> c
> ]
> ```
>
> With this flag:
>
> ```
> [
> a, b, #
> c
> ]
> ```
>
> This mirrors the behavior of clang-format and is useful for forming
> "logical groups" of elements in a list. It also works in function
> declarations.
#### `EACH_DICT_ENTRY_ON_SEPARATE_LINE`
> Place each dictionary entry onto its own line.
#### `FORCE_MULTILINE_DICT`
> Respect `EACH_DICT_ENTRY_ON_SEPARATE_LINE` even if the line is shorter than
> `COLUMN_LIMIT`.
#### `I18N_COMMENT`
> The regex for an internationalization comment. The presence of this comment
> stops reformatting of that line, because the comments are required to be
> next to the string they translate.
#### `I18N_FUNCTION_CALL`
> The internationalization function call names. The presence of this function
> stops reformatting on that line, because the string it has cannot be moved
> away from the i18n comment.
#### `INDENT_BLANK_LINES`
> Set to `True` to prefer indented blank lines rather than empty
#### `INDENT_CLOSING_BRACKETS`
> Put closing brackets on a separate line, indented, if the bracketed
> expression can't fit in a single line. Applies to all kinds of brackets,
> including function definitions and calls. For example:
```python
config = {
'key1': 'value1',
'key2': 'value2',
} # <--- this bracket is indented and on a separate line
time_series = self.remote_client.query_entity_counters(
entity='dev3246.region1',
key='dns.query_latency_tcp',
transform=Transformation.AVERAGE(window=timedelta(seconds=60)),
start_ts=now()-timedelta(days=3),
end_ts=now(),
) # <--- this bracket is indented and on a separate line
```
#### `INDENT_DICTIONARY_VALUE`
> Indent the dictionary value if it cannot fit on the same line as the
> dictionary key. For example:
```python
config = {
'key1':
'value1',
'key2': value1 +
value2,
}
```
#### `INDENT_WIDTH`
> The number of columns to use for indentation.
#### `JOIN_MULTIPLE_LINES`
> Join short lines into one line. E.g., single line `if` statements.
#### `NO_SPACES_AROUND_SELECTED_BINARY_OPERATORS`
> Do not include spaces around selected binary operators. For example:
```python
1 + 2 * 3 - 4 / 5
```
> will be formatted as follows when configured with `*`, `/`:
```python
1 + 2*3 - 4/5
```
#### `SPACE_BETWEEN_ENDING_COMMA_AND_CLOSING_BRACKET`
> Insert a space between the ending comma and closing bracket of a list, etc.
#### `SPACE_INSIDE_BRACKETS`
Use spaces inside brackets, braces, and parentheses. For example:
```python
method_call( 1 )
my_dict[ 3 ][ 1 ][ get_index( *args, **kwargs ) ]
my_set = { 1, 2, 3 }
```
#### `SPACES_AROUND_DEFAULT_OR_NAMED_ASSIGN`
> Set to `True` to prefer spaces around the assignment operator for default
> or keyword arguments.
#### `SPACES_AROUND_DICT_DELIMITERS`
> Adds a space after the opening '{' and before the ending '}' dict delimiters.
```python
{1: 2}
```
> will be formatted as:
```python
{ 1: 2 }
```
#### `SPACES_AROUND_LIST_DELIMITERS`
> Adds a space after the opening '[' and before the ending ']' list delimiters.
```python
[1, 2]
```
> will be formatted as:
```python
[ 1, 2 ]
```
#### `SPACES_AROUND_POWER_OPERATOR`
> Set to `True` to prefer using spaces around `**`.
#### `SPACES_AROUND_SUBSCRIPT_COLON`
> Use spaces around the subscript / slice operator. For example:
```python
my_list[1 : 10 : 2]
```
##### `SPACES_AROUND_TUPLE_DELIMITERS`
> Adds a space after the opening '(' and before the ending ')' tuple delimiters.
```python
(1, 2, 3)
```
> will be formatted as:
```python
( 1, 2, 3 )
```
#### `SPACES_BEFORE_COMMENT`
> The number of spaces required before a trailing comment.
> This can be a single value (representing the number of spaces
> before each trailing comment) or list of values (representing
> alignment column values; trailing comments within a block will
> be aligned to the first column value that is greater than the maximum
> line length within the block).
> **Note:** Lists of values may need to be quoted in some contexts
> (eg. shells or editor config files).
> For example, with `spaces_before_comment=5`:
```python
1 + 1 # Adding values
```
> will be formatted as:
```python
1 + 1 # Adding values <-- 5 spaces between the end of the statement and comment
```
> with `spaces_before_comment="15, 20"`:
```python
1 + 1 # Adding values
two + two # More adding
longer_statement # This is a longer statement
short # This is a shorter statement
a_very_long_statement_that_extends_beyond_the_final_column # Comment
short # This is a shorter statement
```
> will be formatted as:
```python
1 + 1 # Adding values <-- end of line comments in block aligned to col 15
two + two # More adding
longer_statement # This is a longer statement <-- end of line comments in block aligned to col 20
short # This is a shorter statement
a_very_long_statement_that_extends_beyond_the_final_column # Comment <-- the end of line comments are aligned based on the line length
short # This is a shorter statement
```
#### `SPLIT_ALL_COMMA_SEPARATED_VALUES`
> If a comma separated list (`dict`, `list`, `tuple`, or function `def`) is
> on a line that is too long, split such that each element is on a separate
> line.
#### `SPLIT_ALL_TOP_LEVEL_COMMA_SEPARATED_VALUES`
> Variation on `SPLIT_ALL_COMMA_SEPARATED_VALUES` in which, if a
> subexpression with a comma fits in its starting line, then the
> subexpression is not split. This avoids splits like the one for
> `b` in this code:
```python
abcdef(
aReallyLongThing: int,
b: [Int,
Int])
```
> with the new knob this is split as:
```python
abcdef(
aReallyLongThing: int,
b: [Int, Int])
```
#### `SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED`
> Split before arguments if the argument list is terminated by a comma.
#### `SPLIT_BEFORE_ARITHMETIC_OPERATOR`
> Set to `True` to prefer splitting before `+`, `-`, `*`, `/`, `//`, or `@`
> rather than after.
#### `SPLIT_BEFORE_BITWISE_OPERATOR`
> Set to `True` to prefer splitting before `&`, `|` or `^` rather than after.
#### `SPLIT_BEFORE_CLOSING_BRACKET`
> Split before the closing bracket if a `list` or `dict` literal doesn't fit
> on a single line.
#### `SPLIT_BEFORE_DICT_SET_GENERATOR`
> Split before a dictionary or set generator (`comp_for`). For example, note
> the split before the `for`:
```python
foo = {
variable: 'Hello world, have a nice day!'
for variable in bar if variable != 42
}
```
#### `SPLIT_BEFORE_DOT`
> Split before the `.` if we need to split a longer expression:
```python
foo = ('This is a really long string: {}, {}, {}, {}'.format(a, b, c, d))
```
> would reformat to something like:
```python
foo = ('This is a really long string: {}, {}, {}, {}'
.format(a, b, c, d))
```
#### `SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN`
> Split after the opening paren which surrounds an expression if it doesn't
> fit on a single line.
#### `SPLIT_BEFORE_FIRST_ARGUMENT`
> If an argument / parameter list is going to be split, then split before the
> first argument.
#### `SPLIT_BEFORE_LOGICAL_OPERATOR`
> Set to `True` to prefer splitting before `and` or `or` rather than after.
#### `SPLIT_BEFORE_NAMED_ASSIGNS`
> Split named assignments onto individual lines.
#### `SPLIT_COMPLEX_COMPREHENSION`
> For list comprehensions and generator expressions with multiple clauses
> (e.g multiple `for` calls, `if` filter expressions) and which need to be
> reflowed, split each clause onto its own line. For example:
```python
result = [
a_var + b_var for a_var in xrange(1000) for b_var in xrange(1000)
if a_var % b_var]
```
> would reformat to something like:
```python
result = [
a_var + b_var
for a_var in xrange(1000)
for b_var in xrange(1000)
if a_var % b_var]
```
#### `SPLIT_PENALTY_AFTER_OPENING_BRACKET`
> The penalty for splitting right after the opening bracket.
#### `SPLIT_PENALTY_AFTER_UNARY_OPERATOR`
> The penalty for splitting the line after a unary operator.
#### `SPLIT_PENALTY_ARITHMETIC_OPERATOR`
> The penalty of splitting the line around the `+`, `-`, `*`, `/`, `//`, `%`,
> and `@` operators.
#### `SPLIT_PENALTY_BEFORE_IF_EXPR`
> The penalty for splitting right before an `if` expression.
#### `SPLIT_PENALTY_BITWISE_OPERATOR`
> The penalty of splitting the line around the `&`, `|`, and `^` operators.
#### `SPLIT_PENALTY_COMPREHENSION`
> The penalty for splitting a list comprehension or generator expression.
#### `SPLIT_PENALTY_EXCESS_CHARACTER`
> The penalty for characters over the column limit.
#### `SPLIT_PENALTY_FOR_ADDED_LINE_SPLIT`
> The penalty incurred by adding a line split to the logical line. The more
> line splits added the higher the penalty.
#### `SPLIT_PENALTY_IMPORT_NAMES`
> The penalty of splitting a list of `import as` names. For example:
```python
from a_very_long_or_indented_module_name_yada_yad import (long_argument_1,
long_argument_2,
long_argument_3)
```
> would reformat to something like:
```python
from a_very_long_or_indented_module_name_yada_yad import (
long_argument_1, long_argument_2, long_argument_3)
```
#### `SPLIT_PENALTY_LOGICAL_OPERATOR`
> The penalty of splitting the line around the `and` and `or` operators.
#### `USE_TABS`
> Use the Tab character for indentation.
## (Potentially) Frequently Asked Questions
### Why does YAPF destroy my awesome formatting?
YAPF tries very hard to get the formatting correct. But for some code, it won't
be as good as hand-formatting. In particular, large data literals may become
horribly disfigured under YAPF.
The reasons for this are manyfold. In short, YAPF is simply a tool to help
with development. It will format things to coincide with the style guide, but
that may not equate with readability.
What can be done to alleviate this situation is to indicate regions YAPF should
ignore when reformatting something:
```python
# yapf: disable
FOO = {
# ... some very large, complex data literal.
}
BAR = [
# ... another large data literal.
]
# yapf: enable
```
You can also disable formatting for a single literal like this:
```python
BAZ = {
(1, 2, 3, 4),
(5, 6, 7, 8),
(9, 10, 11, 12),
} # yapf: disable
```
To preserve the nice dedented closing brackets, use the
`dedent_closing_brackets` in your style. Note that in this case all
brackets, including function definitions and calls, are going to use
that style. This provides consistency across the formatted codebase.
### Why Not Improve Existing Tools?
We wanted to use clang-format's reformatting algorithm. It's very powerful and
designed to come up with the best formatting possible. Existing tools were
created with different goals in mind, and would require extensive modifications
to convert to using clang-format's algorithm.
### Can I Use YAPF In My Program?
Please do! YAPF was designed to be used as a library as well as a command line
tool. This means that a tool or IDE plugin is free to use YAPF.
### I still get non-PEP8 compliant code! Why?
YAPF tries very hard to be fully PEP 8 compliant. However, it is paramount
to not risk altering the semantics of your code. Thus, YAPF tries to be as
safe as possible and does not change the token stream
(e.g., by adding parentheses).
All these cases however, can be easily fixed manually. For instance,
```python
from my_package import my_function_1, my_function_2, my_function_3, my_function_4, my_function_5
FOO = my_variable_1 + my_variable_2 + my_variable_3 + my_variable_4 + my_variable_5 + my_variable_6 + my_variable_7 + my_variable_8
```
won't be split, but you can easily get it right by just adding parentheses:
```python
from my_package import (my_function_1, my_function_2, my_function_3,
my_function_4, my_function_5)
FOO = (my_variable_1 + my_variable_2 + my_variable_3 + my_variable_4 +
my_variable_5 + my_variable_6 + my_variable_7 + my_variable_8)
```
## Gory Details
### Algorithm Design
The main data structure in YAPF is the `LogicalLine` object. It holds a list
of `FormatToken`\s, that we would want to place on a single line if there
were no column limit. An exception being a comment in the middle of an
expression statement will force the line to be formatted on more than one line.
The formatter works on one `LogicalLine` object at a time.
An `LogicalLine` typically won't affect the formatting of lines before or
after it. There is a part of the algorithm that may join two or more
`LogicalLine`\s into one line. For instance, an if-then statement with a
short body can be placed on a single line:
```python
if a == 42: continue
```
YAPF's formatting algorithm creates a weighted tree that acts as the solution
space for the algorithm. Each node in the tree represents the result of a
formatting decision --- i.e., whether to split or not to split before a token.
Each formatting decision has a cost associated with it. Therefore, the cost is
realized on the edge between two nodes. (In reality, the weighted tree doesn't
have separate edge objects, so the cost resides on the nodes themselves.)
For example, take the following Python code snippet. For the sake of this
example, assume that line (1) violates the column limit restriction and needs to
be reformatted.
```python
def xxxxxxxxxxx(aaaaaaaaaaaa, bbbbbbbbb, cccccccc, dddddddd, eeeeee): # 1
pass # 2
```
For line (1), the algorithm will build a tree where each node (a
`FormattingDecisionState` object) is the state of the line at that token given
the decision to split before the token or not. Note: the `FormatDecisionState`
objects are copied by value so each node in the graph is unique and a change in
one doesn't affect other nodes.
Heuristics are used to determine the costs of splitting or not splitting.
Because a node holds the state of the tree up to a token's insertion, it can
easily determine if a splitting decision will violate one of the style
requirements. For instance, the heuristic is able to apply an extra penalty to
the edge when not splitting between the previous token and the one being added.
There are some instances where we will never want to split the line, because
doing so will always be detrimental (i.e., it will require a backslash-newline,
which is very rarely desirable). For line (1), we will never want to split the
first three tokens: `def`, `xxxxxxxxxxx`, and `(`. Nor will we want to
split between the `)` and the `:` at the end. These regions are said to be
"unbreakable." This is reflected in the tree by there not being a "split"
decision (left hand branch) within the unbreakable region.
Now that we have the tree, we determine what the "best" formatting is by finding
the path through the tree with the lowest cost.
And that's it!
Reference in a new issue View git blame Copy permalink