tldr/pages/common/black.md

29 lines
803 B
Markdown
Raw Permalink Normal View History

2019-10-31 01:29:02 +00:00
# black
> A Python auto code formatter.
> More information: <https://github.com/psf/black>.
- Auto-format a file or entire directory:
`black {{path/to/file_or_directory}}`
- Format the code passed in as a string:
`black -c "{{code}}"`
2019-10-31 01:29:02 +00:00
- Output the changes that would be applied for each file:
2019-10-31 01:29:02 +00:00
`black --diff {{path/to/file_or_directory}}`
- Perform a dry run (print what would be done without actually doing it):
2019-10-31 01:29:02 +00:00
`black --check {{path/to/file_or_directory}}`
- Auto-format a file or directory emitting exclusively error messages to stderr:
`black --quiet {{path/to/file_or_directory}}`
- Auto-format a file or directory without replacing single quotes with double quotes (adoption helper, avoid using this for new projects):
`black --skip-string-normalization {{path/to/file_or_directory}}`