bucket_48/python-yapf

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-yapf
   4 VERSION=                0.40.1
   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/23/75/c374517c09e31bf22d3b3f156d73e0f38d08e29b2afdd607cef5f1e10aa9
  14 DISTFILE[1]=            yapf-0.40.1-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.40.1.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-importlib-metadata:single:py310
  29                                         python-platformdirs:single:py310
  30                                         python-tomli:single:py310
  31 [PY310].USES_ON=                        python:py310,wheel
  32
  33 [PY311].RUN_DEPENDS_ON=                 python-importlib-metadata:single:v11
  34                                         python-platformdirs:single:v11
  35                                         python-tomli:single:v11
  36 [PY311].USES_ON=                        python:v11,wheel
  37
  38 [FILE:2624:descriptions/desc.single]
  39 ====
  40 YAPF
  41 ====
  42
  43     :alt: PyPI version
  44
  45     :alt: Build status
  46
  47     :alt: Run pre-commit
  48
  49     :alt: Coverage status
  50
  51 Introduction
  52 ============
  53
  54 Most of the current formatters for Python --- e.g., autopep8, and pep8ify
  55 ---
  56 are made to remove lint errors from code. This has some obvious
  57 limitations.
  58 For instance, code that conforms to the PEP 8 guidelines may not be
  59 reformatted.  But it doesn't mean that the code looks good.
  60
  61 YAPF takes a different approach. It's based off of `'clang-format'
  62 <https://cl
  63 ang.llvm.org/docs/ClangFormat.html>`_, developed by Daniel Jasper. In
  64 essence,
  65 the algorithm takes the code and reformats it to the best formatting that
  66 conforms to the style guide, even if the original code didn't violate the
  67 style guide. The idea is also similar to the ['gofmt'] tool for the Go
  68 programming language: end all holy wars about
  69 formatting - if the whole codebase of a project is simply piped through
  70 YAPF
  71 whenever modifications are made, the style remains consistent throughout
  72 the
  73 project and there's no point arguing about style in every code review.
  74
  75 The ultimate goal is that the code YAPF produces is as good as the code
  76 that a
  77 programmer would write if they were following the style guide. It takes
  78 away
  79 some of the drudgery of maintaining your code.
  80
  81 .. footer::
  82
  83     YAPF is not an official Google product (experimental or otherwise), it
  84 is
  85     just code that happens to be owned by Google.
  86
  87 .. contents::
  88
  89 Installation
  90 ============
  91
  92 To install YAPF from PyPI:
  93
  94 .. code-block:: shell
  95
  96     $ pip install yapf
  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     positional arguments:
 136       files                 reads from stdin when no files are specified.
 137
 138     optional arguments:
 139
 140
 141 [FILE:107:distinfo]
 142 b8bfc1f280949153e795181768ca14ef43d7312629a06c43e7abd279323af313       250316 yapf-0.40.1-py3-none-any.whl
 143