使用boto3-stubs做类型检查时出现两类错误的原因排查
错误1:类型未定义(name-defined)
你遇到的第一个错误是因为类型的导入和引用方式不正确。虽然你导入了mypy_boto3_secretsmanager.type_defs模块,但直接用完整路径字符串引用类型时,mypy无法正确解析。
修复方法:
修改typing.TYPE_CHECKING块内的导入语句,直接导入所需的客户端和类型:
if typing.TYPE_CHECKING: from mypy_boto3_secretsmanager import SecretsManagerClient from mypy_boto3_secretsmanager.type_defs import SecretValueEntryTypeDef
然后更新代码中的类型注解,无需使用完整模块路径:
def main() -> None: client: SecretsManagerClient = boto3.client('secretsmanager') # ... secrets: list[SecretValueEntryTypeDef] = client.batch_get_secret_value( SecretIdList=raw_config['secrets'] )['SecretValues']
错误2:客户端无batch_get_secret_value方法(attr-defined)
这个错误说明mypy无法在SecretsManagerClient的stub定义中找到该方法,常见原因有两个:
原因1:未安装对应服务的专用stubs
通用的boto3-stubs包可能不包含所有服务的完整定义,需要单独安装SecretsManager的专用stubs。执行以下命令安装:
pip install mypy_boto3_secretsmanager
原因2:boto3与stubs版本不兼容
即使你说stubs是最新版本,也可能存在boto3版本与stubs版本不匹配的情况。运行以下命令检查版本:
pip show boto3 mypy_boto3_secretsmanager
确保mypy_boto3_secretsmanager的版本与boto3版本同步(通常stubs版本会跟随boto3的版本号,比如boto3 1.34.x对应mypy_boto3_secretsmanager 1.34.x)。如果版本不匹配,升级或降级其中一方以保持一致。
额外检查:
如果以上方法都无效,可以直接查看stubs的源代码(在Python环境的site-packages/mypy_boto3_secretsmanager目录下),确认SecretsManagerClient类中是否存在batch_get_secret_value方法。如果确实不存在,可能是stubs包的bug,需要等待更新或提交issue。
内容的提问来源于stack exchange,提问作者Eleanor Holley

