当我们编写Python代码时,遵循标准的代码规范有助于提升代码的可读性和可维护性。在常见的Python代码规范中,建议按照标准库 > 第三方库 > 自定义库或相对引用库的顺序组织导入语句,并且在每种类型的导入语句中,按照字母顺序排列导入的模块。
然而,在日常的代码编写过程中,很难始终手动保持这样的标准习惯。这时,我们可以借助usort这个实用的工具来自动优化代码中的导入语句顺序。
usort由Facebook即现在的Meta公司进行开源维护。通过执行 pip install usort
命令进行安装后,即可直接针对指定的Python文件或整个项目进行导入语句顺序的优化。以下是一个示例代码,原始的导入语句顺序如下,其中demo
是同级自定义包:
<code>import pandas as pd import numpy as np import feffery_antd_components as fac import feffery_utils_components as fuc import re import dash from demo import Demo from dash import html, dcc</code>
通过在终端执行 usort format main.py
进行优化后,导入语句顺序被更新为如下状态,可以看到优化后的导入语句顺序遵循了前述的标准规范:
<code>import re import dash import feffery_antd_components as fac import feffery_utils_components as fuc import numpy as np import pandas as pd from dash import dcc, html from demo import Demo</code>
此外,usort还能够避免一些IDE中在格式化代码时可能出现的错误,比如将一些必须在导入语句之前执行的代码逻辑误移动至导入语句后的情况。例如,warnings.filterwarnings()
,我们需要它在其他所有导入语句之前执行,以屏蔽相关的警告信息。使用IDE中自带的代码美化快捷功能时,可能会发现美化后warnings.filterwarnings()
被强制移到最后,而usort则能够智能地处理这类情况。
暂无评论内容