设置 Python 开发环境

本教程介绍如何为 Python 开发(包括开发在 Google Cloud上运行的 Python 应用)准备本地机器。

如果您已设置开发环境,请参阅 Python 和 Google Cloud,大致了解如何在 Google Cloud上运行 Python 应用。

提示:如果您想要快速上手,Cloud Shell Editor 可为 Google Kubernetes Engine 和 Cloud Run 应用的整个开发周期提供 IDE 支持。Cloud Shell Editor 基于 Code OSS,并预安装了 Google Cloud CLI 和 Cloud Code 工具。

目标

  • 安装与 Google Cloud兼容的受支持的 Python 版本
  • 使用 venv 隔离依赖项。
  • 安装编辑器(可选)。
  • 安装 Google Cloud CLI(可选)。
  • 安装 Python 版 Cloud 客户端库(可选)。
  • 安装其他有用的工具。
  • 设置身份验证(可选)。

安装 Python

Python 的安装说明因操作系统而异。您可以按照您在开发环境中所用的操作系统(macOS、Windows 或 Linux)的相应指南安装 Python。

macOS

macOS 默认包含一个 Python 版本以供自用。为避免干扰 macOS,建议您创建一个单独的开发环境,并为 Google Cloud安装受支持的 Python 版本。如需安装 Python,请使用 homebrew

  1. 如需使用 homebrew 安装 Python 软件包,您需要一个编译器,该编译器可以通过安装 Xcode 的命令行工具来获得。

    xcode-select --install
    
  2. 按照 homebrew 首页上的说明安装 homebrew,然后使用 homebrew 安装 Python,如下所示:

    brew install pyenv
    pyenv install PYTHON_VERSION
    

    Python 版本号应采用 x.y 格式。例如:

    pyenv install 3.12
    
  3. 安装完成后,验证 Python 3 是否作为 pythonpython3 提供,以及是否已安装 pip

    要验证 Python 是否可用,请运行以下命令:

    python3 --version
    

    输出将显示版本。 您可以在 Homebrew Python Formulae 页面中了解 Python homebrew,然后检查您的版本。

    如需验证 pip3 是否可用,请运行以下命令:

    pip3 --version
    

    如果已安装,输出会显示 pip3 版本。如需详细了解最新版 pip3,请参阅pip 版本说明

    如果上述命令未显示 pip3 版本,请确保 pip3 已正确安装。如果 pip3 已安装但无法正常运行,请使用以下命令升级到最新版本:

    python -m pip install --upgrade pip
    

    Homebrew 将在您的平台上安装最新版本的 Python。输出中的版本号可能与 Python 的最新官方版本不同。

Windows

  1. 如需在 Windows 环境中安装 Python,请从 Python 网站下载所需 Python 版本的安装程序。 如需了解详情,请参阅 Google Cloud的支持的 Python 版本

  2. 要访问您的 Python 版本,请使用适用于 Windows 的 Python 启动器

    如需启动您安装的 Python 版本,请运行以下命令:

    py
    

    如需启动您安装的 Python 3 版本,请运行以下命令:

    py -3
    

    如需验证可用的 pip 版本,请运行以下命令:

    py -m pip --version
    

    输出将显示 C:\users\[USERNAME]\appdata\local\programs\python\python38-32\lib\site-packages 中的版本。

    您可以在 pip 版本说明中了解最新版本的 pip

Linux

大多数 Linux 发行版都包含最新版本的 Python。

  1. 要在 Linux 环境中安装 Python,请为您的发行版安装相应的软件包。对于 Debian 和 Ubuntu,对应的软件包为 python3python3-devpython3-venvpython3-pip

    使用以下命令安装这些软件包:

    sudo apt update
    sudo apt install python3 python3-dev python3-venv python3-pip
    
  2. 安装完成后,验证是否已安装 pip

    pip3 --version
    

    您可以在 pip 版本说明中了解最新版本的 pip

使用 venv 隔离依赖项

venv 是一款用于创建独立的 Python 环境的工具。这些独立的环境可以使用单独的 Python 软件包版本,以便将一个项目的依赖项与其他项目的依赖项隔离开来。使用 Python 进行本地开发时,建议您始终按项目设置虚拟环境。

  1. 使用 venv 命令创建整个 Python 安装的虚拟副本。本教程将在一个名为 env 的文件夹中创建虚拟副本,但您可以为该文件夹指定任何名称。

    macOS

    cd your-project
    python -m venv env
    

    Windows

    cd your-project
    py -m venv env
    

    Linux

    cd your-project
    python3 -m venv env
    
  2. 通过激活该虚拟环境,将 shell 设置为针对 Python 使用 venv 路径:

    macOS

    source env/bin/activate
    

    Windows

    .\env\Scripts\activate
    

    Linux

    source env/bin/activate
    
  3. 现在,您可以在不影响其他项目或全局 Python 安装的情况下安装软件包:

    pip install google-cloud-storage
    

    如果您要停止使用虚拟环境并返回到全局 Python,可以运行以下命令将其停用:

    deactivate
    

您可以在venv文档中详细了解 venv

安装编辑器

要开发 Python 应用,您需要一个编辑器。以下是一些比较常用的编辑器(排名不分先后):

安装 Python 版 Cloud 客户端库

Python 开发者利用 Python 版 Cloud 客户端库与 Datastore 和 Cloud Storage 等 Google Cloud 服务进行集成。要安装 Cloud Storage 等单个 API 的软件包,请使用类似于以下所示的命令:

pip install --upgrade google-cloud-storage

安装 gcloud CLI

gcloud CLI 是一套适用于 Google Cloud的命令行工具。它包含 gcloudbq,可用于通过命令行访问 Compute Engine、Cloud Storage、BigQuery 以及其他产品和服务。这些工具既能以交互方式使用,也可以在自动化脚本中运行。

设置身份验证

如需使用客户端库,您必须先设置身份验证。

If you're using a local shell, then create local authentication credentials for your user account:

gcloud auth application-default login

You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

如需了解详情,请参阅使用客户端库时进行身份验证

后续步骤