如何为Python库导入的大小写拼写错误生成有意义报错？

完全可以实现这种自动检测功能，核心是利用Python 3.7+支持的模块级__getattr__函数，结合你已有的大小写排列匹配逻辑，在用户导入错误名称时抛出带正确提示的报错。

具体实现步骤 #

1. 构建正确名称的映射表
   先把库中所有可公开导入的正确名称，按「小写形式→正确大小写名称」的规则存入字典。如果库的导出名称较多，可通过__all__或自动遍历模块成员来生成映射，不用手动维护。

2. 实现模块级__getattr__函数
   当用户尝试导入不存在的名称时，Python会自动调用模块的__getattr__方法。在这个方法里，将用户输入的错误名称转小写后去映射表查找，找到匹配项就抛出带正确导入语句的报错，没找到则抛出常规导入错误。

代码示例（以thislibrary为例） #

在库的根模块thislibrary/__init__.py中添加以下代码：

# 导入库内所有需要公开导出的类/函数
from .core import FooBar, AnotherClass, some_function

# 构建小写到正确名称的映射（如果有__all__可直接用__all__生成）
_CORRECT_NAMES = {
    name.lower(): name 
    for name in ["FooBar", "AnotherClass", "some_function"]
}

def __getattr__(name: str):
    lower_name = name.lower()
    if lower_name in _CORRECT_NAMES:
        correct_name = _CORRECT_NAMES[lower_name]
        raise ImportError(
            f"无法导入名称 '{name}'。正确的导入语句应为：\nfrom thislibrary import {correct_name}"
        )
    # 无匹配项时抛出常规导入错误
    raise ImportError(f"无法从 'thislibrary' 导入名称 '{name}'")

效果演示 #

当用户执行错误导入：

from thislibrary import Foobar

会触发如下报错：

ImportError: 无法导入名称 'Foobar'。正确的导入语句应为：
from thislibrary import FooBar

扩展说明 #

• 若库包含子模块（如transformers.models.llama），需要在对应的子模块__init__.py中重复上述逻辑，才能捕获子模块的导入错误。
• 如果你的大小写排列匹配逻辑更复杂（比如处理LLaMatokenizer这类特殊驼峰），只需替换映射表的生成逻辑，把你已有的匹配方法整合到__getattr__中即可。

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