Ravenports generated: 28 Feb 2022 02:23
[ravenports.git] / bucket_48 / python-yapf
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-yapf
4 VERSION=                0.32.0
5 KEYWORDS=               python
6 VARIANTS=               py39 py310
7 SDESC[py310]=           Formatter for Python code (3.10)
8 SDESC[py39]=            Formatter for Python code (3.9)
9 HOMEPAGE=               none
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/47/88/843c2e68f18a5879b4fbf37cb99fbabe1ffc4343b2e63191c8462235c008
14 DISTFILE[1]=            yapf-0.32.0-py2.py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[py310]=           single
17 SPKGS[py39]=            single
18
19 OPTIONS_AVAILABLE=      PY39 PY310
20 OPTIONS_STANDARD=       none
21 VOPTS[py310]=           PY39=OFF PY310=ON
22 VOPTS[py39]=            PY39=ON PY310=OFF
23
24 DISTNAME=               yapf-0.32.0.dist-info
25
26 GENERATED=              yes
27
28 [PY39].USES_ON=                         python:py39,wheel
29
30 [PY310].USES_ON=                        python:py310,wheel
31
32 [FILE:2695:descriptions/desc.single]
33 ====
34 YAPF
35 ====
36
37     :alt: PyPI version
38
39     :alt: Build status
40
41     :alt: Coverage status
42
43 Introduction
44 ============
45
46 Most of the current formatters for Python --- e.g., autopep8, and pep8ify
47 ---
48 are made to remove lint errors from code. This has some obvious
49 limitations.
50 For instance, code that conforms to the PEP 8 guidelines may not be
51 reformatted.  But it doesn't mean that the code looks good.
52
53 YAPF takes a different approach. It's based off of `'clang-format'
54 <https://cl
55 ang.llvm.org/docs/ClangFormat.html>`_, developed by Daniel Jasper. In
56 essence,
57 the algorithm takes the code and reformats it to the best formatting that
58 conforms to the style guide, even if the original code didn't violate the
59 style guide. The idea is also similar to the ['gofmt'] tool for the Go
60 programming language: end all holy wars about
61 formatting - if the whole codebase of a project is simply piped through
62 YAPF
63 whenever modifications are made, the style remains consistent throughout
64 the
65 project and there's no point arguing about style in every code review.
66
67 The ultimate goal is that the code YAPF produces is as good as the code
68 that a
69 programmer would write if they were following the style guide. It takes
70 away
71 some of the drudgery of maintaining your code.
72
73 .. footer::
74
75     YAPF is not an official Google product (experimental or otherwise), it
76 is
77     just code that happens to be owned by Google.
78
79 .. contents::
80
81 Installation
82 ============
83
84 To install YAPF from PyPI:
85
86 .. code-block:: shell
87
88     $ pip install yapf
89
90 (optional) If you are using Python 2.7 and want to enable multiprocessing:
91
92 .. code-block:: shell
93
94     $ pip install futures
95
96 YAPF is still considered in "alpha" stage, and the released version may
97 change
98 often; therefore, the best way to keep up-to-date with the latest
99 development
100 is to clone this repository.
101
102 Note that if you intend to use YAPF as a command-line tool rather than as a
103 library, installation is not necessary. YAPF supports being run as a
104 directory
105 by the Python interpreter. If you cloned/unzipped YAPF into DIR, it's
106 possible to run:
107
108 .. code-block:: shell
109
110     $ PYTHONPATH=DIR python DIR/yapf [options] ...
111
112 Python versions
113 ===============
114
115 YAPF supports Python 2.7 and 3.6.4+. (Note that some Python 3 features may
116 fail
117 to parse with Python versions before 3.6.4.)
118
119 YAPF requires the code it formats to be valid Python for the version YAPF
120 itself
121 runs under. Therefore, if you format Python 3 code with YAPF, run YAPF
122 itself
123 under Python 3 (and similarly for Python 2).
124
125 Usage
126 =====
127
128 Options::
129
130     usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
131                 [--style STYLE] [--style-help] [--no-local-style] [-p]
132                 [-vv]
133
134
135 [FILE:111:distinfo]
136 8fea849025584e486fd06d6ba2bed717f396080fd3cc236ba10cb97c4c51cf32       190236 yapf-0.32.0-py2.py3-none-any.whl
137