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="351023272@qq.com",

    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/*

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容

  • 目录 插件的加载方式 什么是hook Pytest有哪些hook函数 如何改写hook函数 实战打包、发布 Pyt...
    InsaneLoafer阅读 693评论 0 2
  • 目录: 安装及入门 使用和调用方法 原有TestSuite使用方法 断言的编写和报告 Pytest fixture...
    韩志超阅读 5,352评论 0 5
  • 安装 pip install pytest sample test_sample.py 执行测试 pytest t...
    简书一哥们阅读 416评论 0 0
  • 前言 参考官方的这篇文章,我尝试翻译其中一些重点部分,并且拓展了相关的pluggy部分的知识。由于pytest是在...
    小餐包阅读 2,635评论 0 2
  • 本文参考了官方文档和一些乐于分享的大佬的博客,结合自己的理解完成。学习pytest框架的小白,需要按照教程自己敲一...
    成都_阿木木阅读 14,221评论 1 5