每次运行 Python 脚本前自动执行 Black 代码格式化

本文介绍如何配置一个简单的 bash 函数，实现在每次运行 python 脚本之前自动使用 Black 进行代码格式化。通过这种方式，可以确保代码在执行前符合统一的风格规范，从而减少潜在的语法错误和提高代码可读性。该方法简单易用，适用于快速本地测试和开发环境。

在日常 Python 开发中，保持代码风格一致性至关重要。Black 是一款流行的 Python 代码自动格式化工具，可以帮助开发者统一代码风格，提高代码可读性。为了在每次运行 Python 脚本之前自动执行 Black，我们可以创建一个 Bash 函数，从而简化操作流程。

创建 Bash 函数

以下是一个简单的 Bash 函数，可以实现先运行 Black 格式化指定 Python 文件，然后再执行该文件：

立即学习“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 命令执行失败（返回非 0 退出码），则执行 then 后面的语句。
• echo “Black encountered an error. Aborting.”: 如果 black 遇到错误，打印错误信息。
• return 1: 如果 black 遇到错误，函数返回 1，表示执行失败。
• python3 “$@”: 如果 black 成功执行，则使用 python3 命令执行所有参数 $@，包括 Python 文件名和传递给脚本的任何其他参数。

使用方法

将上述代码添加到你的 Bash 配置文件（例如 ~/.bashrc 或 ~/.zshrc）中，然后重新加载配置文件（例如运行 source ~/.bashrc）。

之后，你就可以像这样使用 runpy 函数：

runpy my_python_file.py argument1 --option2

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

注意事项

• 确保你已经安装了 Black： pip install black。
• runpy 函数假定你使用 python3 命令来运行 Python 脚本。如果你的系统使用不同的命令，请相应地修改函数。
• 如果 Black 格式化失败，该函数会停止执行，并输出错误信息。这可以防止在代码风格不一致的情况下运行脚本。
• 将函数添加到 Bash 配置文件后，需要重新加载配置文件才能使更改生效。

总结

通过创建一个简单的 Bash 函数，我们可以轻松地实现在每次运行 Python 脚本之前自动执行 Black 格式化。这可以帮助我们保持代码风格一致性，减少潜在的语法错误，并提高代码可读性。这是一个简单而有效的技巧，可以提高 Python 开发效率。