使用 Black 自动格式化 Python 代码并运行

在日常 python 开发中，代码风格一致性至关重要。手动格式化代码既耗时又容易出错。Black 是一款流行的 Python 代码自动格式化工具，能够帮助开发者保持代码风格的统一。本文将介绍如何配置一个 bash 函数，在每次运行 Python 脚本之前自动使用 Black 进行格式化，从而简化开发流程，减少潜在的语法错误。

自动格式化并运行 Python 脚本的 Bash 函数

以下是一个 Bash 函数，它首先使用 Black 格式化指定的 Python 文件，然后运行该文件：

runpy() {     if ! black "$1"; then         echo "Black encountered an Error. Aborting."         return 1     fi     python3 "$@" }

代码解释：

• runpy(): 定义一个名为 runpy 的 Bash 函数。
• if ! black “$1”; then: 首先尝试使用 black 命令格式化第一个参数 $1，即 Python 文件名。! 表示取反，如果 black 命令执行失败（返回非零退出码），则执行 then 后面的语句。
• echo “Black encountered an error. Aborting.”: 如果 black 执行失败，则打印错误信息。
• return 1: 函数返回 1，表示执行失败。
• fi: if 语句结束。
• python3 “$@”: 如果 black 执行成功，则使用 python3 命令运行脚本。$@ 表示所有参数，包括 Python 文件名和传递给脚本的任何其他参数。

使用方法：

立即学习“Python免费学习笔记（深入）”；

1. 将上述代码添加到你的 .bashrc、.zshrc 或其他 shell 配置文件中。
2. 重新加载配置文件，例如执行 source ~/.bashrc 或 source ~/.zshrc。
3. 现在可以使用 runpy 命令来运行 Python 脚本：

runpy my_python_file.py argument1 --option2

这条命令会首先使用 Black 格式化 my_python_file.py，然后使用 python3 运行该文件，并将 argument1 和 –option2 作为参数传递给脚本。

注意事项与总结

• Black 必须已安装： 确保你的系统中已经安装了 Black。可以使用 pip install black 命令进行安装。
• Python 版本： 上述示例使用了 python3 命令。如果你的系统默认使用 python 命令运行 Python 3，则可以将其替换为 python。
• 错误处理： 该函数包含简单的错误处理机制。如果 Black 格式化失败，则会打印错误信息并停止执行脚本。
• 灵活运用： 可以根据自己的需要修改该函数。例如，可以添加其他 linting 工具，或者修改错误处理方式。

通过使用这个简单的 Bash 函数，你可以轻松地在运行 Python 脚本之前自动使用 Black 进行代码格式化，从而提高代码质量和开发效率。 这不仅简化了开发流程，还有助于维护一致的代码风格，提升团队协作效率。