GCP Cloud Functions如何引入全局config.py？项目结构优化咨询

部署GCP Cloud Functions时，你指定的--source是单个Cloud Function的目录，GCP只会打包该目录下的文件，repo_master根目录的config.py并没有被包含到部署包中，所以函数运行时找不到该文件。本地能正常运行是因为你的本地环境包含整个仓库目录，sys.path.append能定位到根目录的配置文件，但部署后这个路径在GCP的运行环境中不存在。

方案1：调整部署命令，打包整个仓库并指定入口函数 #

无需复制配置文件，保持目录结构整洁，核心是让GCP打包整个repo_master仓库，同时指定每个Cloud Function的入口路径。

步骤： #

1. 将config.py移动到repo_master根目录。
2. 修改GitHub Actions的部署命令：
   • 将--source改为repo_master根目录（即.）
   • 添加--entry-point参数，指定函数的完整路径（格式：{子仓库名}.{函数目录名}.main.{入口函数名}）
   • 更新matrix配置，为每个函数定义对应的入口路径

示例deploy.yml片段：

jobs:
  deploy:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        function:
          - name: "repo_a/cloud_function_a"
            entry_point: "repo_a.cloud_function_a.main.handle_request"  # 替换为你的实际入口函数名
          - name: "repo_a/cloud_function_b"
            entry_point: "repo_a/cloud_function_b.main.handle_request"
          # 其他函数同理
    steps:
      - uses: actions/checkout@v4
      - name: Deploy to GCP Cloud Functions
        run: |
          gcloud functions deploy ${{ matrix.function.name }} \
              --gen2 \
              --trigger-http \
              --source=. \
              --entry-point=${{ matrix.function.entry_point }} \
              --runtime=${{ env.RUNTIME }} \
              --region=${{ env.REGION }} \
              --memory=${{ env.MEMORY }} \
              --service-account=${{ env.WORKFLOWS_SA }} \
              --timeout=${{ env.TIMEOUT }} \
              --no-allow-unauthenticated \
              --set-secrets="GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT:latest,GOOGLE_CLOUD_PROJECT_NUMBER=GOOGLE_CLOUD_PROJECT_NUMBER:latest"

3. 修改main.py的导入语句（可简化，因为整个仓库被打包，根目录在运行环境的sys.path中）：

from config import CONFIG_VARIABLE

如果导入仍有问题，保留原来的sys.path配置即可，此时路径在部署环境中是有效的。

方案2：将全局配置封装为Python包 #

遵循Python包结构规范，把全局配置做成可导入的模块，避免手动修改sys.path。

步骤： #

1. 在repo_master根目录创建shared_config目录，结构如下：

|-repo_master
    |-shared_config
        |-__init__.py
        |-config.py  # 存放全局CONFIG_VARIABLE

2. 将原有的全局配置内容迁移到shared_config/config.py中。
3. 在每个Cloud Function的requirements.txt中添加本地开发依赖（可选，方便本地调试）：

-e ../..  # 指向repo_master根目录，让Python识别shared_config包

4. 修改main.py的导入语句：

from shared_config.config import CONFIG_VARIABLE

5. 部署时使用方案1的部署命令（打包整个仓库并指定entry-point），确保shared_config被包含到部署包中。

方案3：使用GCP环境变量/Secret Manager管理配置（推荐） #

完全分离代码与配置，符合Serverless最佳实践，无需维护配置文件，避免路径问题。

步骤： #

1. 将CONFIG_VARIABLE添加到GCP环境变量或Secret Manager：
   • 如果是普通配置，在GCP控制台为每个Cloud Function设置环境变量，或者在deploy命令中添加--set-env-vars="CONFIG_VARIABLE=你的配置值"
   • 如果是敏感配置，将其存入Secret Manager，然后在deploy命令中添加--set-secrets="CONFIG_VARIABLE=projects/你的项目ID/secrets/你的密钥名:latest"
2. 修改main.py，直接从环境变量读取配置：

import os
CONFIG_VARIABLE = os.environ.get("CONFIG_VARIABLE")

3. 保持原有的部署命令不变，无需调整source路径，也不需要配置文件。

方案4：部署前自动复制全局配置到函数目录 #

自动化复制配置文件到每个函数目录，无需修改原有部署逻辑，适合希望保持每个函数独立性的场景。

步骤： #

1. 将config.py移动到repo_master根目录。
2. 在GitHub Actions的deploy.yml中添加复制步骤，部署前将config.py复制到所有函数目录：

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Copy global config to function directories
        run: |
          # 遍历所有子仓库下的Cloud Function目录，复制config.py
          for func_dir in repo_*/cloud_function_*; do
            cp config.py "$func_dir/"
          done
      # 后续的部署步骤不变

3. 修改main.py的导入语句，直接导入当前目录的config.py：

from config import CONFIG_VARIABLE

4. （可选）将函数目录下的config.py加入.gitignore，避免提交副本到仓库：

# 在repo_master根目录的.gitignore中添加
repo_*/cloud_function_*/config.py

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