bucket_48/python-yapf

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-yapf
   4 VERSION=                0.23.0
   5 KEYWORDS=               python devel
   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)
  10 HOMEPAGE=               none
  11 CONTACT=                Python_Automaton[python@ironwolf.systems]
  12
  13 DOWNLOAD_GROUPS=        main
  14 SITES[main]=            PYPI/y/yapf
  15 DISTFILE[1]=            yapf-0.23.0.tar.gz:main
  16 DF_INDEX=               1
  17 SPKGS[py36]=            single
  18 SPKGS[py37]=            single
  19 SPKGS[py27]=            single
  20
  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
  26
  27 DISTNAME=               yapf-0.23.0
  28
  29 GENERATED=              yes
  30
  31 [PY36].USES_ON=                         python:py36
  32
  33 [PY37].USES_ON=                         python:py37
  34
  35 [PY27].USES_ON=                         python:py27
  36
  37 [FILE:3115:descriptions/desc.single]
  38 ====
  39 YAPF
  40 ====
  41
  42 .. image:: https://badge.fury.io/py/yapf.svg
  43     :target: https://badge.fury.io/py/yapf
  44     :alt: PyPI version
  45
  46 .. image:: https://travis-ci.org/google/yapf.svg?branch=master
  47     :target: https://travis-ci.org/google/yapf
  48     :alt: Build status
  49
  50 .. image:: https://coveralls.io/repos/google/yapf/badge.svg?branch=master
  51     :target: https://coveralls.io/r/google/yapf?branch=master
  52     :alt: Coverage status
  53
  54
  55 Introduction
  56 ============
  57
  58 Most of the current formatters for Python --- e.g., autopep8, and pep8ify
  59 ---
  60 are made to remove lint errors from code. This has some obvious
  61 limitations.
  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.
  64
  65 YAPF takes a different approach. It's based off of 'clang-format',
  66 developed by
  67 Daniel Jasper. In essence, the algorithm takes the code and reformats it
  68 to the
  69 best formatting that conforms to the style guide, even if the original code
  70 didn't violate the style guide. The idea is also similar to the 'gofmt'
  71 tool for
  72 the Go programming language: end all holy wars about formatting - if the
  73 whole
  74 codebase of a project is simply piped through YAPF whenever modifications
  75 are
  76 made, the style remains consistent throughout the project and there's no
  77 point
  78 arguing about style in every code review.
  79
  80 The ultimate goal is that the code YAPF produces is as good as the code
  81 that a
  82 programmer would write if they were following the style guide. It takes
  83 away
  84 some of the drudgery of maintaining your code.
  85
  86 Try out YAPF with this `online demo <https://yapf.now.sh>`_.
  87
  88 .. footer::
  89
  90     YAPF is not an official Google product (experimental or otherwise), it
  91 is
  92     just code that happens to be owned by Google.
  93
  94 .. contents::
  95
  96
  97 Installation
  98 ============
  99
 100 To install YAPF from PyPI:
 101
 102 .. code-block:: shell
 103
 104     $ pip install yapf
 105
 106 (optional) If you are using Python 2.7 and want to enable multiprocessing:
 107
 108 .. code-block:: shell
 109
 110     $ pip install futures
 111
 112 YAPF is still considered in "alpha" stage, and the released version may
 113 change
 114 often; therefore, the best way to keep up-to-date with the latest
 115 development
 116 is to clone this repository.
 117
 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
 120 directory
 121 by the Python interpreter. If you cloned/unzipped YAPF into ``DIR``, it's
 122 possible to run:
 123
 124 .. code-block:: shell
 125
 126     $ PYTHONPATH=DIR python DIR/yapf [options] ...
 127
 128
 129 Python versions
 130 ===============
 131
 132 YAPF supports Python 2.7 and 3.6.4+. (Note that some Python 3 features may
 133 fail
 134 to parse with Python versions before 3.6.4.)
 135
 136 YAPF requires the code it formats to be valid Python for the version YAPF
 137 itself
 138 runs under. Therefore, if you format Python 3 code with YAPF, run YAPF
 139 itself
 140 under Python 3 (and similarly for Python 2).
 141
 142
 143 Usage
 144 =====
 145
 146 Options::
 147
 148     usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
 149                 [--style STYLE] [--style-help] [--no-local-style] [-p]
 150                 [-vv]
 151                 [files [files ...]]
 152
 153     Formatter for Python code.
 154
 155
 156
 157 [FILE:97:distinfo]
 158 330632d2592e67571ef2c113fe6f5802e2fa5d657448755d5546eea00693dc31       159301 yapf-0.23.0.tar.gz
 159