如何在Python项目CI/CD流程中强制要求编写类型提示

方案一：搭配mypy实现高可靠性校验（推荐） #

Pylint原生对类型提示缺失的校验能力有限，专门的类型检查工具mypy是行业主流选择，和你现有的GitHub Actions流水线集成成本极低：

• 安装依赖：pip install mypy
• 在项目根目录新增mypy.ini配置文件，按需调整规则：
  如果你需要全局强制所有函数加类型提示：

  [mypy]
  disallow_untyped_defs = True
  disallow_incomplete_defs = True
  exclude = [
      "tests/",
      "*/__init__.py",
      "third_party/"
  ]
  

  如果你只需要强制公共函数/方法加类型提示，关闭全局规则后，给公共模块的文件头部加# mypy: disallow_untyped_defs注释，或者用per_module_options配置指定公共模块的校验规则即可。
• 在你的GitHub Actions workflow配置文件中，新增mypy校验步骤，放在black、Pylint步骤之后即可：

  - name: 执行类型提示校验
    run: mypy your_project_source_dir/
  

  只要类型提示不符合规则，mypy会返回非零退出码，直接中断CI流水线，达到强制校验的效果。

方案二：仅通过Pylint实现校验 #

如果你希望只依赖现有Pylint工具实现，需要调整Pylint配置启用相关规则：

• 首先升级Pylint到2.10及以上版本，低版本对类型提示规则的支持不完善
• 修改你的.pylintrc配置文件，新增以下配置：

  [MESSAGES CONTROL]
  enable = missing-type-doc, missing-return-type-doc, missing-param-type
  
  [TYPECHECK]
  missing-type-doc = error
  missing-return-type-doc = error
  missing-param-type = error
  

  调整后Pylint会把缺少类型提示的情况标记为错误，触发CI校验失败。该方案的缺点是Pylint对复杂类型、泛型的校验准确性远低于mypy，适合要求较低的场景。

可选优化 #

• 可以在本地开发环节配置pre-commit钩子，提交代码前先执行类型校验，减少CI失败的概率
• 如果需要豁免内部私有函数的校验，可给对应函数加@typing.no_type_check装饰器即可跳过校验

内容的提问来源于stack exchange，提问作者Adam Matan