Python（FastAPI）中如何控制各包与文件的导入权限？是否有工具可在Git预提交或CI/CD中检查包导入规则？

针对你在大型FastAPI项目中需要强制执行导入权限规则（比如views可任意导入、services不能导入views、repositories不能导入services）的需求，以下几个工具和方案可以完美适配Git预提交钩子或CI/CD流程，类似Java中Checkstyle的ImportControl功能：

1. Import Linter（推荐，专门为依赖管控设计） #

import-linter是Python生态中专门用于检查模块间导入依赖规则的工具，配置简单直观，非常适合你的场景。

安装与配置 #

首先安装工具：

pip install import-linter

然后在项目根目录创建.importlinter.toml配置文件，定义你的导入规则：

[importlinter]
root_package = "your_project"  # 替换为你的项目根包名
include_external_packages = false  # 只检查内部模块

# 规则1：services模块禁止导入views
[importlinter.contracts.1]
name = "Services cannot import views"
type = "forbidden"
source_modules = ["your_project.services"]
forbidden_modules = ["your_project.views"]

# 规则2：repositories模块禁止导入services
[importlinter.contracts.2]
name = "Repositories cannot import services"
type = "forbidden"
source_modules = ["your_project.repositories"]
forbidden_modules = ["your_project.services"]

# 规则3：views模块允许导入任意内部模块
[importlinter.contracts.3]
name = "Views can import anything internally"
type = "allowed"
source_modules = ["your_project.views"]
allowed_modules = ["your_project.*"]

运行与集成 #

直接运行检查：

lint-imports

要集成到Git预提交钩子，在.pre-commit-config.yaml中添加：

repos:
-   repo: https://github.com/seddonym/import-linter
    rev: v2.12.0  # 使用最新版本号
    hooks:
    -   id: import-linter

2. Pylint 自定义检查器（高度灵活） #

如果需要更复杂的自定义规则，可以用Pylint编写自定义检查器，精准管控导入行为。

编写检查器 #

创建一个import_restriction_checker.py文件：

from pylint.checkers import BaseChecker
from pylint.interfaces import IAstroidChecker

class ImportRestrictionChecker(BaseChecker):
    __implements__ = IAstroidChecker

    name = 'import-restriction'
    priority = -1
    # 定义错误信息
    msgs = {
        'E9999': (
            'Services module cannot import views',
            'services-cannot-import-views',
            'Raised when a services module imports from views',
        ),
        'E9998': (
            'Repositories module cannot import services',
            'repos-cannot-import-services',
            'Raised when a repositories module imports from services',
        ),
    }

    def visit_importfrom(self, node):
        # 获取当前模块的完整名称
        current_module = node.root().name
        # 检查services模块导入views的情况
        if current_module.startswith('your_project.services') and node.modname.startswith('your_project.views'):
            self.add_message('services-cannot-import-views', node=node)
        # 检查repositories模块导入services的情况
        elif current_module.startswith('your_project.repositories') and node.modname.startswith('your_project.services'):
            self.add_message('repos-cannot-import-services', node=node)

def register(linter):
    linter.register_checker(ImportRestrictionChecker(linter))

配置与集成 #

在.pylintrc中添加插件路径：

[MASTER]
load-plugins = import_restriction_checker  # 替换为你的检查器文件路径

运行Pylint检查：

pylint your_project

同样可以把Pylint集成到pre-commit或CI/CD流程中。

3. Flake8 限制导入插件（轻量集成） #

如果你的项目已经在使用Flake8做代码检查，可以用flake8-restrict-imports插件快速添加导入规则。

安装与配置 #

安装插件：

pip install flake8-restrict-imports

在.flake8配置文件中添加规则：

[flake8]
restrict-imports = your_project.services:your_project.views; your_project.repositories:your_project.services

格式说明：源模块:禁止导入的模块，多个规则用分号分隔。

运行与集成 #

直接运行Flake8检查即可，它会自动触发导入规则检查，同样可以集成到pre-commit或CI/CD。

集成到CI/CD流程 #

不管选择哪个工具，都可以在CI/CD脚本中添加对应的检查步骤。比如在GitHub Actions中：

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - name: Install dependencies
        run: pip install import-linter pylint flake8 flake8-restrict-imports
      - name: Run import linter
        run: lint-imports
      - name: Run pylint
        run: pylint your_project
      - name: Run flake8
        run: flake8 your_project

内容的提问来源于stack exchange，提问作者Peter F