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