`pytest-env` 使用教程

pytest-env 使用教程

pytest-envpytest plugin to set environment variables in pytest.ini or pyproject.toml file项目地址:https://gitcode.com/gh_mirrors/pyt/pytest-env

项目概述

pytest-env 是一个专为 pytest 设计的插件，它允许用户方便地在 pytest 的配置文件中设置环境变量，以便在执行测试之前应用这些变量。这极大地简化了多环境测试场景下的配置管理。

1. 项目的目录结构及介绍

虽然具体的目录结构在每个用户的本地仓库可能会有所不同，但基于标准的 Python 项目布局，一个典型的 pytest-env 包含以下基本结构：

pytest-env/
│
├── LICENSE          # 许可证文件
├── README.md        # 项目说明文档
├── setup.py         # Python 包的安装脚本
└── src/             # 核心源码目录
    └── pytest_env   # 包含插件实现的模块
        ├── __init__.py
        └── ...       # 其他相关文件

# 另外，可能还有用于测试的目录，例如:
└── tests/
    └── ...

• LICENSE: 详细说明软件使用的许可证类型。
• README.md: 描述项目功能、安装步骤和快速使用指南。
• setup.py: 用于打包和分发项目的脚本。
• src/pytest_env: 包含插件的核心代码，确保与 pytest 的集成。
• tests/（非直接由pytest-env项目提供，但在用户应用中常见）: 用户编写的测试用例和相关测试代码。

2. 项目的启动文件介绍

对于使用者而言，主要不是直接操作项目内部的启动文件，而是通过自己的测试项目来“启动”这个插件。不过，如果你是从源码安装并需要调整插件，那么配置通常在用户的测试项目中进行，具体体现在 pytest.ini 或 pyproject.toml 文件里。例如，在 pytest.ini 添加如下配置来启用环境变量：

[pytest]
env =
    HOME=~/tmp
    RUN_ENV=test

这段配置将在运行测试前设定相应的环境变量。

3. 项目的配置文件介绍

主要配置文件: .ini 或 pyproject.toml

• pytest.ini: 传统配置方式，适用于不使用现代构建工具的项目。

  [pytest]
  env =
      MY_VARIABLE=my_value
  

• pyproject.toml（当使用 Poetry 或其他现代包管理工具时）:

  [tool.pytest_env]
  HOME = "~/tmp"
  RUN_ENV = 1
  

这些配置让 pytest-env 知道哪些环境变量应该在测试运行前被激活。此外，如果需要进一步控制，比如指定环境文件或禁用特定变量的随机化，可以在相应的配置文件内设置。

总之，pytest-env 通过简洁的配置机制，极大地便利了对环境变量的管理和测试过程中的环境控制，使得多环境测试更加便捷和高效。正确配置这些文件后，开发者可以更专注于测试本身，而不是繁琐的环境配置工作。

pytest-envpytest plugin to set environment variables in pytest.ini or pyproject.toml file项目地址:https://gitcode.com/gh_mirrors/pyt/pytest-env