Commit 611737f9 authored by Łukasz Langa's avatar Łukasz Langa
Browse files

Big documentation deduplication

Most is not generated from README.md so we no longer have to remember to update
two Change Logs, and so on!

If we decide to diverge from the README in Sphinx, that's fine, too. We will
just create dedicated documents.
parent 5c6a0dd0
Loading
Loading
Loading
Loading
+70 −37
Changes for README.md: 70 added lines, 37 removed lines.
Original line number Diff line number Diff line
@@ -27,33 +27,28 @@ content instead.
possible.


## NOTE: This is an early pre-release
## Installation and Usage

*Black* can already successfully format itself and the standard library.
It also sports a decent test suite.  However, it is still very new.
Things will probably be wonky for a while. This is made explicit by the
"Alpha" trove classifier, as well as by the "a" in the version number.
What this means for you is that **until the formatter becomes stable,
you should expect some formatting to change in the future**.

Also, as a temporary safety measure, *Black* will check that the
reformatted code still produces a valid AST that is equivalent to the
original.  This slows it down.  If you're feeling confident, use
``--fast``.


## Installation
### Installation

*Black* can be installed by running `pip install black`.  It requires
Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
*Black* is able to parse all of the new syntax supported on Python 3.6
but also *effectively all* the Python 2 syntax at the same time.


## Usage
### Usage

To get started right away with sensible defaults:

```
black {source_file_or_directory}
```

### Command line options

Black doesn't provide many options.  You can list them by running
`black --help`:

```text
black [OPTIONS] [SRC]...

Options:
@@ -78,7 +73,22 @@ Options:
  used).


## The philosophy behind *Black*
### NOTE: This is an early pre-release

*Black* can already successfully format itself and the standard library.
It also sports a decent test suite.  However, it is still very new.
Things will probably be wonky for a while. This is made explicit by the
"Alpha" trove classifier, as well as by the "a" in the version number.
What this means for you is that **until the formatter becomes stable,
you should expect some formatting to change in the future**.

Also, as a temporary safety measure, *Black* will check that the
reformatted code still produces a valid AST that is equivalent to the
original.  This slows it down.  If you're feeling confident, use
``--fast``.


## The *Black* code style

*Black* reformats entire files in place.  It is not configurable.  It
doesn't take previous formatting into account.  It doesn't reformat
@@ -87,12 +97,13 @@ recognizes [YAPF](https://github.com/google/yapf)'s block comments to
the same effect, as a courtesy for straddling code.


### How *Black* formats files
### How *Black* wraps lines

*Black* ignores previous formatting and applies uniform horizontal
and vertical whitespace to your code.  The rules for horizontal
whitespace are pretty obvious and can be summarized as: do whatever
makes `pycodestyle` happy.
makes `pycodestyle` happy.  The coding style used by *Black* can be
viewed as a strict subset of PEP 8.

As for vertical whitespace, *Black* tries to render one full expression
or simple statement per line.  If this fits the allotted line length,
@@ -160,20 +171,6 @@ between two distinct sections of the code that otherwise share the same
indentation level (like the arguments list and the docstring in the
example above).

Unnecessary trailing commas are removed if an expression fits in one
line.  This makes it 1% more likely that your line won't exceed the
allotted line length limit.

*Black* avoids spurious vertical whitespace.  This is in the spirit of
PEP 8 which says that in-function vertical whitespace should only be
used sparingly.  One exception is control flow statements: *Black* will
always emit an extra empty line after ``return``, ``raise``, ``break``,
``continue``, and ``yield``.  This is to make changes in control flow
more prominent to readers of your code.

That's it.  The rest of the whitespace formatting rules follow PEP 8 and
are designed to keep `pycodestyle` quiet.


### Line length

@@ -214,6 +211,13 @@ bother you if you overdo it by a few km/h".

### Empty lines

*Black* avoids spurious vertical whitespace.  This is in the spirit of
PEP 8 which says that in-function vertical whitespace should only be
used sparingly.  One exception is control flow statements: *Black* will
always emit an extra empty line after ``return``, ``raise``, ``break``,
``continue``, and ``yield``.  This is to make changes in control flow
more prominent to readers of your code.

*Black* will allow single empty lines left by the original editors,
except when they're added within parenthesized expressions.  Since such
expressions are always reformatted to fit minimal space, this whitespace
@@ -228,7 +232,36 @@ entire function, use a docstring or put a leading comment in the function
body.


### Editor integration
### Trailing commas

*Black* will add trailing commas to expressions that are split
by comma where each element is on its own line.  This includes function
signatures.

Unnecessary trailing commas are removed if an expression fits in one
line.  This makes it 1% more likely that your line won't exceed the
allotted line length limit.  Moreover, in this scenario, if you added
another argument to your call, you'd probably fit it in the same line
anyway.  That doesn't make diffs any larger.

One exception to removing trailing commas is tuple expressions with
just one element.  In this case *Black* won't touch the single trailing
comma as this would unexpectedly change the underlying data type.  Note
that this is also the case when commas are used while indexing.  This is
a tuple in disguise: ```numpy_array[3, ]```.

One exception to adding trailing commas is function signatures
containing `*`, `*args`, or `**kwargs`.  In this case a trailing comma
is only safe to use on Python 3.6.  *Black* will detect if your file is
already 3.6+ only and use trailing commas in this situation.  If you
wonder how it knows, it looks for f-strings and existing use of trailing
commas in function signatures that have stars in them.  In other words,
if you'd like a trailing comma in this situation and *Black* didn't
recognize it was safe to do so, put it there manually and *Black* will
keep it.


## Editor integration

* Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode)
* Emacs: [proofit404/blacken](https://github.com/proofit404/blacken)
@@ -282,7 +315,7 @@ Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style
MIT


## Contributing
## Contributing to Black

In terms of inspiration, *Black* is about as configurable as *gofmt* and
*rustfmt* are.  This is deliberate.

docs/authors.md

0 → 120000
+1 −0
Changes for docs/authors.md: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/authors.md
 No newline at end of file

docs/change_log.md

0 → 120000
+1 −0
Changes for docs/change_log.md: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/change_log.md
 No newline at end of file

docs/changelog.md

deleted100644 → 0
+0 −93
Changes for docs/changelog.md: 0 added lines, 93 removed lines.
Original line number Diff line number Diff line
## Change Log

### 18.3a4

* `# fmt: off` and `# fmt: on` are implemented (#5)

* automatic detection of deprecated Python 2 forms of print statements
  and exec statements in the formatted file (#49)

* use proper spaces for complex expressions in default values of typed
  function arguments (#60)

* only return exit code 1 when --check is used (#50)

* don't remove single trailing commas from square bracket indexing
  (#59)

* don't omit whitespace if the previous factor leaf wasn't a math
  operator (#55)

* omit extra space in kwarg unpacking if it's the first argument (#46)

* omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
  (#68)


### 18.3a3

* don't remove single empty lines outside of bracketed expressions
  (#19)

* added ability to pipe formatting from stdin to stdin (#25)

* restored ability to format code with legacy usage of `async` as
  a name (#20, #42)

* even better handling of numpy-style array indexing (#33, again)


### 18.3a2

* changed positioning of binary operators to occur at beginning of lines
  instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
  (#21)

* ignore empty bracket pairs while splitting. This avoids very weirdly
  looking formattings (#34, #35)

* remove a trailing comma if there is a single argument to a call

* if top level functions were separated by a comment, don't put four
  empty lines after the upper function

* fixed unstable formatting of newlines with imports

* fixed unintentional folding of post scriptum standalone comments
  into last statement if it was a simple statement (#18, #28)

* fixed missing space in numpy-style array indexing (#33)

* fixed spurious space after star-based unary expressions (#31)


### 18.3a1

* added `--check`

* only put trailing commas in function signatures and calls if it's
  safe to do so. If the file is Python 3.6+ it's always safe, otherwise
  only safe if there are no `*args` or `**kwargs` used in the signature
  or call. (#8)

* fixed invalid spacing of dots in relative imports (#6, #13)

* fixed invalid splitting after comma on unpacked variables in for-loops
  (#23)

* fixed spurious space in parenthesized set expressions (#7)

* fixed spurious space after opening parentheses and in default
  arguments (#14, #17)

* fixed spurious space after unary operators when the operand was
  a complex expression (#15)


### 18.3a0

* first published version, Happy 🍰 Day 2018!

* alpha quality

* date-versioned (see: https://calver.org/)
+44 −0
Changes for docs/conf.py: 44 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@
import ast
from pathlib import Path
import re
import shutil
import string

from recommonmark.parser import CommonMarkParser
@@ -40,6 +41,48 @@ def make_pypi_svg(version):
        f.write(svg)


def make_filename(line):
    non_letters = re.compile(r'[^a-z]+')
    filename = line[3:].rstrip().lower()
    filename = non_letters.sub('_', filename)
    if filename.startswith('_'):
        filename = filename[1:]
    if filename.endswith('_'):
        filename = filename[:-1]
    return filename + '.md'


def generate_sections_from_readme():
    target_dir = CURRENT_DIR / '_build' / 'generated'
    readme = CURRENT_DIR / '..' / 'README.md'
    shutil.rmtree(str(target_dir), ignore_errors=True)
    target_dir.mkdir(parents=True)

    output = None
    with open(str(readme), 'r', encoding='utf8') as f:
        for line in f:
            if line.startswith('## '):
                if output is not None:
                    output.close()
                filename = make_filename(line)
                output_path = CURRENT_DIR / filename
                if output_path.is_symlink() or output_path.is_file():
                    output_path.unlink()
                output_path.symlink_to(target_dir / filename)
                output = open(str(output_path), 'w', encoding='utf8')
                output.write(
                    '[//]: # (NOTE: THIS FILE IS AUTOGENERATED FROM README.md)\n\n'
                )

            if output is None:
                continue

            if line.startswith('##'):
                line = line[1:]

            output.write(line)


# -- Project information -----------------------------------------------------

project = 'Black'
@@ -54,6 +97,7 @@ def make_pypi_svg(version):
for sp in 'abcfr':
    version = version.split(sp)[0]
make_pypi_svg(release)
generate_sections_from_readme()


# -- General configuration ---------------------------------------------------
Loading