40

Recently, Ned Batchelder during his talk at PyCon 2016 noted:

If you are using unittest to write your tests, definitely use addCleanup, it's much better than tearDown.

Up until now, I've never used addCleanup() and got used to setUp()/tearDown() pair of methods for test "set up" and "tear down" phases.

Why should I switch to addCleanup() instead of tearDown()?

It was also recently discussed in the Python unittest with Robert Collins podcast.

Bob Stein
  • 16,271
  • 10
  • 88
  • 101
alecxe
  • 462,703
  • 120
  • 1,088
  • 1,195

3 Answers3

49

Per the addCleanup doc string:

Cleanup items are called even if setUp fails (unlike tearDown)

addCleanup can be used to register multiple functions, so you could use separate functions for each resource you wish to clean up. That would allow your code to be a bit more reusable/modular.

unutbu
  • 842,883
  • 184
  • 1,785
  • 1,677
6

addCleanup() methods will run even if one of them fails, and will run even if setUp() fails. You should also consider using pytest.

Raphaël Gomès
  • 938
  • 1
  • 8
  • 23
4

Another good thing about addCleanup is that it just works as you'd expect.

For example, if you call it in a setUp function, then all test methods will call the cleanup function in the end.

If you call it in a test method, only this method calls the cleanup function.

laike9m
  • 18,344
  • 20
  • 107
  • 140