Port variant | v12 |
Summary | Formatter for Python code (3.12) |
BROKEN | |
Package version | 0.40.2 |
Homepage | No known homepage |
Keywords | python |
Maintainer | Python Automaton |
License | Not yet specified |
Other variants | v11 |
Ravenports | Buildsheet | History |
Ravensource | Port Directory | History |
Last modified | 10 OCT 2023, 04:40:21 UTC |
Port created | 17 JUL 2017, 16:13:54 UTC |
single | # YAPF
[image] [image] [image] [image] ## Introduction YAPF is a Python formatter based off of [`clang-format`] (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. 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] ... ``` ## Required Python versions YAPF supports Python 3.7+. > **Note** > YAPF requires the code it formats to be valid Python for the version YAPF > itself runs under. ## 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 ``` ### Using YAPF within your favorite editor |
Build (only) |
python312:dev:std python-pip:single:v12 autoselect-python:single:std |
Build and Runtime | python312:primary:std |
Runtime (only) |
python-importlib-metadata:single:v12 python-platformdirs:single:v12 python-tomli:single:v12 |
main | mirror://PYPIWHL/66/c9/d4b03b2490107f13ebd68fe9496d41ae41a7de6275ead56d0d4621b11ffd |
No other ports depend on this one. |