2019-10-31 01:29:02 +00:00
|
|
|
# black
|
|
|
|
|
|
2024-04-25 23:58:21 +01:00
|
|
|
> Format Python code automatically.
|
2022-10-30 22:35:40 +00:00
|
|
|
> 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}}`
|
|
|
|
|
|
2024-02-19 14:13:42 +00:00
|
|
|
- Format the [c]ode passed in as a string:
|
2019-10-31 01:29:02 +00:00
|
|
|
|
2021-10-16 19:22:04 +01:00
|
|
|
`black -c "{{code}}"`
|
2019-10-31 01:29:02 +00:00
|
|
|
|
2024-01-31 03:55:19 +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
|
|
|
|
2022-10-30 22:35:40 +00:00
|
|
|
`black --check {{path/to/file_or_directory}}`
|
2019-10-31 01:29:02 +00:00
|
|
|
|
2024-01-31 03:55:19 +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
|
|
|
|
2022-10-30 22:35:40 +00:00
|
|
|
`black --diff {{path/to/file_or_directory}}`
|
2019-10-31 01:29:02 +00:00
|
|
|
|
2022-12-04 07:53:34 +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}}`
|
2021-09-17 21:07:20 +01:00
|
|
|
|
|
|
|
|
- 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}}`
|
