black--一键格式化Python代码_命令行

black

black是一个Python代码格式化程序,使用它可以免于在调整代码格式上花费时间。black被许多大大小小的项目成功使用,包括pytest, tox, Pyramid, Django等。

格式化效果:

black--一键格式化Python代码_vim_02

可以在线查看格式化效果:https://black.vercel.app/

安装:
pip install black

black的运行需要Python3.8+。

使用

black支持命令行、多种编辑器及IDE,包括vim, vscode, PyCharm等。下面是我最常用的两种。

命令行

可以直接在命令行中对python文件或目录使用:
black {source_file_or_directory}

PyCharm内置

如果你使用PyCharm 2023.2 及更高版本,可以使用内置的Black。
只需要在PyCharm中设置Black:文件–>设置–>工具–>Black

black--一键格式化Python代码_python_03

随后就可以用Ctrl+Alt+Enter进行格式化。也可以对文件夹右键,选择重新格式化代码,对文件夹中的py文件都进行格式化。

black--一键格式化Python代码_命令行_04