开源项目 `parameterized` 使用教程

开源项目 parameterized 使用教程

parameterized Parameterized testing with any Python test framework 项目地址: https://gitcode.com/gh_mirrors/pa/parameterized

1. 项目目录结构及介绍

parameterized 项目的目录结构如下：

parameterized/
├── circleci/
│   └── misspelling-helper/
│       └── nose-parametrized/
├── parameterized/
├── .gitignore
├── .travis.yml
├── CHANGELOG.txt
├── LICENSE.txt
├── README.rst
├── pyproject.toml
├── rebuild-circleci-yaml
└── tox.ini

目录结构介绍

• circleci/: 包含与 CircleCI 相关的配置和辅助工具。
  • misspelling-helper/: 包含用于拼写检查的辅助工具。
    • nose-parametrized/: 与 Nose 测试框架相关的参数化测试工具。
• parameterized/: 项目的主要代码目录，包含参数化测试的核心实现。
• .gitignore: Git 忽略文件，指定哪些文件和目录不应被版本控制。
• .travis.yml: Travis CI 的配置文件，用于持续集成。
• CHANGELOG.txt: 项目变更日志，记录每个版本的更新内容。
• LICENSE.txt: 项目的开源许可证文件。
• README.rst: 项目的说明文档，包含项目的基本介绍、安装方法和使用示例。
• pyproject.toml: Python 项目的配置文件，包含项目依赖和构建工具的配置。
• rebuild-circleci-yaml: 用于重建 CircleCI 配置文件的脚本或工具。
• tox.ini: Tox 配置文件，用于自动化测试和环境管理。

2. 项目启动文件介绍

parameterized 项目没有明确的“启动文件”，因为它是一个库项目，主要用于提供参数化测试的功能。项目的核心代码位于 parameterized/ 目录下，用户可以通过导入这些模块来使用参数化测试功能。

例如，用户可以通过以下方式导入并使用 parameterized 模块：

from parameterized import parameterized

@parameterized([
    (2, 3, 5),
    (3, 5, 8),
])
def test_add(a, b, expected):
    assert_equal(a + b, expected)

3. 项目的配置文件介绍

.travis.yml

.travis.yml 是 Travis CI 的配置文件，用于配置项目的持续集成流程。以下是该文件的部分内容示例：

language: python
python:
  - "3.6"
  - "3.7"
  - "3.8"
  - "3.9"
install:
  - pip install -r requirements.txt
script:
  - pytest

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于指定项目的构建系统和依赖项。以下是该文件的部分内容示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "parameterized"
version = "0.8.1"
description = "Parameterized testing with any Python test framework"
authors = [
    { name = "David Wolever", email = "david@wolever.net" },
]
dependencies = [
    "nose",
    "pytest",
]

tox.ini

tox.ini 是 Tox 的配置文件，用于自动化测试和环境管理。以下是该文件的部分内容示例：

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

[testenv]
deps =
    pytest
commands =
    pytest

通过这些配置文件，开发者可以轻松地配置项目的构建、测试和持续集成流程。

parameterized Parameterized testing with any Python test framework 项目地址: https://gitcode.com/gh_mirrors/pa/parameterized