How do I correctly setup and teardown for my pytest class with tests?

by

According to Fixture finalization / executing teardown code, the current best practice for setup and teardown is to use yield instead of return:

import pytest

@pytest.fixture()
def resource():
    print("setup")
    yield "resource"
    print("teardown")

class TestResource:
    def test_that_depends_on_resource(self, resource):
        print("testing {}".format(resource))

Running it results in

$ py.test --capture=no pytest_yield.py
=== test session starts ===
platform darwin -- Python 2.7.10, pytest-3.0.2, py-1.4.31, pluggy-0.3.1
collected 1 items

pytest_yield.py setup
testing resource
.teardown


=== 1 passed in 0.01 seconds ===

Another way to write teardown code is by accepting a request-context object into your fixture function and calling its request.addfinalizer method with a function that performs the teardown one or multiple times:

import pytest

@pytest.fixture()
def resource(request):
    print("setup")

    def teardown():
        print("teardown")
    request.addfinalizer(teardown)
    
    return "resource"

class TestResource:
    def test_that_depends_on_resource(self, resource):
        print("testing {}".format(resource))

More Related Contents:

  1. How to make an object indestructible even with force deletion?
  2. How to print instances of a class using print()?
  3. How do I call a parent class’s method from a child class in Python?
  4. Saving and loading multiple objects in pickle file?
  5. Getting an instance name inside class __init__() [duplicate]
  6. What is the difference between __init__ and __call__?
  7. Difference between ‘cls’ and ‘self’ in Python classes?
  8. How to create multiple class objects with a loop in python?
  9. Getting container/parent object from within python
  10. How can I create an object and add attributes to it?
  11. “Enabling” comparison for classes [duplicate]
  12. How to avoid having class data shared among instances?
  13. Spawning multiple instances of the same object concurrently in python
  14. Why is the id of a Python class not unique when called quickly?
  15. Python dictionary from an object’s fields
  16. Using self.xxxx as a default parameter – Python
  17. How do I access Class member variables in Python?
  18. Test case execution order in pytest
  19. python assign values to list elements in loop
  20. How do you create an incremental ID in a Python Class
  21. assigning class variable as default value to class method argument
  22. How to monkeypatch python’s datetime.datetime.now with py.test?
  23. How to make a copy of a 2D array in Python? [duplicate]
  24. Passing variables, creating instances, self, The mechanics and usage of classes: need explanation [closed]
  25. how to share a variable across modules for all tests in py.test
  26. How do you change the value of one attribute by changing the value of another? (dependent attributes)
  27. How to extend a class in python?
  28. Using Python class as a data container [closed]
  29. Python calling method in class
  30. How to find instance of a bound method in Python?

Leave a Comment