]> 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:

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