构建 Python 项目

本指南涵盖的内容 #

有关语言版本和其他构建环境特定信息，请访问我们的参考页面

• 精确
• Trusty
• Xenial
• Bionic
• Focal
• Jammy
• macOS
• FreeBSD

macOS 和 Windows 环境中不提供 Python 构建。

本指南的其余部分介绍如何在 Travis CI 中配置 Python 项目。如果您不熟悉 Travis CI，请先阅读我们的 教程 和 构建配置 指南。

指定 Python 版本 #

使用 python 键指定 Python 版本。随着我们更新 Python 构建镜像，诸如 3.6 之类的别名将指向不同的精确版本或补丁级别。

language: python
python:
  - "2.7"
  - "3.4"
  - "3.5"
  - "3.6"      # current default Python on Travis CI
  - "3.7"
  - "3.8"
  - "3.9"
  - "3.9-dev"  # 3.9 development branch
  - "nightly"  # nightly build
# command to install dependencies
install:
  - pip install -r requirements.txt
# command to run tests
script:
  - pytest

如果在当前构建镜像上找不到指定的 Python 版本，则作业将尝试下载合适的远程归档文件并使其可用。您可以在 下面的表格 中找到此类版本的列表。

Travis CI 使用隔离的 virtualenv #

CI 环境为每个 Python 版本使用单独的 virtualenv 实例。这意味着，一旦您在 .travis.yml 中指定 language: python，您的测试将在 virtualenv 内运行（无需您显式创建它）。不使用系统 Python，也不应依赖于它。如果需要安装 Python 包，请通过 pip 而不是 apt 进行安装。

如果您决定仍然使用 apt，请注意，出于兼容性原因，您只能使用 Ubuntu 中可用的默认 Python 版本（例如，对于 Xenial，这意味着 2.7.12 和 3.5.2）。要访问 virtualenv 内的包，您需要指定它应该使用 --system-site-packages 选项创建。为此，请在您的 .travis.yml 中包含以下内容

language: python
python:
  - "2.7"
  - "3.5"
virtualenv:
  system_site_packages: true

PyPy 支持 #

Travis CI 支持 PyPy 和 PyPy3。

要针对 PyPy 测试您的项目，请将“pypy”和/或“pypy3”添加到 .travis.yml 中的 Python 列表中

language: python
python:
  - "2.7"
  - "3.8"
  # PyPy versions
  - "pypy"   # currently Python 2.7.13, PyPy 7.1.1
  - "pypy3"  # currently Python 3.6.9,  PyPy 7.3.1
# command to install dependencies
install:
  - pip install -r requirements.txt
  - pip install .
# command to run tests
script: pytest

夜间构建支持 #

Travis CI 支持一个特殊的版本名称 nightly，它指向 CPython 构建的最新开发版本。

开发版本支持 #

从 Python 3.5 及更高版本开始，提供了 Python 开发版本。

您可以在构建中使用 3.5-dev、3.6-dev、3.7-dev、3.8-dev、3.9-dev、3.10-dev 或 3.11-dev 指定它们

默认构建脚本 #

Python 项目需要在其 .travis.yml 中提供 script 键以指定要使用哪个命令运行测试。

例如，如果您的项目使用 pytest

# command to run tests
script: pytest

如果它改为使用 make test

script: make test

如果您没有在 Python 项目中提供 script 键，Travis CI 将打印一条消息（“请在您的 .travis.yml 中覆盖 script: 键以运行测试。”）并使构建失败。

使用 Tox 作为构建脚本 #

由于 Travis 的设计方式，与 tox 的交互并不简单。如上所述 所述，只要指定 language: python，Travis 就会在隔离的 virtualenv 内运行测试，因此在使用 tox 创建更多环境时请牢记这一点。如果您希望在 Travis 创建的 virtualenv 之外运行 tox，最好使用 language: generic 而不是 language: python。

如果您使用 tox 来测试代码以针对多个版本的 Python，则有两个选项

• 使用 language: generic 并手动安装您感兴趣的 Python 版本，然后再运行 tox（如果没有手动安装，tox 将只能访问默认的 Ubuntu Python 版本 - Xenial 的 2.7.12 和 3.5.2）
• 使用 language: python 和一个构建矩阵，该矩阵为每个分支使用不同的 Python 版本（您可以使用 python 键指定 Python 版本）。这将确保安装您感兴趣的版本并使您的工作负载并行化。

在多个操作系统上运行 Python 测试 #

有时需要确保软件在多个操作系统上都能正常工作。以下 .travis.yml 文件将在 Linux、macOS 和 Windows 上执行并行测试运行。

language: python            # this works for Linux but is an error on macOS or Windows
jobs:
  include:
    - name: "Python 3.8.0 on Xenial Linux"
      python: 3.8           # this works for Linux but is ignored on macOS or Windows
    - name: "Python 3.6.10 on FreeBSD"
      os: freebsd
      language: python
    - name: "Python 3.7.4 on macOS"
      os: osx
      osx_image: xcode11.2  # Python 3.7.4 running on macOS 10.14.4
      language: shell       # 'language: python' is an error on Travis CI macOS
    - name: "Python 3.8.0 on Windows"
      os: windows           # Windows 10.0.17134 N/A Build 17134
      language: shell       # 'language: python' is an error on Travis CI Windows
      before_install:
        - choco install python --version 3.8.0
        - python -m pip install --upgrade pip
      env: PATH=/c/Python38:/c/Python38/Scripts:$PATH
install: pip3 install --upgrade pip  # all three OSes agree about 'pip3'
# 'python' points to Python 2.7 on macOS but points to Python 3.8 on Linux and Windows
# 'python3' is a 'command not found' error on Windows but 'py' works on Windows only
script: python3 my_app.py || python my_app.py

依赖项管理 #

pip #

默认情况下，Travis CI 使用 pip 来管理 Python 依赖项。如果您有 requirements.txt 文件，Travis CI 会在构建的 install 阶段运行 pip install -r requirements.txt。

您可以手动覆盖此默认 install 阶段，例如

install: pip install --user -r requirements.txt

请注意，如果您不使用 language: python，则 --user 选项是必需的，因为在这种情况下不会创建 virtualenv。

pip 20.3 中的新依赖项解析器 #

如 PyPa 公告中所述，pip 20.3 版本将附带一个新的依赖项解析器。这可能会对您的软件造成意外更改；当我们将来部署包含此版本的新的构建镜像时，由于与此版本相关的更改，您的构建可能会中断。

为了测试新的依赖项解析器对您软件的影响，我们建议您使用 pip 20.2 版本进行测试。为此，请修改您的构建以将 pip 更新到 20.2 版本，并使用 --use-feature=2020-resolver 标志调用 pip。例如

before_install:
  - python -m pip install --upgrade pip
install:
  - pip install --user -r requirements.txt --use-feature=2020-resolver

自定义依赖项管理 #

要覆盖默认的 pip 依赖项管理，请更改 before_install 步骤，如 常规构建配置 指南中所述。

针对依赖项的多个版本进行测试（例如 Django 或 Flask） #

如果您需要针对多个版本的 Django（或其他软件）进行测试，您可以指示 Travis CI 使用不同的环境变量集或值进行多次运行。

例如，在您的 .travis.yml 文件中使用 env 键

env:
  - DJANGO_VERSION=2.1.13
  - DJANGO_VERSION=2.2.6

然后在您的依赖项安装脚本、测试用例或测试脚本参数值中使用 ENV 变量值。这里我们使用 ENV 变量值来指示 pip 安装特定版本

install:
  - pip install -q Django==$DJANGO_VERSION
  - python setup.py -q install

同样的技术通常用于针对多个数据库等进行项目的测试。

有关实际示例，请参见 getsentry/sentry 和 jpvanhal/flask-split。

构建配置参考 #

您可以在我们的 Travis CI 构建配置参考 中找到有关 Python 的构建配置格式的更多信息。

示例 #

• tornadoweb/tornado
• simplejson/simplejson
• fabric/fabric
• dstufft/slumber
• dreid/cotools
• twisted/klein

Python 版本 #

这些归档文件可按需安装。