草庐IT

python - 在pytest中,conftest.py文件有什么用?

coder 2023-04-29 原文

我最近发现 pytest .看起来很棒。但是,我觉得文档可能会更好。

我想了解什么 conftest.py文件旨在用于。

在我的(目前很小的)测试套件中,我有一个 conftest.py项目根目录下的文件。我用它来定义我注入(inject)到我的测试中的装置。

我有两个问题:

  • 这是 conftest.py 的正确用法吗? ?它还有其他用途吗?
  • 我可以有多个吗conftest.py文件?我什么时候想要这样做?示例将不胜感激。

  • 更一般地说,您将如何定义 conftest.py 的用途和正确使用py.test 测试套件中的文件?

    最佳答案

    Is this the correct use of conftest.py?


    是的。夹具是 conftest.py 的潜在和常见用途.这
    您将定义的夹具将在您的测试套件中的所有测试之间共享。但是,在根 conftest.py 中定义设备可能没用,如果所有测试都没有使用这些装置,它会减慢测试速度。

    Does it have other uses?


    是的,它确实。
  • 灯具 :为测试使用的静态数据定义夹具。除非另有说明,否则套件中的所有测试都可以访问此数据。这可能是数据以及将传递给所有测试的模块的助手。
  • 外部插件加载 :conftest.py用于导入外部插件或模块。通过定义以下全局变量,pytest 将加载模块并使其可用于测试。插件通常是在您的项目或测试中可能需要的其他模块中定义的文件。您还可以按照 here 的说明加载一组预定义的插件。 .pytest_plugins = "someapp.someplugin"
  • Hook :您可以指定设置和拆卸方法等 Hook ,以改进您的测试。有关一组可用的钩子(Hook),请阅读 Hooks link .例子:
      def pytest_runtest_setup(item):
           """ called before ``pytest_runtest_call(item). """
           #do some stuff`
    
  • 测试根路径 : 这有点隐藏功能。通过定义 conftest.py在您的根路径中,您将拥有 pytest无需指定即可识别您的应用程序模块 PYTHONPATH .在后台,py.test 修改你的 sys.path通过包含从根路径找到的所有子模块。

  • Can I have more than one conftest.py file?


    是的,你可以,如果你的测试结构有点复杂,强烈建议你这样做。 conftest.py文件具有目录范围。因此,创建有针对性的装置和助手是一种很好的做法。

    When would I want to do that? Examples will be appreciated.


    几种情况可能适合:
    创建一套工具或 Hook 对于特定的一组测试。
    root/mod/conftest.py
    def pytest_runtest_setup(item):
        print("I am mod")
        #do some stuff
    
    
    test root/mod2/test.py will NOT produce "I am mod"
    
    加载一组灯具对于某些测试,但不适用于其他测试。
    root/mod/conftest.py
    @pytest.fixture()
    def fixture():
        return "some stuff"
    
    root/mod2/conftest.py
    @pytest.fixture()
    def fixture():
        return "some other stuff"
    
    root/mod2/test.py
    def test(fixture):
        print(fixture)
    
    将打印“其他一些东西”。
    覆盖 从根继承的钩子(Hook) conftest.py .
    root/mod/conftest.py
    def pytest_runtest_setup(item):
        print("I am mod")
        #do some stuff
    
    root/conftest.py
    def pytest_runtest_setup(item):
        print("I am root")
        #do some stuff
    
    通过在 root/mod 中运行任何测试,只打印“我是 mod”。
    您可以阅读更多关于 conftest.py 的信息here .
    编辑:

    What if I need plain-old helper functions to be called from a number of tests in different modules - will they be available to me if I put them in a conftest.py? Or should I simply put them in a helpers.py module and import and use it in my test modules?


    您可以使用 conftest.py定义你的助手。但是,您应该遵循常规做法。至少在 pytest 中,助手可以用作夹具.例如,在我的测试中,我有一个模拟 redis 助手,我以这种方式将其注入(inject)到我的测试中。
    root/helper/redis/redis.py
    @pytest.fixture
    def mock_redis():
        return MockRedis()
    
    root/tests/stuff/conftest.py
    pytest_plugin="helper.redis.redis"
    
    root/tests/stuff/test.py
    def test(mock_redis):
        print(mock_redis.get('stuff'))
    
    这将是一个测试模块,您可以在测试中自由导入。 注意 您可能会命名 redis.pyconftest.py如果您的模块 redis包含更多测试。但是,由于模棱两可,不鼓励这种做法。
    如果您想使用 conftest.py ,您可以简单地将该助手放在您的根目录中 conftest.py并在需要时注入(inject)。
    root/tests/conftest.py
    @pytest.fixture
    def mock_redis():
        return MockRedis()
    
    root/tests/stuff/test.py
    def test(mock_redis):
        print(mock_redis.get(stuff))
    
    您可以做的另一件事是编写一个可安装的插件。在这种情况下,你的助手可以写在任何地方,但它需要定义一个入口点来安装在你的和其他潜在的测试框架中。见 this .
    如果您不想使用固定装置,您当然可以定义一个简单的帮助程序,并在需要的地方使用普通的旧导入。
    root/tests/helper/redis.py
    class MockRedis():
        # stuff
    
    root/tests/stuff/test.py
    from helper.redis import MockRedis
    
    def test():
        print(MockRedis().get(stuff))
    
    但是,在这里您可能会遇到路径问题,因为模块不在测试的子文件夹中。您应该能够通过添加 __init__.py 来克服这个问题(未经测试)。给你的 helper
    根/测试/助手/初始化 .py
    from .redis import MockRedis
    
    或者简单地将 helper 模块添加到您的 PYTHONPATH .

    关于python - 在pytest中,conftest.py文件有什么用?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/34466027/

    有关python - 在pytest中,conftest.py文件有什么用?的更多相关文章

    1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    2. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

      类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

    3. ruby - 其他文件中的 Rake 任务 - 2

      我试图在一个项目中使用rake,如果我把所有东西都放到Rakefile中,它会很大并且很难读取/找到东西,所以我试着将每个命名空间放在lib/rake中它自己的文件中,我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题,但没有任务。我现在只有一个.rake文件作为测试,名为“servers.rake”,它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

    4. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

      我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

    5. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

      关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

    6. ruby-on-rails - Rails 3 中的多个路由文件 - 2

      Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

    7. ruby-on-rails - Rails - 子类化模型的设计模式是什么? - 2

      我有一个模型:classItem项目有一个属性“商店”基于存储的值,我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式?如果方法中没有大的if-else语句,这是如何干净利落地完成的? 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.co

    8. ruby - 将差异补丁应用于字符串/文件 - 2

      对于具有离线功能的智能手机应用程序,我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

    9. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

      我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

    10. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

      我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

    随机推荐