当我们书写Python代码的时候,遵守标准的代码规范可以帮助我们提升代码的可读性和易维护性。而在常见的Python代码规范中,我们在代码开头导包时,建议按照标准库>第三方库>自定义库或相对引用库的顺序组织代码,且各类型导包逻辑中建议按照字母顺序进行排列。
但在日常代码编写过程中,我们很难一直手动保持这样的标准习惯,这时我们就可以使用usort这个实用的工具来辅助优化代码中的导包顺序。
usort由facebook即现在的meta公司进行开源维护,使用pip install usort进行安装后,即可直接针对指定的py文件或整个项目进行导包顺序优化,以下面的代码为例,原始的导包顺序如下,其中demo是同级自定义包:
import pandas as pdimport numpy as npimport feffery_antd_components as facimport feffery_utils_components as fucimport reimport dashfrom demo import Demofrom dash import html, dcc通过在终端执行usort format main.py进行优化后,导包顺序被更新为如下状态,可以看到优化后的导包顺序遵循了前面所说的标准规范:
import reimport dashimport feffery_antd_components as facimport feffery_utils_components as fucimport numpy as npimport pandas as pdfrom dash import dcc, htmlfrom demo import Demo
且usort不会犯一些ide中格式化代码时,将一些必须在前面执行的代码逻辑误移动至导包逻辑后的错误,譬如下面的warnings.filterwarnings(),我们需要其在其他所有导包逻辑「之前」执行,以起到屏蔽相关警告信息的作用。
如果是使用ide中自带的代码美化快捷功能,可以看到美化后warnings.filterwarnings()被强制挪动到最后:

而usort就智能多了:
