bucket_48/python-yapf

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-yapf
   4 VERSION=                0.30.0
   5 KEYWORDS=               python
   6 VARIANTS=               py38 py37
   7 SDESC[py37]=            Formatter for Python code (PY37)
   8 SDESC[py38]=            Formatter for Python code (PY38)
   9 HOMEPAGE=               none
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/c1/5d/d84677fe852bc5e091739acda444a9b6700ffc6b11a21b00dd244c8caef0
  14 DISTFILE[1]=            yapf-0.30.0-py2.py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py37]=            single
  17 SPKGS[py38]=            single
  18
  19 OPTIONS_AVAILABLE=      PY38 PY37
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py37]=            PY38=OFF PY37=ON
  22 VOPTS[py38]=            PY38=ON PY37=OFF
  23
  24 DISTNAME=               yapf-0.30.0.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY37].BUILD_DEPENDS_ON=                python-pip:single:py37
  29 [PY37].USES_ON=                         python:py37,wheel
  30
  31 [PY38].BUILD_DEPENDS_ON=                python-pip:single:py38
  32 [PY38].USES_ON=                         python:py38,wheel
  33
  34 [FILE:2641: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 Try out YAPF with this [online demo].
  76
  77 .. footer::
  78
  79     YAPF is not an official Google product (experimental or otherwise), it
  80 is
  81     just code that happens to be owned by Google.
  82
  83 .. contents::
  84
  85 Installation
  86 ============
  87
  88 To install YAPF from PyPI:
  89
  90 .. code-block:: shell
  91
  92     $ pip install yapf
  93
  94 (optional) If you are using Python 2.7 and want to enable multiprocessing:
  95
  96 .. code-block:: shell
  97
  98     $ pip install futures
  99
 100 YAPF is still considered in "alpha" stage, and the released version may
 101 change
 102 often; therefore, the best way to keep up-to-date with the latest
 103 development
 104 is to clone this repository.
 105
 106 Note that if you intend to use YAPF as a command-line tool rather than as a
 107 library, installation is not necessary. YAPF supports being run as a
 108 directory
 109 by the Python interpreter. If you cloned/unzipped YAPF into DIR, it's
 110 possible to run:
 111
 112 .. code-block:: shell
 113
 114     $ PYTHONPATH=DIR python DIR/yapf [options] ...
 115
 116 Python versions
 117 ===============
 118
 119 YAPF supports Python 2.7 and 3.6.4+. (Note that some Python 3 features may
 120 fail
 121 to parse with Python versions before 3.6.4.)
 122
 123 YAPF requires the code it formats to be valid Python for the version YAPF
 124 itself
 125 runs under. Therefore, if you format Python 3 code with YAPF, run YAPF
 126 itself
 127 under Python 3 (and similarly for Python 2).
 128
 129 Usage
 130 =====
 131
 132 Options::
 133
 134     usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
 135
 136
 137 [FILE:111:distinfo]
 138 3abf61ba67cf603069710d30acbc88cfe565d907e16ad81429ae90ce9651e0c9       190268 yapf-0.30.0-py2.py3-none-any.whl
 139