tldr/pages/common/black.md

29 lines
923 B
Markdown
Raw Normal View History

2019-10-31 01:29:02 +00:00
# black
> Format Python code automatically.
> More information: <https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html>.
2019-10-31 01:29:02 +00:00
- Auto-format a file or entire directory:
`black {{path/to/file_or_directory}}`
- Format the [c]ode passed in as a string:
2019-10-31 01:29:02 +00:00
`black -c "{{code}}"`
2019-10-31 01:29:02 +00:00
- Show whether a file or a directory would have changes made to them if they were to be formatted:
2019-10-31 01:29:02 +00:00
`black --check {{path/to/file_or_directory}}`
2019-10-31 01:29:02 +00:00
- Show changes that would be made to a file or a directory without performing them (dry-run):
2019-10-31 01:29:02 +00:00
`black --diff {{path/to/file_or_directory}}`
2019-10-31 01:29:02 +00:00
- Auto-format a file or directory, emitting exclusively error messages to `stderr`:
2019-10-31 01:29:02 +00:00
`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}}`