Pylint类型别名类名格式警告的解决方法咨询

问题场景 #

我用类型别名优化代码可读性，写了类似这样的代码：

MAGIC_TYPE = str

def f(x: Thing) -> MAGIC_TYPE:
    pass

但Pylint一直报invalid-name错误：

Class name "HEADING_TYPE" doesn't conform to '[A-Z_][a-zA-Z0-9]+$' pattern [invalid-name] [3 times]

我不想修改类型别名的大写命名格式，也不想关闭Pylint的类名检查功能。另外注意到mypy文档里类型别名用类式大驼峰，但我觉得类型别名本质是类型而非类，更习惯用常量的全大写加下划线命名，想找个能兼顾的解决办法。

可行方案 #

1. 用typing.TypeAlias显式标记（Python 3.10+） #

从Python 3.10开始，typing模块新增了TypeAlias，用它显式声明变量是类型别名，Pylint会自动识别并跳过类名规则检查：

from typing import TypeAlias

MAGIC_TYPE: TypeAlias = str

def f(x: Thing) -> MAGIC_TYPE:
    pass

2. 修改Pylint配置添加命名例外 #

如果用的是Python 3.9及以下版本，或者不想引入TypeAlias，可以在Pylint配置文件里添加允许的命名规则：

• 如果你用.pylintrc：

[TYPECHECK]
# 单个添加指定的类型别名
good-names=MAGIC_TYPE,HEADING_TYPE
# 或者用通配符匹配所有以_TYPE结尾的大写名称
# good-names=*_TYPE

• 如果你用pyproject.toml：

[tool.pylint.typecheck]
# 单个添加指定的类型别名
good-names = ["MAGIC_TYPE", "HEADING_TYPE"]
# 通配符方式批量匹配
# good-names = ["*_TYPE"]

这种方式既能保留类名的命名检查，又能让你的大写类型别名通过校验。

3. 用typing_extensions的装饰器（兼容低版本Python） #

如果需要兼容Python 3.10以下版本，可以安装typing_extensions库，用@TypeAlias装饰器标记：

from typing_extensions import TypeAlias

@TypeAlias
MAGIC_TYPE = str

def f(x: Thing) -> MAGIC_TYPE:
    pass

Pylint同样会识别这个标记，不再报错。

关于命名风格的补充 #

虽然mypy文档推荐类式大驼峰命名类型别名，但Python官方并没有强制统一风格，你完全可以根据团队约定或个人习惯选择全大写格式，只要通过上述方法让Pylint兼容即可。

内容的提问来源于stack exchange，提问作者Att Righ