快速入门：使用 Python

快速入门：使用 Python

在本快速入门中，您将学习如何使用 Python 版 Apache Beam SDK 构建定义流水线的程序。然后，您可以使用直接本地运行程序或云端运行程序（如 Dataflow）来运行流水线。

准备工作

1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

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. 确保您的 Google Cloud 项目已启用结算功能。

4. Enable the Dataflow、Compute Engine、Cloud Logging、Cloud Storage、Google Cloud Storage JSON、BigQuery、Cloud Pub/Sub、Cloud Datastore 和 Cloud Resource Manager APIs.

   Enable the APIs

5. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the Project > Owner role to the service account.

      To grant the role, find the Select a role list, then select Project > Owner.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

      Do not close your browser window. You will use it in the next step.

6. Create a service account key:

   1. In the Google Cloud console, click the email address for the service account that you created.
   2. Click Keys.
   3. Click Add key, and then click Create new key.
   4. Click Create. A JSON key file is downloaded to your computer.
   5. Click Close.

7. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

   Example: Linux or macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Example: Windows

   For PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

   For command prompt:

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

8. 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

9. 确保您的 Google Cloud 项目已启用结算功能。

10. Enable the Dataflow、Compute Engine、Cloud Logging、Cloud Storage、Google Cloud Storage JSON、BigQuery、Cloud Pub/Sub、Cloud Datastore 和 Cloud Resource Manager APIs.

    Enable the APIs

11. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

       Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

       In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Project > Owner role to the service account.

       To grant the role, find the Select a role list, then select Project > Owner.

       Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
    6. Click Continue.

    7. Click Done to finish creating the service account.

       Do not close your browser window. You will use it in the next step.

12. Create a service account key:

    1. In the Google Cloud console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, and then click Create new key.
    4. Click Create. A JSON key file is downloaded to your computer.
    5. Click Close.

13. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

    Example: Linux or macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Example: Windows

    For PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    For command prompt:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

创建 Cloud Storage 存储桶：
1. In the Google Cloud console, go to the Cloud Storage Buckets page.

   Go to Buckets page

2. Click Create bucket.
3. On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.
   • For Name your bucket, enter a unique bucket name. Don't include sensitive information in the bucket name, because the bucket namespace is global and publicly visible.
   • For Choose where to store your data, do the following:
     • Select a Location type option.
     • Select a Location option.
   • For Choose a default storage class for your data, select the following: Standard.
   • For Choose how to control access to objects, select an Access control option.
   • For Advanced settings (optional), specify an encryption method, a retention policy, or bucket labels.
4. Click Create.
14. 复制 Google Cloud 项目 ID 和 Cloud Storage 存储桶名称。您将在本文档的后面部分用到这些值。

设置环境

Dataflow 不再支持使用 Python 2 的流水线。如需了解详情，请参阅 Google Cloud 上的 Python 2 支持页面。Dataflow 不支持 Python 3.9。请使用 Python 3.8 或更早版本。如需详细了解受支持的版本，请参阅 Apache Beam 运行时支持。

在本部分中，您将使用命令提示符，通过 venv 设置独立的 Python 虚拟环境来运行流水线项目。借助此过程，您可以将一个项目的依赖项与其他项目的依赖项隔离开来。

如果您没有便捷易用的命令提示符，可以使用 Cloud Shell。Cloud Shell 已经安装了适用于 Python 3 的软件包管理器，因此您可以跳过创建虚拟环境的过程。

如需安装 Python，然后创建虚拟环境，请按照以下步骤操作：

1. 检查系统中是否已运行 Python 3 和 pip：

   python --version
   python -m pip --version

2. 如有必要，请安装 Python 3，然后设置 Python 虚拟环境：按照设置 Python 开发环境页面的安装 Python 和设置 venv部分中提供的说明操作。

注意：Cython 不是必需项，但如果已安装，版本必须为 0.28.1 或更高版本。如需检查 Cython 版本，请运行 pip show cython。

完成快速入门后，您可以运行 deactivate 来停用虚拟环境。

获取 Apache Beam SDK

Apache Beam SDK 是一个用于数据流水线的开源编程模型。您可以使用 Apache Beam 程序定义流水线，然后选择 Dataflow 等运行程序来运行流水线。

如需下载并安装 Apache Beam SDK，请按照以下步骤操作：

1. 验证您在上一部分中创建的 Python 虚拟环境中。确保提示符以 <env_name> 开头，其中 env_name 是虚拟环境的名称。
2. 安装 Python wheel 打包标准：

   pip install wheel

3. 安装 Python 版 Apache Beam SDK 的最新版本：

pip install 'apache-beam[gcp]'

根据连接情况，安装可能需要一段时间。

在本地运行流水线

如需查看流水线如何在本地运行，请使用 wordcount 示例的现成 Python 模块，该模块随 apache_beam 软件包提供。

wordcount 流水线示例会执行以下操作：

1. 接收一个文本文件作为输入。

   此文本文件位于 Cloud Storage 存储桶中，其资源名称为 gs://dataflow-samples/shakespeare/kinglear.txt。

2. 将每一行解析为字词。
3. 对标记化字词进行词频计数。

如需在本地暂存 wordcount 流水线，请按照以下步骤操作：

1. 从本地终端运行 wordcount 示例：

   python -m apache_beam.examples.wordcount \
     --output outputs

2. 查看该流水线的输出：

   more outputs*

3. 如需退出，请按 q。

通过在本地运行流水线，您可以测试和调试 Apache Beam 程序。您可以在 Apache Beam GitHub 上查看 wordcount.py 源代码。

在 Dataflow 服务上运行流水线

在本部分中，将从 Dataflow 服务上的 apache_beam 软件包运行 wordcount 示例流水线。此示例指定 DataflowRunner 作为 --runner 的参数。

• 运行流水线：

  python -m apache_beam.examples.wordcount \
      --region DATAFLOW_REGION \
      --input gs://dataflow-samples/shakespeare/kinglear.txt \
      --output gs://STORAGE_BUCKET/results/outputs \
      --runner DataflowRunner \
      --project PROJECT_ID \
      --temp_location gs://STORAGE_BUCKET/tmp/

  请替换以下内容：

  • DATAFLOW_REGION：要在其中部署 Dataflow 作业的区域端点，例如 europe-west1

    --region 标志会替换元数据服务器、本地客户端或环境变量中设置的默认区域。

  • STORAGE_BUCKET：您之前复制的 Cloud Storage 名称
  • PROJECT_ID：您之前复制的 Google Cloud 项目 ID

查看结果

使用 Dataflow 运行流水线时，您的结果存储在 Cloud Storage 存储桶中。在本部分中，使用 Cloud Console 或本地终端验证流水线正在运行。

Cloud Console

要在 Cloud Console 中查看结果，请按照以下步骤操作：

1. 在 Cloud Console 中，转到 Dataflow 作业页面。

   转到作业

   作业页面会显示 wordcount 作业的详细信息，包括状态最初为正在运行，然后变为成功。

2. 转到 Cloud Storage 浏览器页面。

   转到浏览器

3. 在项目的存储桶列表中，点击您之前创建的存储桶。

   在 wordcount 目录中，系统会显示已创建的作业的输出文件。

本地终端

如需通过终端查看结果，请使用 gsutil 工具。 您也可以从 Cloud Shell 运行这些命令。

1. 列出输出文件：

   gsutil ls -lh "gs://STORAGE_BUCKET/results/outputs*"  

将 STORAGE_BUCKET 替换为流水线程序中使用的 Cloud Storage 存储桶的名称。

2. 查看输出文件中的结果：

   gsutil cat "gs://STORAGE_BUCKET/results/outputs*"

修改流水线代码

上述示例中的 wordcount 流水线区分大写和小写字词。以下步骤演示了如何修改流水线，以使 wordcount 流水线不区分大小写。

1. 在本地机器上，从 Apache Beam GitHub 代码库下载 wordcount 代码的最新副本。
2. 从本地终端运行流水线：

   python wordcount.py --output outputs

3. 查看结果。

   more outputs*

4. 如需退出，请按 q。
5. 在您选择的编辑器中，打开 wordcount.py 文件。
6. 在 run 函数中，检查流水线步骤：

   counts = (
           lines
           | 'Split' >> (beam.ParDo(WordExtractingDoFn()).with_output_types(str))
           | 'PairWIthOne' >> beam.Map(lambda x: (x, 1))
           | 'GroupAndSum' >> beam.CombinePerKey(sum))

   split 后面的几行被拆分为字符串形式的字词。

7. 如需对字符串进行小写处理，请修改 split 后面的行：

   counts = (
           lines
           | 'Split' >> (beam.ParDo(WordExtractingDoFn()).with_output_types(str))
           | 'lowercase' >> beam.Map(str.lower)
           | 'PairWIthOne' >> beam.Map(lambda x: (x, 1))
           | 'GroupAndSum' >> beam.CombinePerKey(sum)) 

   此修改会将 str.lower 函数映射到每个字词上。这一行相当于 beam.Map(lambda word: str.lower(word))。
8. 保存该文件并运行修改后的 wordcount 作业：

   python wordcount.py --output outputs

9. 查看修改后的流水线的结果：

   more outputs*

10. 如需退出，请按 q。

清理

为避免因本页中使用的资源导致您的 Google Cloud 帐号产生费用，请按照以下步骤操作。

注意：如果您在新项目中使用此快速入门，则可以 删除项目。

1. In the Google Cloud console, go to the Cloud Storage Buckets page.

   Go to Buckets

2. Click the checkbox for the bucket that you want to delete.
3. To delete the bucket, click Delete, and then follow the instructions.

后续步骤

• 了解 Apache Beam 编程模型。
• 使用 Apache Beam 笔记本以交互方式开发流水线。
• 了解如何设计和创建您自己的流水线。
• 完成 WordCount 和移动游戏示例。

Apache Beam^™ 是 Apache Software Foundation 或其关联公司在美国和/或其他国家/地区的商标。