模块导入顺序规范执行了吗

wen IT资讯 27

是的,以下是一些常见的模块导入顺序规范,通常由PEP 8(Python代码风格指南)以及一些工程实践所推荐,你可以检查你的项目是否遵循了这些规则:

模块导入顺序规范执行了吗

标准导入顺序 PEP 8 建议按以下三个分组(每组之间用空行隔开):

  1. 标准库导入
  2. 第三方库导入(如pandasflask
  3. 本地应用/库特定导入(如自己项目中的模块)

示例:

# 标准库
import os
import sys
# 第三方库
import pandas as pd
import numpy as np
# 本地模块
from my_project import config
from my_project.utils import helper

每一组内的排序

  • 建议按字母顺序排列。
  • 通常先导入import,再导入from ... import

实际执行情况 目前很多项目已经通过以下方式强制检查:

  • IDE自动格式化工具:如isort(自动排序导入)、ruffblack(可配置)。
  • 静态检查工具:如flake8(配合flake8-import-order插件)。
  • 预提交钩子(pre-commit hooks):在提交代码前自动检测导入顺序。

如何检查你的项目是否执行了?

  • 运行 isort --check-only .ruff check --select I .
  • 检查 pyproject.toml(或 .isort.cfg)中是否有相关配置。
  • 查看代码中导入部分是否按上述顺序排列、分组之间是否有空行。

如果你的项目没有执行: 建议集成 isortruff 作为自动格式化工具,并加入 CI/CD 流程(如 GitHub Actions)强制执行。

需要我帮你编写一个简单的 pre-commit 配置来强制执行这个规范吗?

抱歉,评论功能暂时关闭!