pytest-factoryboy 使用教程

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

pytest-factoryboy/
├── CHANGELOG.rst
├── CONTRIBUTING.rst
├── docs/
│   ├── conf.py
│   ├── index.rst
│   └── ...
├── LICENSE
├── MANIFEST.in
├── pytest_factoryboy/
│   ├── __init__.py
│   ├── fixture.py
│   ├── registry.py
│   └── ...
├── README.rst
├── setup.cfg
├── setup.py
└── tests/
    ├── __init__.py
    ├── test_fixture.py
    └── ...

目录结构介绍

• CHANGELOG.rst: 记录项目的变更历史。
• CONTRIBUTING.rst: 贡献指南，指导开发者如何为项目贡献代码。
• docs/: 项目文档目录，包含 Sphinx 文档配置和文档源文件。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 指定在打包时需要包含的文件。
• pytest_factoryboy/: 项目核心代码目录，包含主要功能实现。
• README.rst: 项目介绍和使用说明。
• setup.cfg: 项目构建配置文件。
• setup.py: 项目安装脚本。
• tests/: 测试代码目录，包含项目的单元测试。

2. 项目的启动文件介绍

项目的主要启动文件是 pytest_factoryboy/__init__.py，这个文件初始化了 pytest-factoryboy 的主要功能，并导入了其他模块。

# pytest_factoryboy/__init__.py

from .fixture import register
from .fixture import fixture_factory
from .fixture import LazyFixture
from . import django

__all__ = [
    'register',
    'fixture_factory',
    'LazyFixture',
    'django',
]

__version__ = '2.7.0'

启动文件介绍

• register: 用于注册工厂类为 pytest 的 fixture。
• fixture_factory: 用于创建工厂 fixture。
• LazyFixture: 用于延迟加载 fixture。
• django: Django 相关的功能模块。

3. 项目的配置文件介绍

项目的配置文件主要包括 setup.cfg 和 setup.py。

setup.cfg

setup.cfg 文件包含了项目的构建和打包配置。

[metadata]
name = pytest-factoryboy
version = attr: pytest_factoryboy.__version__
description = Factory Boy support for pytest.
long_description = file: README.rst, CHANGELOG.rst
long_description_content_type = text/x-rst
author = Oleg Pidsadnyi, Anatoly Bubenkov
author_email = [e-mail]
url = https://github.com/pytest-dev/pytest-factoryboy
license = MIT
classifiers =
    Development Status :: 6 - Mature
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Programming Language :: Python :: 3.12
    Topic :: Software Development :: Libraries :: Python Modules
    Topic :: Software Development :: Testing

[options]
packages = find:
python_requires = >=3.8
install_requires =
    factory-boy>=2.12.0
    pytest>=6.2.0

[options.packages.find]
where = .

[tool:pytest]
addopts = --strict-markers
testpaths = tests

setup.py

setup.py 文件是 Python 项目的标准安装脚本。

from setuptools import setup, find_packages

setup(
    name='pytest-factoryboy',
    version='2.7.0',
    description='Factory Boy support for pytest.',
    long_description=open('README.rst').read() + '\n\n' + open('CHANGELOG.rst').read(),
    long_description_content_type='text/x-rst',
    author='Oleg Pidsadnyi, Anatoly Bubenkov',