使用 Python 创建和部署 HTTP Cloud Run functions 函数

注意：此内容仅适用于 Cloud Run functions，即原 Cloud Functions (第 2 代)。

如需了解本文档的第 1 代版本，请参阅使用 Python 创建和部署 HTTP Cloud Run functions（第 1 代）。

本指南将引导您完成使用 Python 运行时编写 Cloud Run functions 函数的过程。Cloud Run functions 函数有两种类型：

• HTTP 函数，通过标准 HTTP 请求调用。
• 事件驱动型函数，用于处理来自云基础设施的事件，例如 Pub/Sub 主题中收到消息或 Cloud Storage 存储桶发生更改。

如需了解详情，请参阅编写 HTTP 函数和编写事件驱动型函数。

准备工作

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

8. 安装并初始化 gcloud CLI。
注意：需要命令提示符？您可以使用 Cloud Shell。Cloud Shell 是一个已包含 Google Cloud CLI 的命令行环境，因此您无需再进行安装。Google Compute Engine 虚拟机也预装了 Google Cloud CLI。
9. 使用以下命令更新和安装 gcloud 组件。

   gcloud components update

10. 准备开发环境。

    转到 Python 设置指南

创建函数

1. 在本地系统上为函数代码创建一个目录：

   Linux 或 Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. 在 helloworld 目录中创建一个 main.py 文件，其中包含以下内容：

   
   import functions_framework
   
   
   from markupsafe import escape
   
   @functions_framework.http
   def hello_http(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       """
       request_json = request.get_json(silent=True)
       request_args = request.args
   
       if request_json and "name" in request_json:
           name = request_json["name"]
       elif request_args and "name" in request_args:
           name = request_args["name"]
       else:
           name = "World"
       return f"Hello {escape(name)}!"
   
   

   此示例函数会获取 HTTP 请求中提供的姓名并返回问候语；或者，如果没有提供姓名，则返回“Hello World!”。

指定依赖项

Python 依赖项可通过 pip 进行管理，并在名为 requirements.txt 的元数据文件中表示。此文件必须与包含函数代码的 main.py 文件位于同一目录中。

1. 在 helloworld 目录中创建一个 requirements.txt 文件，其中包含以下内容：

     # An example requirements file. If your function has other dependencies,
     # add them below
     functions-framework==3.*
   

了解详情：如需了解详情，请参阅指定依赖项。

在本地构建和测试函数

如需在部署函数之前在本地构建和测试函数，请执行以下操作：

1. 运行 Python 版软件包安装程序 pip 以安装软件包的依赖项：

   pip3 install -r requirements.txt
   PATH=$PATH:~/.local/bin
   

2. 使用 Functions 框架在本地运行函数：

   functions-framework-python --target hello_http
   

3. 在浏览器中访问 http://localhost:8080，或从其他窗口运行 curl localhost:8080，以测试函数。

   如需了解详情，请参阅向本地函数发送请求。

部署函数

如需部署函数，请在 helloworld 目录中运行以下命令：

  gcloud functions deploy python-http-function \
    --gen2 \
    --runtime=python312 \
    --region=REGION \
    --source=. \
    --entry-point=hello_http \
    --trigger-http \
    --allow-unauthenticated

将 REGION 替换为要部署函数的 Google Cloud 区域的名称（例如 us-west1）。

通过可选的 --allow-unauthenticated 标志，您可以在不进行身份验证的情况下访问函数。

了解详情：如需了解详情，请参阅部署 Cloud Run functions。

测试已部署的函数

1. 函数部署后，请记下 gcloud functions deploy 命令输出中的 uri 属性，或使用以下命令检索该属性：

   gcloud functions describe python-http-function \
     --region=REGION
   

   将 REGION 替换为您在其中部署函数的 Google Cloud 区域的名称（例如 us-west1）。

2. 在浏览器中访问此网址。该函数将返回一条“Hello World!”消息。

   注意：您还可以在 Google Cloud 控制台中找到此网址。前往“Cloud Run functions 概览”页面，点击函数的名称以打开其函数详情页面。打开触发器标签页以查看函数的网址。

查看函数日志

使用命令行工具查看日志

您可以使用 Cloud Logging 界面或通过 Google Cloud CLI 查看函数的日志。

如需使用 gcloud CLI 查看函数的日志，请使用 logs read 命令：

  gcloud functions logs read \
    --gen2 \
    --limit=10 \
    --region=REGION \
    python-http-function

将 REGION 替换为您在其中部署函数的 Google Cloud 区域的名称（例如 us-west1）。

输出类似以下内容：

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:42.991
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:41.933
LOG:

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:26.475
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

注意：日志条目可能需要稍微延迟一段时间才会显示在 Cloud Logging 中。

使用日志记录信息中心查看日志

要使用日志记录信息中心查看函数的日志，请打开 Cloud Run functions 概览页面，点击列表中的函数名称，然后点击日志标签页。

了解详情：如需了解详情，请参阅写入、查看和响应日志。