1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
6 VARIANTS= py27 py36 py37
7 SDESC[py36]= Formatter for Python code (PY 36)
8 SDESC[py37]= Formatter for Python code (PY 37)
9 SDESC[py27]= Formatter for Python code (PY 27)
11 CONTACT= Python_Automaton[python@ironwolf.systems]
14 SITES[main]= PYPI/y/yapf
15 DISTFILE[1]= yapf-0.28.0.tar.gz:main
21 OPTIONS_AVAILABLE= PY27 PY36 PY37
22 OPTIONS_STANDARD= none
23 VOPTS[py36]= PY27=OFF PY36=ON PY37=OFF
24 VOPTS[py37]= PY27=OFF PY36=OFF PY37=ON
25 VOPTS[py27]= PY27=ON PY36=OFF PY37=OFF
31 [PY36].USES_ON= python:py36
33 [PY37].USES_ON= python:py37
35 [PY27].USES_ON= python:py27
37 [FILE:3201:descriptions/desc.single]
42 .. image:: https://badge.fury.io/py/yapf.svg
43 :target: https://badge.fury.io/py/yapf
46 .. image:: https://travis-ci.org/google/yapf.svg?branch=master
47 :target: https://travis-ci.org/google/yapf
50 .. image:: https://coveralls.io/repos/google/yapf/badge.svg?branch=master
51 :target: https://coveralls.io/r/google/yapf?branch=master
58 Most of the current formatters for Python --- e.g., autopep8, and pep8ify
60 are made to remove lint errors from code. This has some obvious
62 For instance, code that conforms to the PEP 8 guidelines may not be
63 reformatted. But it doesn't mean that the code looks good.
65 YAPF takes a different approach. It's based off of `'clang-format'
67 ang.llvm.org/docs/ClangFormat.html>`_, developed by Daniel Jasper. In
69 the algorithm takes the code and reformats it to the best formatting that
70 conforms to the style guide, even if the original code didn't violate the
71 style guide. The idea is also similar to the `'gofmt'
72 <https://golang.org/cmd/
73 gofmt/>`_ tool for the Go programming language: end all holy wars about
74 formatting - if the whole codebase of a project is simply piped through
76 whenever modifications are made, the style remains consistent throughout
78 project and there's no point arguing about style in every code review.
80 The ultimate goal is that the code YAPF produces is as good as the code
82 programmer would write if they were following the style guide. It takes
84 some of the drudgery of maintaining your code.
86 Try out YAPF with this `online demo <https://yapf.now.sh>`_.
90 YAPF is not an official Google product (experimental or otherwise), it
92 just code that happens to be owned by Google.
100 To install YAPF from PyPI:
102 .. code-block:: shell
106 (optional) If you are using Python 2.7 and want to enable multiprocessing:
108 .. code-block:: shell
110 $ pip install futures
112 YAPF is still considered in "alpha" stage, and the released version may
114 often; therefore, the best way to keep up-to-date with the latest
116 is to clone this repository.
118 Note that if you intend to use YAPF as a command-line tool rather than as a
119 library, installation is not necessary. YAPF supports being run as a
121 by the Python interpreter. If you cloned/unzipped YAPF into ``DIR``, it's
124 .. code-block:: shell
126 $ PYTHONPATH=DIR python DIR/yapf [options] ...
132 YAPF supports Python 2.7 and 3.6.4+. (Note that some Python 3 features may
134 to parse with Python versions before 3.6.4.)
136 YAPF requires the code it formats to be valid Python for the version YAPF
138 runs under. Therefore, if you format Python 3 code with YAPF, run YAPF
140 under Python 3 (and similarly for Python 2).
148 usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
149 [--style STYLE] [--style-help] [--no-local-style] [-p]
153 Formatter for Python code.
157 6f94b6a176a7c114cfa6bad86d40f259bbe0f10cf2fa7f2f4b3596fc5802a41b 177316 yapf-0.28.0.tar.gz