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 解释器。$@ 表示所有参数。

如何使用:

Napkin AI
Napkin AI

Napkin AI 可以将您的文本转换为图表、流程图、信息图、思维导图视觉效果,以便快速有效地分享您的想法。

下载
  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 或编辑器集成。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

437

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

803

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

371

2025.07.23

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

847

2023.08.22

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

492

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

25

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

44

2026.03.12

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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