Python高级技术之：`Python`的`tox`：如何实现多版本`Python`环境的测试。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

咳咳，各位观众，各位朋友，欢迎来到今天的“Python 高级杂耍”讲座！今天咱们要聊的是一个能让你的 Python 代码在各种环境下“百炼成钢”的秘密武器——tox。

开场白：你是否也有这样的烦恼？

想象一下，你辛辛苦苦写了一个 Python 库，功能强大，代码优雅。你信心满满地发布到 PyPI 上，结果… 用户反馈：

“在 Python 3.7 上跑不起来！”
“我的 Django 2.2 项目用不了你的库！”
“在 Windows 上报错，Linux 上正常！”

是不是感觉头大？原因很简单，你的代码可能只在你自己的 Python 环境中测试过，忽略了其他环境的兼容性问题。

tox：多环境测试的救星

tox 就是来解决这个问题的。它是一个自动化测试工具，可以在多个 Python 环境中运行你的测试，确保你的代码在各种情况下都能正常工作。

tox 的核心概念

虚拟环境 (Virtual Environment): tox 会为你创建独立的 Python 虚拟环境，每个环境都可以安装不同的 Python 版本和依赖包，保证环境的隔离性。
配置 (Configuration): tox 通过 tox.ini 文件来配置测试环境和运行的命令。
命令 (Commands): 你可以在 tox.ini 中定义需要在每个环境中运行的命令，比如安装依赖、运行测试等。

tox.ini：tox 的灵魂

tox 的配置都写在 tox.ini 文件里。这个文件通常放在你的项目根目录下。下面是一个简单的 tox.ini 示例：

[tox]
envlist = py37, py38, py39, py310

[testenv]
deps =
    pytest
commands =
    pytest

这个 tox.ini 文件做了什么？

[tox] 部分：定义了全局配置。
- envlist = py37, py38, py39, py310: 告诉 tox 创建四个虚拟环境，分别使用 Python 3.7, 3.8, 3.9 和 3.10。
[testenv] 部分：定义了测试环境的配置。
- deps = pytest: 告诉 tox 在每个虚拟环境中安装 pytest 测试框架。
- commands = pytest: 告诉 tox 在每个虚拟环境中运行 pytest 命令来执行测试。

实战演练：用 tox 测试你的代码

假设你有一个简单的 Python 库，项目结构如下：

my_library/
├── my_library/
│   ├── __init__.py
│   └── my_module.py
├── tests/
│   └── test_my_module.py
└── tox.ini

my_module.py 的内容：

def add(x, y):
    return x + y

test_my_module.py 的内容：

from my_library.my_module import add

def test_add():
    assert add(1, 2) == 3
    assert add(-1, 1) == 0
    assert add(0, 0) == 0

现在，我们来运行 tox 命令：

tox

tox 会自动创建虚拟环境，安装依赖，并运行测试。如果一切顺利，你会看到类似这样的输出：

...
  py37: commands succeeded
  py38: commands succeeded
  py39: commands succeeded
  py310: commands succeeded
  congratulations :)

这意味着你的代码在 Python 3.7, 3.8, 3.9 和 3.10 上都通过了测试！

tox.ini 的高级用法

tox.ini 还有很多高级用法，可以满足更复杂的测试需求。

指定 Python 版本:

除了 envlist 之外，你还可以使用 basepython 来更精确地指定 Python 版本。
```
[testenv:py37]
basepython = python3.7

[testenv:py38]
basepython = python3.8
```

安装不同的依赖:

你可以为不同的环境安装不同的依赖。

[testenv:django22]
deps =
    Django==2.2
    pytest-django

[testenv:django32]
deps =
    Django==3.2
    pytest-django

自定义命令:

你可以定义需要在每个环境中运行的自定义命令。
```
[testenv]
commands =
    flake8 my_library
    pytest
```
这个例子中，tox 会先运行 flake8 来检查代码风格，然后再运行 pytest 来执行测试。
使用环境变量:

你可以在 tox.ini 中使用环境变量。
```
[testenv]
setenv =
    DJANGO_SETTINGS_MODULE = my_library.settings
commands =
    pytest
```
这个例子中，tox 会设置 DJANGO_SETTINGS_MODULE 环境变量，然后再运行 pytest。
跳过环境:

你可以使用 -e 选项来指定要运行的环境，或者使用 -skip-missing-interpreters 选项来跳过找不到 Python 解释器的环境。
```
tox -e py37,py38  # 只运行 py37 和 py38 环境
tox -skip-missing-interpreters # 跳过找不到 Python 解释器的环境
```

矩阵测试 (Matrix Testing):

tox 支持矩阵测试，可以组合不同的环境配置。

[tox]
envlist =
    py{37,38,39,310}-{django22,django32}

[testenv]
deps =
    {[testenv:py37-django22]
    Django==2.2
    pytest-django}
    {[testenv:py37-django32]
    Django==3.2
    pytest-django}
    {[testenv:py38-django22]
    Django==2.2
    pytest-django}
    {[testenv:py38-django32]
    Django==3.2
    pytest-django}
    {[testenv:py39-django22]
    Django==2.2
    pytest-django}
    {[testenv:py39-django32]
    Django==3.2
    pytest-django}
    {[testenv:py310-django22]
    Django==2.2
    pytest-django}
    {[testenv:py310-django32]
    Django==3.2
    pytest-django}
commands =
    pytest

这个例子中，tox 会创建 8 个环境，分别对应 Python 3.7, 3.8, 3.9, 3.10 和 Django 2.2, 3.2 的组合。依赖的配置也使用了条件表达式，根据环境选择不同的 Django 版本。

tox 与 CI/CD

tox 非常适合与 CI/CD (持续集成/持续部署) 工具集成，比如 Jenkins, GitLab CI, GitHub Actions 等。你可以在 CI/CD 流水线中运行 tox 命令，确保每次代码提交都能通过所有环境的测试。

使用 GitHub Actions 运行 tox

下面是一个使用 GitHub Actions 运行 tox 的示例：

name: Test

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.7, 3.8, 3.9, 3.10]

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install tox
    - name: Run tox
      run: tox

这个 GitHub Actions 工作流做了什么？

on: 定义了触发工作流的事件，包括 push 到 main 分支和 pull_request 到 main 分支。
jobs: 定义了要运行的任务。
- build: 定义了一个名为 build 的任务。
  - runs-on: 指定了运行任务的操作系统，这里是 ubuntu-latest。
  - strategy: 定义了运行任务的策略，这里使用了矩阵策略，分别使用 Python 3.7, 3.8, 3.9 和 3.10 运行任务。
  - steps: 定义了任务的步骤。
    - actions/checkout@v2: 检出代码。
    - actions/setup-python@v2: 设置 Python 环境。
    - Install dependencies: 安装 tox。
    - Run tox: 运行 tox 命令。

表格总结 tox.ini 常用配置项

配置项	描述
`[tox]`	全局配置
`envlist`	指定要创建的虚拟环境列表，例如 `py37, py38, py39`。
`[testenv]`	测试环境配置
`basepython`	指定 Python 解释器，例如 `python3.7`。
`deps`	指定要安装的依赖包，例如 `pytest, requests`。
`commands`	指定要运行的命令，例如 `pytest, flake8`。
`setenv`	设置环境变量，例如 `DJANGO_SETTINGS_MODULE = my_library.settings`。
`passenv`	从宿主环境传递环境变量到虚拟环境，例如 `HOME, PATH`。
`skip_install`	如果设置为 `True`，则跳过依赖包的安装。
`changedir`	改变当前工作目录，例如 `src`。
`ignore_errors`	如果设置为 `True`，则忽略命令执行错误。
`whitelist_externals`	允许执行外部命令，例如 `make`。
`usedevelop`	如果设置为 `True`，则使用 `python setup.py develop` 安装包，方便本地开发调试。

tox 的优点

自动化: 自动创建虚拟环境，安装依赖，运行测试。
隔离性: 每个环境都是独立的，避免依赖冲突。
可配置: 可以灵活配置测试环境和运行的命令。
易于集成: 方便与 CI/CD 工具集成。
提高代码质量: 确保代码在各种环境下都能正常工作。

tox 的缺点

配置复杂: tox.ini 文件可能会变得比较复杂，特别是对于大型项目。
学习曲线: 需要一定的学习成本才能掌握 tox 的高级用法。
速度: 创建虚拟环境和安装依赖需要一定的时间，可能会影响测试速度。

总结

tox 是一个强大的多环境测试工具，可以帮助你提高 Python 代码的质量和兼容性。虽然配置可能有点复杂，但它的优点远远大于缺点。如果你还没有使用 tox，强烈建议你尝试一下，相信它会成为你开发 Python 项目的得力助手。

彩蛋：nox – tox 的替代品？

如果你觉得 tox 的配置太繁琐，可以考虑使用 nox。 nox 是一个基于 Python 的自动化工具，可以用来构建、测试和部署 Python 项目。它的配置使用 Python 代码，更加灵活和易于理解。

不过，nox 的功能不如 tox 强大，生态也没有 tox 成熟。选择哪个工具取决于你的具体需求。

好了，今天的讲座就到这里。希望大家能够掌握 tox 的基本用法，并在自己的项目中应用起来。谢谢大家！

发表回复 取消回复

发表回复取消回复