pytest_06自定义插件

一,pytest的三种插件

(1)内置插件:pytest内部的_pytest目录中加载:\Lib\site-packages\_pytest\hookspec.py

(2)外部插件:pip install 插件,通过setuptools的Entry points机制来发现外部插件,可用插件列表:https://docs.pytest.org/en/latest/reference/plugin_list.html

(3)本地插件:conftest.py插件,pytest自动模块发现机制,在项目根目录下的conftest文件起到全局作用,在项目下的子目录中的conftest.py文件作用范围只能在该层级及以下目录生效

(4)他们的加载顺序为:内置插件》外部插件》本地插件

二,pytest的hook函数

(1)hook函数(钩子函数)是程序中预留的函数(相当于暴露了一个钩子),如果我们需要在程序某个步骤执行某个操作,我们就直接重写特定的钩子函数(挂载到钩子上),这样就实现了我们要增加的功能。没有挂载或者注册钩子时,它就是空的,也就是没有执行任何操作。

(2)Pytest 的hook函数可查看\Lib\site-packages\_pytest\hookspec.py文件, Pytest hook函数的执行顺序如下(https://github.com/pytest-dev/pytest/issues/3261):

    Ps:我们可以对上面的hook函数进行改写,实现某些功能,fixture实现的功能其实也对pytest的hook函数进行了改写;

三,自定义开发插件

(一)pytest插件:中文编码

        a) 示例:打印中文

    b) 运行结果:用例名字编码格式为Unicode,无法显示中文

    c)在同级目录下的conftest.py文件中重写pytest_collection_modifyitems方法;(对用例名进行解码并反转用例顺序);

    d) 运行结果:

(二)添加命令行参数

    a) 通过改写hook函数pytest_addoption()可以实现添加自定义的命令行参数,几乎每个pytest插件都会使用这个hook方法。下面在conftest.py中改写pytest_addoption()方法

    b)命令行中输入pytest -h,在打印的帮助信息中,我们可以看到添加的自定义参数:

    c) 获取这个参数,在conftest.py中添加如下代码:

    d) 准备的测试数据:

 e)执行用例:pytest -s --env=develop

(三)打包发布

    Python插件开发完成后,可以对它进行打包发布,方便给别人使用,打包后也可以发布代码到到PyPI上,可参考Python打包文档:https://packaging.python.org/tutorials/packaging-projects/,下面介绍Python打包过程。

    a)创建包文件

    b)setup.py是一个构建脚本:entry_points为入口函数,使用pluggy插件中PluginManager类的load_setuptools_entrypoints方法加载,其中pytest11为入口点,这是官方定义的固定入口点,用于发现插件,参考https://docs.pytest.org/en/latest/how-to/writing_plugins.html

以下为setup.py文件内容:


import setuptools

setuptools.setup(

    name="pytest-testpluggy",  # Replace with your own username

    version="0.0.1",

    author="llh",

    author_email="[email protected]",

    description="set your encoding",

    long_description="show Chinese for your mark.parametrize().",

    classifiers=["Programming Language :: Python :: 3", "Framework :: Pytest", "Topic :: Software Develoment :: Testing",],

    packages=['test_pluggy'],

    keywords=["pytest", "py.test", "pytest_pluggy",],

    install_requires=['pytest', 'Pyyaml'],

    python_requires=">=3.6",

    # 入口模块或者入口函数

    entry_points={'pytest11': ['pytest-testpluggy = test_pluggy']},

    zip_safe=False,

)

    


    c)__init__.py文件需要把刚才conftest的内容复制过来;

    d)打包准备

        安装wheel:pip install wheel

        安装setuptools:pip install setuptools

    e)打包:python setup.py sdist bdist_wheel

    f) 生成的包文件:pytest-testpluggy-0.0.1.tar.gz为源码包,pytest_ testpluggy -0.0.1-py3-none-any.whl可以通过pip install命令安装

(四)验证打出来的包

        (1)在一个全新的环境运行以下测试用例:

        结果:

    (2)把刚才打出来的包在这个全新环境安装一遍:pip install pytest_testpluggy-0.0.1-py3-none-any.whl

       再次运行结果:

(五)使用Twine来上传包到PyPI,需要注册一个PyPI账号

            (1)安装twinepip install twine

            (2)上传:twine upload --repository test-encode dist/*

你可能感兴趣的:(pytest_06自定义插件)