从Git部署Flask应用至Heroku时,解决gspread的Google Sheets认证文件缺失问题
Heroku环境下生成运行时临时Google服务账号认证文件的实现方案
之前触发FileNotFoundError的核心原因是:你将构造好的认证字典直接传入了ServiceAccountCredentials.from_json_keyfile_name()方法,该方法仅接受字符串格式的文件路径作为第一个参数,传入字典时会被强制解析为字符串当作路径检索文件,因此找不到对应文件。
实现核心逻辑
完全依托Python标准库的临时文件能力,在应用启动初始化认证的阶段,从环境变量读取参数拼接成合法的认证字典,在系统临时分区生成仅存在于当前运行实例的认证JSON文件,认证流程结束后立即删除临时文件。整个流程不需要将敏感认证文件提交到代码仓库,也不会在项目目录下残留敏感信息,完全适配Heroku的运行环境特性。
具体实现步骤
- 保留你已编写的
create_keyfile_dict()函数,该函数负责从环境变量读取所有认证字段、构造符合Google服务账号格式的认证字典,无需修改 - 引入Python标准库的
json、tempfile模块,不需要额外安装第三方依赖 - 在认证初始化阶段,将构造好的认证字典序列化写入临时文件,获取临时文件的实际存储路径
- 将临时文件路径传入原有的
ServiceAccountCredentials.from_json_keyfile_name()方法完成认证 - 通过异常捕获结构保证认证流程结束后,无论成功与否都主动删除临时文件,避免敏感文件残留
可直接复用的代码示例
import os import json import tempfile from gspread.auth import ServiceAccountCredentials def create_keyfile_dict(): variables_keys = { "type": os.environ.get("SHEET_TYPE"), "project_id": os.environ.get("SHEET_PROJECT_ID"), "private_key_id": os.environ.get("SHEET_PRIVATE_KEY_ID"), "private_key": os.environ.get("SHEET_PRIVATE_KEY"), "client_email": os.environ.get("SHEET_CLIENT_EMAIL"), "client_id": os.environ.get("SHEET_CLIENT_ID"), "auth_uri": os.environ.get("SHEET_AUTH_URI"), "token_uri": os.environ.get("SHEET_TOKEN_URI"), "auth_provider_x509_cert_url": os.environ.get("SHEET_AUTH_PROVIDER_X509_CERT_URL"), "client_x509_cert_url": os.environ.get("SHEET_CLIENT_X509_CERT_URL") } return variables_keys scope = [ 'https://spreadsheets.google.com/feeds', 'https://www.googleapis.com/auth/spreadsheets', "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive" ] # 生成临时认证文件 keyfile_dict = create_keyfile_dict() # 创建带.json后缀的临时文件,设置delete=False确保拿到文件路径后可以正常被其他模块读取 with tempfile.NamedTemporaryFile(mode='w', suffix='.json', delete=False) as tmp_file: json.dump(keyfile_dict, tmp_file) tmp_file_path = tmp_file.name try: # 将临时文件路径传入原有认证方法,逻辑和最初的设计完全一致 creds = ServiceAccountCredentials.from_json_keyfile_name(tmp_file_path, scope) finally: # 主动删除临时文件,无敏感信息残留 os.unlink(tmp_file_path)
适配Heroku的注意事项
- 上述生成的临时文件全程存储在Heroku dyno的内存临时分区中,实例销毁、重启时所有文件内容自动清空,不会同步到Git仓库,从根源上避免敏感信息泄露
- 配置环境变量中的
SHEET_PRIVATE_KEY字段时,必须保留原始JSON里的换行转义符\n,不要粘贴带真实换行的证书内容,否则会导致私钥解析失败 - 不要手动指定固定路径写入认证文件,固定路径大概率会落在Heroku的只读目录下触发权限报错,同时也存在被同实例其他进程误读的风险
内容的提问来源于stack exchange,提问作者Samuel Wölfl
相关产品推荐
相关产品推荐

