]> git.madduck.net Git - etc/vim.git/blob - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

2ce91bb26cb6854a0be40012666b3a3de2887459
[etc/vim.git] / README.md
1 ![Black Logo](https://raw.githubusercontent.com/ambv/black/master/docs/_static/logo2-readme.png)
2 <h2 align="center">The Uncompromising Code Formatter</h2>
3
4 <p align="center">
5 <a href="https://travis-ci.org/ambv/black"><img alt="Build Status" src="https://travis-ci.org/ambv/black.svg?branch=master"></a>
6 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
7 <a href="https://coveralls.io/github/ambv/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/ambv/black/badge.svg?branch=master"></a>
8 <a href="https://github.com/ambv/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
9 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
10 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
11 <a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
12 </p>
13
14 > “Any color you like.”
15
16
17 *Black* is the uncompromising Python code formatter.  By using it, you
18 agree to cede control over minutiae of hand-formatting.  In return,
19 *Black* gives you speed, determinism, and freedom from `pycodestyle`
20 nagging about formatting.  You will save time and mental energy for
21 more important matters.
22
23 Blackened code looks the same regardless of the project you're reading.
24 Formatting becomes transparent after a while and you can focus on the
25 content instead.
26
27 *Black* makes code review faster by producing the smallest diffs
28 possible.
29
30 Try it out now using the [Black Playground](https://black.now.sh).
31
32 ---
33
34 *Contents:* **[Installation and usage](#installation-and-usage)** |
35 **[Code style](#the-black-code-style)** |
36 **[pyproject.toml](#pyprojecttoml)** |
37 **[Editor integration](#editor-integration)** |
38 **[blackd](#blackd)** |
39 **[Version control integration](#version-control-integration)** |
40 **[Ignoring unmodified files](#ignoring-unmodified-files)** |
41 **[Testimonials](#testimonials)** |
42 **[Show your style](#show-your-style)** |
43 **[Contributing](#contributing-to-black)** |
44 **[Change Log](#change-log)** |
45 **[Authors](#authors)**
46
47 ---
48
49 ## Installation and usage
50
51 ### Installation
52
53 *Black* can be installed by running `pip install black`.  It requires
54 Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
55
56
57 ### Usage
58
59 To get started right away with sensible defaults:
60
61 ```
62 black {source_file_or_directory}
63 ```
64
65 ### Command line options
66
67 *Black* doesn't provide many options.  You can list them by running
68 `black --help`:
69
70 ```text
71 black [OPTIONS] [SRC]...
72
73 Options:
74   -l, --line-length INTEGER       How many characters per line to allow.
75                                   [default: 88]
76   -t, --target-version [pypy35|cpy27|cpy33|cpy34|cpy35|cpy36|cpy37|cpy38]
77                                   Python versions that should be supported by
78                                   Black's output. [default: per-file auto-
79                                   detection]
80   --py36                          Allow using Python 3.6-only syntax on all
81                                   input files.  This will put trailing commas
82                                   in function signatures and calls also after
83                                   *args and **kwargs.  [default: per-file
84                                   auto-detection]
85   --pyi                           Format all input files like typing stubs
86                                   regardless of file extension (useful when
87                                   piping source on standard input).
88   -S, --skip-string-normalization
89                                   Don't normalize string quotes or prefixes.
90   --check                         Don't write the files back, just return the
91                                   status.  Return code 0 means nothing would
92                                   change.  Return code 1 means some files
93                                   would be reformatted.  Return code 123 means
94                                   there was an internal error.
95   --diff                          Don't write the files back, just output a
96                                   diff for each file on stdout.
97   --fast / --safe                 If --fast given, skip temporary sanity
98                                   checks. [default: --safe]
99   --include TEXT                  A regular expression that matches files and
100                                   directories that should be included on
101                                   recursive searches.  An empty value means
102                                   all files are included regardless of the
103                                   name.  Use forward slashes for directories
104                                   on all platforms (Windows, too).  Exclusions
105                                   are calculated first, inclusions later.
106                                   [default: \.pyi?$]
107   --exclude TEXT                  A regular expression that matches files and
108                                   directories that should be excluded on
109                                   recursive searches.  An empty value means no
110                                   paths are excluded. Use forward slashes for
111                                   directories on all platforms (Windows, too).
112                                   Exclusions are calculated first, inclusions
113                                   later.  [default: /(\.eggs|\.git|\.hg|\.mypy
114                                   _cache|\.nox|\.tox|\.venv|_build|buck-
115                                   out|build|dist)/]
116   -q, --quiet                     Don't emit non-error messages to stderr.
117                                   Errors are still emitted, silence those with
118                                   2>/dev/null.
119   -v, --verbose                   Also emit messages to stderr about files
120                                   that were not changed or were ignored due to
121                                   --exclude=.
122   --version                       Show the version and exit.
123   --config PATH                   Read configuration from PATH.
124   -h, --help                      Show this message and exit.
125 ```
126
127 *Black* is a well-behaved Unix-style command-line tool:
128 * it does nothing if no sources are passed to it;
129 * it will read from standard input and write to standard output if `-`
130   is used as the filename;
131 * it only outputs messages to users on standard error;
132 * exits with code 0 unless an internal error occurred (or `--check` was
133   used).
134
135
136 ### NOTE: This is a beta product
137
138 *Black* is already successfully used by several projects, small and big.
139 It also sports a decent test suite.  However, it is still very new.
140 Things will probably be wonky for a while. This is made explicit by the
141 "Beta" trove classifier, as well as by the "b" in the version number.
142 What this means for you is that **until the formatter becomes stable,
143 you should expect some formatting to change in the future**.  That being
144 said, no drastic stylistic changes are planned, mostly responses to bug
145 reports.
146
147 Also, as a temporary safety measure, *Black* will check that the
148 reformatted code still produces a valid AST that is equivalent to the
149 original.  This slows it down.  If you're feeling confident, use
150 ``--fast``.
151
152
153 ## The *Black* code style
154
155 *Black* reformats entire files in place.  It is not configurable.  It
156 doesn't take previous formatting into account.  It doesn't reformat
157 blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off`
158 have to be on the same level of indentation. It also
159 recognizes [YAPF](https://github.com/google/yapf)'s block comments to
160 the same effect, as a courtesy for straddling code.
161
162
163 ### How *Black* wraps lines
164
165 *Black* ignores previous formatting and applies uniform horizontal
166 and vertical whitespace to your code.  The rules for horizontal
167 whitespace can be summarized as: do whatever makes `pycodestyle` happy.
168 The coding style used by *Black* can be viewed as a strict subset of
169 PEP 8.
170
171 As for vertical whitespace, *Black* tries to render one full expression
172 or simple statement per line.  If this fits the allotted line length,
173 great.
174 ```py3
175 # in:
176
177 l = [1,
178      2,
179      3,
180 ]
181
182 # out:
183
184 l = [1, 2, 3]
185 ```
186
187 If not, *Black* will look at the contents of the first outer matching
188 brackets and put that in a separate indented line.
189 ```py3
190 # in:
191
192 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
193
194 # out:
195
196 ImportantClass.important_method(
197     exc, limit, lookup_lines, capture_locals, extra_argument
198 )
199 ```
200
201 If that still doesn't fit the bill, it will decompose the internal
202 expression further using the same rule, indenting matching brackets
203 every time.  If the contents of the matching brackets pair are
204 comma-separated (like an argument list, or a dict literal, and so on)
205 then *Black* will first try to keep them on the same line with the
206 matching brackets.  If that doesn't work, it will put all of them in
207 separate lines.
208 ```py3
209 # in:
210
211 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
212     """Applies `variables` to the `template` and writes to `file`."""
213     with open(file, 'w') as f:
214         ...
215
216 # out:
217
218 def very_important_function(
219     template: str,
220     *variables,
221     file: os.PathLike,
222     engine: str, 
223     header: bool = True
224     debug: bool = False,
225 ):
226     """Applies `variables` to the `template` and writes to `file`."""
227     with open(file, "w") as f:
228         ...
229 ```
230
231 You might have noticed that closing brackets are always dedented and
232 that a trailing comma is always added.  Such formatting produces smaller
233 diffs; when you add or remove an element, it's always just one line.
234 Also, having the closing bracket dedented provides a clear delimiter
235 between two distinct sections of the code that otherwise share the same
236 indentation level (like the arguments list and the docstring in the
237 example above).
238
239 If a data structure literal (tuple, list, set, dict) or a line of "from"
240 imports cannot fit in the allotted length, it's always split into one
241 element per line.  This minimizes diffs as well as enables readers of
242 code to find which commit introduced a particular entry.  This also
243 makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
244 the following configuration.
245
246 <details>
247 <summary>A compatible `.isort.cfg`</summary>
248
249 ```
250 [settings]
251 multi_line_output=3
252 include_trailing_comma=True
253 force_grid_wrap=0
254 use_parentheses=True
255 line_length=88
256 ```
257
258 The equivalent command line is:
259 ```
260 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
261 ```
262 </details>
263
264 ### Line length
265
266 You probably noticed the peculiar default line length.  *Black* defaults
267 to 88 characters per line, which happens to be 10% over 80.  This number
268 was found to produce significantly shorter files than sticking with 80
269 (the most popular), or even 79 (used by the standard library).  In
270 general, [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
271
272 If you're paid by the line of code you write, you can pass
273 `--line-length` with a lower number.  *Black* will try to respect that.
274 However, sometimes it won't be able to without breaking other rules.  In
275 those rare cases, auto-formatted code will exceed your allotted limit.
276
277 You can also increase it, but remember that people with sight disabilities
278 find it harder to work with line lengths exceeding 100 characters.
279 It also adversely affects side-by-side diff review  on typical screen
280 resolutions.  Long lines also make it harder to present code neatly
281 in documentation or talk slides.
282
283 If you're using Flake8, you can bump `max-line-length` to 88 and forget
284 about it.  Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
285 B950 warning instead of E501 and keep the max line length at 80 which
286 you are probably already using.  You'd do it like this:
287 ```ini
288 [flake8]
289 max-line-length = 80
290 ...
291 select = C,E,F,W,B,B950
292 ignore = E501
293 ```
294
295 You'll find *Black*'s own .flake8 config file is configured like this.
296 If you're curious about the reasoning behind B950, 
297 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
298 explains it.  The tl;dr is "it's like highway speed limits, we won't
299 bother you if you overdo it by a few km/h".
300
301
302 ### Empty lines
303
304 *Black* avoids spurious vertical whitespace.  This is in the spirit of
305 PEP 8 which says that in-function vertical whitespace should only be
306 used sparingly.
307
308 *Black* will allow single empty lines inside functions, and single and
309 double empty lines on module level left by the original editors, except
310 when they're within parenthesized expressions.  Since such expressions
311 are always reformatted to fit minimal space, this whitespace is lost.
312
313 It will also insert proper spacing before and after function definitions.
314 It's one line before and after inner functions and two lines before and
315 after module-level functions and classes.  *Black* will not put empty
316 lines between function/class definitions and standalone comments that
317 immediately precede the given function/class.
318
319 *Black* will enforce single empty lines between a class-level docstring
320 and the first following field or method.  This conforms to
321 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
322
323 *Black* won't insert empty lines after function docstrings unless that
324 empty line is required due to an inner function starting immediately
325 after.
326
327
328 ### Trailing commas
329
330 *Black* will add trailing commas to expressions that are split
331 by comma where each element is on its own line.  This includes function
332 signatures.
333
334 Unnecessary trailing commas are removed if an expression fits in one
335 line.  This makes it 1% more likely that your line won't exceed the
336 allotted line length limit.  Moreover, in this scenario, if you added
337 another argument to your call, you'd probably fit it in the same line
338 anyway.  That doesn't make diffs any larger.
339
340 One exception to removing trailing commas is tuple expressions with
341 just one element.  In this case *Black* won't touch the single trailing
342 comma as this would unexpectedly change the underlying data type.  Note
343 that this is also the case when commas are used while indexing.  This is
344 a tuple in disguise: ```numpy_array[3, ]```.
345
346 One exception to adding trailing commas is function signatures
347 containing `*`, `*args`, or `**kwargs`.  In this case a trailing comma
348 is only safe to use on Python 3.6.  *Black* will detect if your file is
349 already 3.6+ only and use trailing commas in this situation.  If you
350 wonder how it knows, it looks for f-strings and existing use of trailing
351 commas in function signatures that have stars in them.  In other words,
352 if you'd like a trailing comma in this situation and *Black* didn't
353 recognize it was safe to do so, put it there manually and *Black* will
354 keep it.
355
356
357 ### Strings
358
359 *Black* prefers double quotes (`"` and `"""`) over single quotes (`'`
360 and `'''`).  It will replace the latter with the former as long as it
361 does not result in more backslash escapes than before.
362
363 *Black* also standardizes string prefixes, making them always lowercase.
364 On top of that, if your code is already Python 3.6+ only or it's using
365 the `unicode_literals` future import, *Black* will remove `u` from the
366 string prefix as it is meaningless in those scenarios.
367
368 The main reason to standardize on a single form of quotes is aesthetics.
369 Having one kind of quotes everywhere reduces reader distraction.
370 It will also enable a future version of *Black* to merge consecutive
371 string literals that ended up on the same line (see
372 [#26](https://github.com/ambv/black/issues/26) for details).
373
374 Why settle on double quotes?  They anticipate apostrophes in English
375 text.  They match the docstring standard described in [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring).
376 An empty string in double quotes (`""`) is impossible to confuse with
377 a one double-quote regardless of fonts and syntax highlighting used.
378 On top of this, double quotes for strings are consistent with C which
379 Python interacts a lot with.
380
381 On certain keyboard layouts like US English, typing single quotes is
382 a bit easier than double quotes.  The latter requires use of the Shift
383 key.  My recommendation here is to keep using whatever is faster to type
384 and let *Black* handle the transformation.
385
386 If you are adopting *Black* in a large project with pre-existing string
387 conventions (like the popular ["single quotes for data, double quotes for
388 human-readable strings"](https://stackoverflow.com/a/56190)), you can
389 pass `--skip-string-normalization` on the command line.  This is meant as
390 an adoption helper, avoid using this for new projects.
391
392 ### Numeric literals
393
394 *Black* standardizes most numeric literals to use lowercase letters for the
395 syntactic parts and uppercase letters for the digits themselves: `0xAB`
396 instead of `0XAB` and `1e10` instead of `1E10`. Python 2 long literals are
397 styled as `2L` instead of `2l` to avoid confusion between `l` and `1`.
398
399
400 ### Line breaks & binary operators
401
402 *Black* will break a line before a binary operator when splitting a block
403 of code over multiple lines. This is so that *Black* is compliant with the
404 recent changes in the [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
405 style guide, which emphasizes that this approach improves readability.
406
407 This behaviour may raise ``W503 line break before binary operator`` warnings in
408 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
409 you should tell Flake8 to ignore these warnings.
410
411
412 ### Slices
413
414 PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
415 to treat ``:`` in slices as a binary operator with the lowest priority, and to
416 leave an equal amount of space on either side, except if a parameter is omitted
417 (e.g. ``ham[1 + 1 :]``). It also states that for extended slices, both ``:``
418 operators have to have the same amount of spacing, except if a parameter is
419 omitted (``ham[1 + 1 ::]``). *Black* enforces these rules consistently.
420
421 This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
422 enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
423 tell Flake8 to ignore these warnings.
424
425
426 ### Parentheses
427
428 Some parentheses are optional in the Python grammar.  Any expression can
429 be wrapped in a pair of parentheses to form an atom.  There are a few
430 interesting cases:
431
432 - `if (...):`
433 - `while (...):`
434 - `for (...) in (...):`
435 - `assert (...), (...)`
436 - `from X import (...)`
437 - assignments like:
438   - `target = (...)`
439   - `target: type = (...)`
440   - `some, *un, packing = (...)`
441   - `augmented += (...)`
442
443 In those cases, parentheses are removed when the entire statement fits
444 in one line, or if the inner expression doesn't have any delimiters to
445 further split on.  If there is only a single delimiter and the expression
446 starts or ends with a bracket, the parenthesis can also be successfully
447 omitted since the existing bracket pair will organize the expression
448 neatly anyway.  Otherwise, the parentheses are added.
449
450 Please note that *Black* does not add or remove any additional nested
451 parentheses that you might want to have for clarity or further
452 code organization.  For example those parentheses are not going to be
453 removed:
454 ```py3
455 return not (this or that)
456 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
457 ```
458
459
460 ### Call chains
461
462 Some popular APIs, like ORMs, use call chaining.  This API style is known
463 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).
464 *Black* formats those by treating dots that follow a call or an indexing
465 operation like a very low priority delimiter.  It's easier to show the
466 behavior than to explain it.  Look at the example:
467 ```py3
468 def example(session):
469     result = (
470         session.query(models.Customer.id)
471         .filter(
472             models.Customer.account_id == account_id,
473             models.Customer.email == email_address,
474         )
475         .order_by(models.Customer.id.asc())
476         .all()
477     )
478 ```
479
480
481 ### Typing stub files
482
483 PEP 484 describes the syntax for type hints in Python.  One of the
484 use cases for typing is providing type annotations for modules which
485 cannot contain them directly (they might be written in C, or they might
486 be third-party, or their implementation may be overly dynamic, and so on).
487
488 To solve this, [stub files with the `.pyi` file
489 extension](https://www.python.org/dev/peps/pep-0484/#stub-files) can be
490 used to describe typing information for an external module.  Those stub
491 files omit the implementation of classes and functions they
492 describe, instead they only contain the structure of the file (listing
493 globals, functions, and classes with their members).  The recommended
494 code style for those files is more terse than PEP 8:
495
496 * prefer `...` on the same line as the class/function signature;
497 * avoid vertical whitespace between consecutive module-level functions,
498   names, or methods and fields within a single class;
499 * use a single blank line between top-level class definitions, or none
500   if the classes are very small.
501
502 *Black* enforces the above rules.  There are additional guidelines for
503 formatting `.pyi` file that are not enforced yet but might be in
504 a future version of the formatter:
505
506 * all function bodies should be empty (contain `...` instead of the body);
507 * do not use docstrings;
508 * prefer `...` over `pass`;
509 * for arguments with a default, use `...` instead of the actual default;
510 * avoid using string literals in type annotations, stub files support
511   forward references natively (like Python 3.7 code with `from __future__
512   import annotations`);
513 * use variable annotations instead of type comments, even for stubs that
514   target older versions of Python;
515 * for arguments that default to `None`, use `Optional[]` explicitly;
516 * use `float` instead of `Union[int, float]`.
517
518
519 ## pyproject.toml
520
521 *Black* is able to read project-specific default values for its
522 command line options from a `pyproject.toml` file.  This is
523 especially useful for specifying custom `--include` and `--exclude`
524 patterns for your project.
525
526 **Pro-tip**: If you're asking yourself "Do I need to configure anything?"
527 the answer is "No".  *Black* is all about sensible defaults.
528
529
530 ### What on Earth is a `pyproject.toml` file?
531
532 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines
533 `pyproject.toml` as a configuration file to store build system
534 requirements for Python projects.  With the help of tools
535 like [Poetry](https://poetry.eustace.io/) or
536 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the
537 need for `setup.py` and `setup.cfg` files.
538
539
540 ### Where *Black* looks for the file
541
542 By default *Black* looks for `pyproject.toml` starting from the common
543 base directory of all files and directories passed on the command line.
544 If it's not there, it looks in parent directories.  It stops looking
545 when it finds the file, or a `.git` directory, or a `.hg` directory,
546 or the root of the file system, whichever comes first.
547
548 If you're formatting standard input, *Black* will look for configuration
549 starting from the current working directory.
550
551 You can also explicitly specify the path to a particular file that you
552 want with `--config`.  In this situation *Black* will not look for any
553 other file.
554
555 If you're running with `--verbose`, you will see a blue message if
556 a file was found and used.
557
558 Please note `blackd` will not use `pyproject.toml` configuration.
559
560
561 ### Configuration format
562
563 As the file extension suggests, `pyproject.toml` is a [TOML](https://github.com/toml-lang/toml) file.  It contains separate
564 sections for different tools.  *Black* is using the `[tool.black]`
565 section.  The option keys are the same as long names of options on
566 the command line.
567
568 Note that you have to use single-quoted strings in TOML for regular
569 expressions. It's the equivalent of r-strings in Python.  Multiline
570 strings are treated as verbose regular expressions by Black.  Use `[ ]`
571 to denote a significant space character.
572
573 <details>
574 <summary>Example `pyproject.toml`</summary>
575
576 ```toml
577 [tool.black]
578 line-length = 88
579 py36 = true
580 include = '\.pyi?$'
581 exclude = '''
582
583 (
584   /(
585       \.eggs         # exclude a few common directories in the
586     | \.git          # root of the project
587     | \.hg
588     | \.mypy_cache
589     | \.tox
590     | \.venv
591     | _build
592     | buck-out
593     | build
594     | dist
595   )/
596   | foo.py           # also separately exclude a file named foo.py in
597                      # the root of the project
598 )
599 '''
600 ```
601
602 </details>
603
604 ### Lookup hierarchy
605
606 Command-line options have defaults that you can see in `--help`.
607 A `pyproject.toml` can override those defaults.  Finally, options
608 provided by the user on the command line override both.
609
610 *Black* will only ever use one `pyproject.toml` file during an entire
611 run. It doesn't look for multiple files, and doesn't compose
612 configuration from different levels of the file hierarchy.
613
614
615 ## Editor integration
616
617 ### Emacs
618
619 Use [proofit404/blacken](https://github.com/proofit404/blacken).
620
621
622 ### PyCharm
623
624 1. Install `black`.
625
626 ```console
627 $ pip install black
628 ```
629
630 2. Locate your `black` installation folder.
631
632   On macOS / Linux / BSD:
633
634 ```console
635 $ which black
636 /usr/local/bin/black  # possible location
637 ```
638
639   On Windows:
640
641 ```console
642 $ where black
643 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
644 ```
645
646 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
647
648 4. Click the + icon to add a new external tool with the following values:
649     - Name: Black
650     - Description: Black is the uncompromising Python code formatter.
651     - Program: <install_location_from_step_2>
652     - Arguments: `$FilePath$`
653
654 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
655     - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.
656
657 6. Optionally, run Black on every file save:
658
659     1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed.
660     2. Go to `Preferences -> Tools -> File Watchers` and click `+` to add a new watcher:
661         - Name: Black
662         - File type: Python
663         - Scope: Project Files
664         - Program: <install_location_from_step_2>
665         - Arguments: `$FilePath$`
666         - Output paths to refresh: `$FilePathRelativeToProjectRoot$`
667         - Working directory: `$ProjectFileDir$`
668         - Uncheck "Auto-save edited files to trigger the watcher"
669
670 ### Vim
671
672 Commands and shortcuts:
673
674 * `:Black` to format the entire file (ranges not supported);
675 * `:BlackUpgrade` to upgrade *Black* inside the virtualenv;
676 * `:BlackVersion` to get the current version of *Black* inside the
677   virtualenv.
678
679 Configuration:
680 * `g:black_fast` (defaults to `0`)
681 * `g:black_linelength` (defaults to `88`)
682 * `g:black_skip_string_normalization` (defaults to `0`)
683 * `g:black_virtualenv` (defaults to `~/.vim/black`)
684
685 To install with [vim-plug](https://github.com/junegunn/vim-plug):
686
687 ```
688 Plug 'ambv/black'
689 ```
690
691 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
692
693 ```
694 Plugin 'ambv/black'
695 ```
696
697 or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim).
698 Let me know if this requires any changes to work with Vim 8's builtin
699 `packadd`, or Pathogen, and so on.
700
701 This plugin **requires Vim 7.0+ built with Python 3.6+ support**.  It
702 needs Python 3.6 to be able to run *Black* inside the Vim process which
703 is much faster than calling an external command.
704
705 On first run, the plugin creates its own virtualenv using the right
706 Python version and automatically installs *Black*. You can upgrade it later
707 by calling `:BlackUpgrade` and restarting Vim.
708
709 If you need to do anything special to make your virtualenv work and
710 install *Black* (for example you want to run a version from master),
711 create a virtualenv manually and point `g:black_virtualenv` to it.
712 The plugin will use it.
713
714 To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
715
716 ```
717 autocmd BufWritePre *.py execute ':Black'
718 ```
719
720 **How to get Vim with Python 3.6?**
721 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
722 On macOS with Homebrew run: `brew install vim --with-python3`.
723 When building Vim from source, use:
724 `./configure --enable-python3interp=yes`. There's many guides online how
725 to do this.
726
727
728 ### Visual Studio Code
729
730 Use the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
731 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
732
733
734 ### SublimeText 3
735
736 Use [sublack plugin](https://github.com/jgirardet/sublack).
737
738
739 ### Jupyter Notebook Magic
740
741 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
742
743
744 ### Python Language Server
745
746 If your editor supports the [Language Server Protocol](https://langserver.org/)
747 (Atom, Sublime Text, Visual Studio Code and many more), you can use
748 the [Python Language Server](https://github.com/palantir/python-language-server) with the
749 [pyls-black](https://github.com/rupert/pyls-black) plugin.
750
751
752 ### Atom/Nuclide
753
754 Use [python-black](https://atom.io/packages/python-black).
755
756
757 ### Other editors
758
759 Other editors will require external contributions.
760
761 Patches welcome! ✨ 🍰 ✨
762
763 Any tool that can pipe code through *Black* using its stdio mode (just
764 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
765 The formatted code will be returned on stdout (unless `--check` was
766 passed).  *Black* will still emit messages on stderr but that shouldn't
767 affect your use case.
768
769 This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
770
771 ## blackd
772
773 `blackd` is a small HTTP server that exposes *Black*'s functionality over
774 a simple protocol. The main benefit of using it is to avoid paying the
775 cost of starting up a new *Black* process every time you want to blacken
776 a file.
777
778 ### Usage
779
780 `blackd` is not packaged alongside *Black* by default because it has additional
781 dependencies. You will need to do `pip install black[d]` to install it.
782
783 You can start the server on the default port, binding only to the local interface
784 by running `blackd`. You will see a single line mentioning the server's version,
785 and the host and port it's listening on. `blackd` will then print an access log
786 similar to most web servers on standard output, merged with any exception traces
787 caused by invalid formatting requests.
788
789 `blackd` provides even less options than *Black*. You can see them by running
790 `blackd --help`:
791
792 ```text
793 Usage: blackd [OPTIONS]
794
795 Options:
796   --bind-host TEXT                Address to bind the server to.
797   --bind-port INTEGER             Port to listen on
798   --version                       Show the version and exit.
799   -h, --help                      Show this message and exit.
800 ```
801
802 ### Protocol
803
804 `blackd` only accepts `POST` requests at the `/` path. The body of the request
805 should contain the python source code to be formatted, encoded
806 according to the `charset` field in the `Content-Type` request header. If no
807 `charset` is specified, `blackd` assumes `UTF-8`.
808
809 There are a few HTTP headers that control how the source is formatted. These
810 correspond to command line flags for *Black*. There is one exception to this:
811 `X-Protocol-Version` which if present, should have the value `1`, otherwise the
812 request is rejected with `HTTP 501` (Not Implemented).
813
814 The headers controlling how code is formatted are:
815
816  - `X-Line-Length`: corresponds to the `--line-length` command line flag.
817  - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization`
818     command line flag. If present and its value is not the empty string, no string
819     normalization will be performed.
820  - `X-Fast-Or-Safe`: if set to `fast`, `blackd` will act as *Black* does when
821     passed the `--fast` command line flag.
822  - `X-Python-Variant`: if set to `pyi`, `blackd` will act as *Black* does when
823     passed the `--pyi` command line flag. Otherwise, its value must correspond to
824     a Python version or a set of comma-separated Python versions, optionally
825     prefixed with `cpy` or `pypy`. For example, to request code that is compatible
826     with PyPy 3.5 and CPython 3.5, set the header to `pypy3.5,cpy3.5`.
827
828 If any of these headers are set to invalid values, `blackd` returns a `HTTP 400`
829 error response, mentioning the name of the problematic header in the message body.
830
831 Apart from the above, `blackd` can produce the following response codes:
832
833  - `HTTP 204`: If the input is already well-formatted. The response body is
834         empty.
835  - `HTTP 200`: If formatting was needed on the input. The response body
836         contains the blackened Python code, and the `Content-Type` header is set
837         accordingly.
838  - `HTTP 400`: If the input contains a syntax error. Details of the error are
839         returned in the response body.
840  - `HTTP 500`: If there was any kind of error while trying to format the input.
841         The response body contains a textual representation of the error.
842
843 ## Version control integration
844
845 Use [pre-commit](https://pre-commit.com/). Once you [have it
846 installed](https://pre-commit.com/#install), add this to the
847 `.pre-commit-config.yaml` in your repository:
848 ```yaml
849 repos:
850 -   repo: https://github.com/ambv/black
851     rev: stable
852     hooks:
853     - id: black
854       language_version: python3.6
855 ```
856 Then run `pre-commit install` and you're ready to go.
857
858 Avoid using `args` in the hook.  Instead, store necessary configuration
859 in `pyproject.toml` so that editors and command-line usage of Black all
860 behave consistently for your project.  See *Black*'s own `pyproject.toml`
861 for an example.
862
863 If you're already using Python 3.7, switch the `language_version`
864 accordingly. Finally, `stable` is a tag that is pinned to the latest
865 release on PyPI.  If you'd rather run on master, this is also an option.
866
867
868 ## Ignoring unmodified files
869
870 *Black* remembers files it has already formatted, unless the `--diff` flag is used or
871 code is passed via standard input. This information is stored per-user. The exact
872 location of the file depends on the *Black* version and the system on which *Black*
873 is run. The file is non-portable. The standard location on common operating systems
874 is:
875
876 * Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle`
877 * macOS: `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle`
878 * Linux: `/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle`
879
880 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
881 as .pyi, and whether string normalization was omitted.
882
883
884 ## Testimonials
885
886 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
887
888 > *Black* is opinionated so you don't have to be.
889
890 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core
891 developer of Twisted and CPython:
892
893 > An auto-formatter that doesn't suck is all I want for Xmas!
894
895 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
896
897 > At least the name is good.
898
899 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
900 and [`pipenv`](https://docs.pipenv.org/):
901
902 > This vastly improves the formatting of our code. Thanks a ton!
903
904
905 ## Show your style
906
907 Use the badge in your project's README.md:
908
909 ```markdown
910 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
911 ```
912
913 Using the badge in README.rst:
914 ```
915 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
916     :target: https://github.com/ambv/black
917 ```
918
919 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
920
921
922 ## License
923
924 MIT
925
926
927 ## Contributing to *Black*
928
929 In terms of inspiration, *Black* is about as configurable as *gofmt*.
930 This is deliberate.
931
932 Bug reports and fixes are always welcome!  However, before you suggest a
933 new feature or configuration knob, ask yourself why you want it.  If it
934 enables better integration with some workflow, fixes an inconsistency,
935 speeds things up, and so on - go for it!  On the other hand, if your
936 answer is "because I don't like a particular formatting" then you're not
937 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
938 You can still try but prepare to be disappointed.
939
940 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
941
942
943 ## Change Log
944
945 ### 19.2b0
946
947 * *Black* no longer normalizes numeric literals to include `_` separators.
948
949 * new option `--target-version` to control which Python versions
950   *Black*-formatted code should target
951
952 ### 18.9b0
953
954 * numeric literals are now formatted by *Black* (#452, #461, #464, #469):
955
956   * numeric literals are normalized to include `_` separators on Python 3.6+ code
957
958   * added `--skip-numeric-underscore-normalization` to disable the above behavior and
959     leave numeric underscores as they were in the input
960
961   * code with `_` in numeric literals is recognized as Python 3.6+
962
963   * most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
964
965   * hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
966
967 * added `blackd`, see [its documentation](#blackd) for more info (#349)
968
969 * adjacent string literals are now correctly split into multiple lines (#463)
970
971 * trailing comma is now added to single imports that don't fit on a line (#250)
972
973 * cache is now populated when `--check` is successful for a file which speeds up
974   consecutive checks of properly formatted unmodified files (#448)
975
976 * whitespace at the beginning of the file is now removed (#399)
977
978 * fixed mangling [pweave](http://mpastell.com/pweave/) and
979   [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532)
980
981 * fixed unstable formatting when unpacking big tuples (#267)
982
983 * fixed parsing of `__future__` imports with renames (#389)
984
985 * fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
986
987 * fixed formatting of lambda expressions with default arguments (#468)
988
989 * fixed ``async for`` statements: *Black* no longer breaks them into separate
990   lines (#372)
991
992 * note: the Vim plugin stopped registering ``,=`` as a default chord as it turned out
993   to be a bad idea (#415)
994
995
996 ### 18.6b4
997
998 * hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
999
1000
1001 ### 18.6b3
1002
1003 * typing stub files (`.pyi`) now have blank lines added after constants (#340)
1004
1005 * `# fmt: off` and `# fmt: on` are now much more dependable:
1006
1007   * they now work also within bracket pairs (#329)
1008
1009   * they now correctly work across function/class boundaries (#335)
1010
1011   * they now work when an indentation block starts with empty lines or misaligned
1012     comments (#334)
1013
1014 * made Click not fail on invalid environments; note that Click is right but the
1015   likelihood we'll need to access non-ASCII file paths when dealing with Python source
1016   code is low (#277)
1017
1018 * fixed improper formatting of f-strings with quotes inside interpolated
1019   expressions (#322)
1020
1021 * fixed unnecessary slowdown when long list literals where found in a file
1022
1023 * fixed unnecessary slowdown on AST nodes with very many siblings
1024
1025 * fixed cannibalizing backslashes during string normalization
1026
1027 * fixed a crash due to symbolic links pointing outside of the project directory (#338)
1028
1029
1030 ### 18.6b2
1031
1032 * added `--config` (#65)
1033
1034 * added `-h` equivalent to `--help` (#316)
1035
1036 * fixed improper unmodified file caching when `-S` was used
1037
1038 * fixed extra space in string unpacking (#305)
1039
1040 * fixed formatting of empty triple quoted strings (#313)
1041
1042 * fixed unnecessary slowdown in comment placement calculation on lines without
1043   comments
1044
1045
1046 ### 18.6b1
1047
1048 * hotfix: don't output human-facing information on stdout (#299)
1049
1050 * hotfix: don't output cake emoji on non-zero return code (#300)
1051
1052
1053 ### 18.6b0
1054
1055 * added `--include` and `--exclude` (#270)
1056
1057 * added `--skip-string-normalization` (#118)
1058
1059 * added `--verbose` (#283)
1060
1061 * the header output in `--diff` now actually conforms to the unified diff spec
1062
1063 * fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1064
1065 * fixed unnecessary parentheses when a line contained multiline strings (#232)
1066
1067 * fixed stdin handling not working correctly if an old version of Click was
1068   used (#276)
1069
1070 * *Black* now preserves line endings when formatting a file in place (#258)
1071
1072
1073 ### 18.5b1
1074
1075 * added `--pyi` (#249)
1076
1077 * added `--py36` (#249)
1078
1079 * Python grammar pickle caches are stored with the formatting caches, making
1080   *Black* work in environments where site-packages is not user-writable (#192)
1081
1082 * *Black* now enforces a PEP 257 empty line after a class-level docstring
1083   (and/or fields) and the first method
1084
1085 * fixed invalid code produced when standalone comments were present in a trailer
1086   that was omitted from line splitting on a large expression (#237)
1087
1088 * fixed optional parentheses being removed within `# fmt: off` sections (#224)
1089
1090 * fixed invalid code produced when stars in very long imports were incorrectly
1091   wrapped in optional parentheses (#234)
1092
1093 * fixed unstable formatting when inline comments were moved around in
1094   a trailer that was omitted from line splitting on a large expression
1095   (#238)
1096
1097 * fixed extra empty line between a class declaration and the first
1098   method if no class docstring or fields are present (#219)
1099
1100 * fixed extra empty line between a function signature and an inner
1101   function or inner class (#196)
1102
1103
1104 ### 18.5b0
1105
1106 * call chains are now formatted according to the
1107   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface)
1108   style (#67)
1109
1110 * data structure literals (tuples, lists, dictionaries, and sets) are
1111   now also always exploded like imports when they don't fit in a single
1112   line (#152)
1113
1114 * slices are now formatted according to PEP 8 (#178)
1115
1116 * parentheses are now also managed automatically on the right-hand side
1117   of assignments and return statements (#140)
1118
1119 * math operators now use their respective priorities for delimiting multiline
1120   expressions (#148)
1121
1122 * optional parentheses are now omitted on expressions that start or end
1123   with a bracket and only contain a single operator (#177)
1124
1125 * empty parentheses in a class definition are now removed (#145, #180)
1126
1127 * string prefixes are now standardized to lowercase and `u` is removed
1128   on Python 3.6+ only code and Python 2.7+ code with the `unicode_literals`
1129   future import (#188, #198, #199)
1130
1131 * typing stub files (`.pyi`) are now formatted in a style that is consistent
1132   with PEP 484 (#207, #210)
1133
1134 * progress when reformatting many files is now reported incrementally
1135
1136 * fixed trailers (content with brackets) being unnecessarily exploded
1137   into their own lines after a dedented closing bracket (#119)
1138
1139 * fixed an invalid trailing comma sometimes left in imports (#185)
1140
1141 * fixed non-deterministic formatting when multiple pairs of removable parentheses
1142   were used (#183)
1143
1144 * fixed multiline strings being unnecessarily wrapped in optional
1145   parentheses in long assignments (#215)
1146
1147 * fixed not splitting long from-imports with only a single name
1148
1149 * fixed Python 3.6+ file discovery by also looking at function calls with
1150   unpacking. This fixed non-deterministic formatting if trailing commas
1151   where used both in function signatures with stars and function calls
1152   with stars but the former would be reformatted to a single line.
1153
1154 * fixed crash on dealing with optional parentheses (#193)
1155
1156 * fixed "is", "is not", "in", and "not in" not considered operators for
1157   splitting purposes
1158
1159 * fixed crash when dead symlinks where encountered
1160
1161
1162 ### 18.4a4
1163
1164 * don't populate the cache on `--check` (#175)
1165
1166
1167 ### 18.4a3
1168
1169 * added a "cache"; files already reformatted that haven't changed on disk
1170   won't be reformatted again (#109)
1171
1172 * `--check` and `--diff` are no longer mutually exclusive (#149)
1173
1174 * generalized star expression handling, including double stars; this
1175   fixes multiplication making expressions "unsafe" for trailing commas (#132)
1176
1177 * *Black* no longer enforces putting empty lines behind control flow statements
1178   (#90)
1179
1180 * *Black* now splits imports like "Mode 3 + trailing comma" of isort (#127)
1181
1182 * fixed comment indentation when a standalone comment closes a block (#16, #32)
1183
1184 * fixed standalone comments receiving extra empty lines if immediately preceding
1185   a class, def, or decorator (#56, #154)
1186
1187 * fixed `--diff` not showing entire path (#130)
1188
1189 * fixed parsing of complex expressions after star and double stars in
1190   function calls (#2)
1191
1192 * fixed invalid splitting on comma in lambda arguments (#133)
1193
1194 * fixed missing splits of ternary expressions (#141)
1195
1196
1197 ### 18.4a2
1198
1199 * fixed parsing of unaligned standalone comments (#99, #112)
1200
1201 * fixed placement of dictionary unpacking inside dictionary literals (#111)
1202
1203 * Vim plugin now works on Windows, too
1204
1205 * fixed unstable formatting when encountering unnecessarily escaped quotes
1206   in a string (#120)
1207
1208
1209 ### 18.4a1
1210
1211 * added `--quiet` (#78)
1212
1213 * added automatic parentheses management (#4)
1214
1215 * added [pre-commit](https://pre-commit.com) integration (#103, #104)
1216
1217 * fixed reporting on `--check` with multiple files (#101, #102)
1218
1219 * fixed removing backslash escapes from raw strings (#100, #105)
1220
1221
1222 ### 18.4a0
1223
1224 * added `--diff` (#87)
1225
1226 * add line breaks before all delimiters, except in cases like commas, to
1227   better comply with PEP 8 (#73)
1228
1229 * standardize string literals to use double quotes (almost) everywhere
1230   (#75)
1231
1232 * fixed handling of standalone comments within nested bracketed
1233   expressions; *Black* will no longer produce super long lines or put all
1234   standalone comments at the end of the expression (#22)
1235
1236 * fixed 18.3a4 regression: don't crash and burn on empty lines with
1237   trailing whitespace (#80)
1238
1239 * fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment
1240   would cause *Black* to not emit the rest of the file (#95)
1241
1242 * when CTRL+C is pressed while formatting many files, *Black* no longer
1243   freaks out with a flurry of asyncio-related exceptions
1244
1245 * only allow up to two empty lines on module level and only single empty
1246   lines within functions (#74)
1247
1248
1249 ### 18.3a4
1250
1251 * `# fmt: off` and `# fmt: on` are implemented (#5)
1252
1253 * automatic detection of deprecated Python 2 forms of print statements
1254   and exec statements in the formatted file (#49)
1255
1256 * use proper spaces for complex expressions in default values of typed
1257   function arguments (#60)
1258
1259 * only return exit code 1 when --check is used (#50)
1260
1261 * don't remove single trailing commas from square bracket indexing
1262   (#59)
1263
1264 * don't omit whitespace if the previous factor leaf wasn't a math
1265   operator (#55)
1266
1267 * omit extra space in kwarg unpacking if it's the first argument (#46)
1268
1269 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1270   (#68)
1271
1272
1273 ### 18.3a3
1274
1275 * don't remove single empty lines outside of bracketed expressions
1276   (#19)
1277
1278 * added ability to pipe formatting from stdin to stdin (#25)
1279
1280 * restored ability to format code with legacy usage of `async` as
1281   a name (#20, #42)
1282
1283 * even better handling of numpy-style array indexing (#33, again)
1284
1285
1286 ### 18.3a2
1287
1288 * changed positioning of binary operators to occur at beginning of lines
1289   instead of at the end, following [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1290   (#21)
1291
1292 * ignore empty bracket pairs while splitting. This avoids very weirdly
1293   looking formattings (#34, #35)
1294
1295 * remove a trailing comma if there is a single argument to a call
1296
1297 * if top level functions were separated by a comment, don't put four
1298   empty lines after the upper function
1299
1300 * fixed unstable formatting of newlines with imports
1301
1302 * fixed unintentional folding of post scriptum standalone comments
1303   into last statement if it was a simple statement (#18, #28)
1304
1305 * fixed missing space in numpy-style array indexing (#33)
1306
1307 * fixed spurious space after star-based unary expressions (#31)
1308
1309
1310 ### 18.3a1
1311
1312 * added `--check`
1313
1314 * only put trailing commas in function signatures and calls if it's
1315   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
1316   only safe if there are no `*args` or `**kwargs` used in the signature
1317   or call. (#8)
1318
1319 * fixed invalid spacing of dots in relative imports (#6, #13)
1320
1321 * fixed invalid splitting after comma on unpacked variables in for-loops
1322   (#23)
1323
1324 * fixed spurious space in parenthesized set expressions (#7)
1325
1326 * fixed spurious space after opening parentheses and in default
1327   arguments (#14, #17)
1328
1329 * fixed spurious space after unary operators when the operand was
1330   a complex expression (#15)
1331
1332
1333 ### 18.3a0
1334
1335 * first published version, Happy 🍰 Day 2018!
1336
1337 * alpha quality
1338
1339 * date-versioned (see: https://calver.org/)
1340
1341
1342 ## Authors
1343
1344 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1345
1346 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1347 [Carl Meyer](mailto:carl@oddbird.net),
1348 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
1349 [Mika Naylor](mailto:mail@autophagy.io), and
1350 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
1351
1352 Multiple contributions by:
1353 * [Anthony Sottile](mailto:asottile@umich.edu)
1354 * [Artem Malyshev](mailto:proofit404@gmail.com)
1355 * [Christian Heimes](mailto:christian@python.org)
1356 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
1357 * [Eli Treuherz](mailto:eli@treuherz.com)
1358 * Hugo van Kemenade
1359 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1360 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
1361 * [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1362 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1363 * [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
1364 * [Neraste](mailto:neraste.herr10@gmail.com)
1365 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1366 * [Peter Bengtsson](mailto:mail@peterbe.com)
1367 * [Stavros Korokithakis](mailto:hi@stavros.io)
1368 * [Sunil Kapil](mailto:snlkapil@gmail.com)
1369 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
1370 * [Chuck Wooters](mailto:chuck.wooters@microsoft.com)