0

0

使用 Bash 函数在 Python 脚本运行前自动执行 Black 代码格式化

花韻仙語

花韻仙語

发布时间:2025-08-22 16:30:22

|

355人浏览过

|

来源于php中文网

原创

使用 bash 函数在 python 脚本运行前自动执行 black 代码格式化

本文旨在提供一种便捷的方式,实现在执行 Python 脚本前自动运行 Black 代码格式化工具,从而确保代码风格的一致性。

使用 Bash 函数实现自动 Black 格式化

为了在运行 Python 脚本之前自动执行 Black,我们可以创建一个 Bash 函数。这个函数首先使用 Black 格式化指定的 Python 文件,然后在格式化成功后执行该文件。

以下是具体的 Bash 函数定义:

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

代码解释:

立即学习Python免费学习笔记(深入)”;

  • runpy():定义了一个名为 runpy 的 Bash 函数。
  • if ! black "$1"; then:这部分代码尝试使用 Black 格式化传递给函数的第一个参数(即 Python 文件)。! 表示逻辑非,如果 Black 命令执行失败(返回非零退出码),则执行 then 后面的代码。
  • echo "Black encountered an error. Aborting.":如果 Black 遇到错误,则输出错误信息。
  • return 1:如果 Black 遇到错误,则函数返回 1,表示执行失败。
  • python3 "$@":如果 Black 成功格式化文件,则执行 Python 解释器,并将所有传递给 runpy 函数的参数(包括文件名和任何其他参数)传递给 Python 解释器。$@ 表示所有参数。

如何使用:

Cutout老照片上色
Cutout老照片上色

Cutout.Pro推出的黑白图片上色

下载
  1. 将上述代码添加到你的 shell 配置文件(例如 .bashrc 或 .zshrc)。
  2. 保存文件并重新加载 shell 配置(例如运行 source ~/.bashrc 或 source ~/.zshrc)。
  3. 现在,你可以使用 runpy 命令来运行 Python 脚本:
runpy my_python_file.py argument1 --option2

这将首先使用 Black 格式化 my_python_file.py,然后在格式化成功后执行该脚本,并将 argument1 和 --option2 作为参数传递给 Python 脚本。

注意事项:

  • 确保你的系统上已经安装了 Black。你可以使用 pip install black 命令进行安装。
  • 此函数假定你使用 python3 命令来运行 Python 脚本。如果你的系统使用不同的命令,请相应地修改函数。
  • 如果 Black 格式化失败,函数将中止执行,以防止运行未格式化的代码。

总结:

通过定义一个简单的 Bash 函数,我们可以轻松地在运行 Python 脚本之前自动执行 Black 代码格式化。这可以帮助我们保持代码风格一致,减少错误,并提升开发效率。这种方法特别适用于快速原型开发和本地测试环境,在这种环境下,我们可能没有配置完善的 IDE 或编辑器集成。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

707

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

734

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1234

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

573

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

695

2023.08.11

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号