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

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