/
python-yapf
143 lines (112 loc) · 4.27 KB
/
python-yapf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# Buildsheet autogenerated by ravenadm tool -- Do not edit.
NAMEBASE= python-yapf
VERSION= 0.40.2
KEYWORDS= python
VARIANTS= v11 v12
SDESC[v11]= Formatter for Python code (3.11)
SDESC[v12]= Formatter for Python code (3.12)
HOMEPAGE= none
CONTACT= Python_Automaton[python@ironwolf.systems]
DOWNLOAD_GROUPS= main
SITES[main]= PYPIWHL/66/c9/d4b03b2490107f13ebd68fe9496d41ae41a7de6275ead56d0d4621b11ffd
DISTFILE[1]= yapf-0.40.2-py3-none-any.whl:main
DF_INDEX= 1
SPKGS[v11]= single
SPKGS[v12]= single
OPTIONS_AVAILABLE= PY311 PY312
OPTIONS_STANDARD= none
VOPTS[v11]= PY311=ON PY312=OFF
VOPTS[v12]= PY311=OFF PY312=ON
DISTNAME= yapf-0.40.2.dist-info
GENERATED= yes
[PY311].RUN_DEPENDS_ON= python-importlib-metadata:single:v11
python-platformdirs:single:v11
python-tomli:single:v11
[PY311].USES_ON= python:v11,wheel
[PY312].RUN_DEPENDS_ON= python-importlib-metadata:single:v12
python-platformdirs:single:v12
python-tomli:single:v12
[PY312].USES_ON= python:v12,wheel
[FILE:3197:descriptions/desc.single]
# YAPF
<p align="center">
[image]
[image]
[image]
[image]
</p>
## 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
[FILE:107:distinfo]
adc8b5dd02c0143108878c499284205adb258aad6db6634e5b869e7ee2bd548b 254707 yapf-0.40.2-py3-none-any.whl