Sometimes tests need to invoke functionality which depends on global settings or which invokes code which cannot be easily tested such as network access. The monkeypatch function argument helps you to safely set/delete an attribute, dictionary item or environment variable or to modify sys.path for importing. See the monkeypatch blog post one some introduction material and motivation.
If you e.g. want to pretend that os.expanduser returns a certain directory, you can use the monkeypatch.setattr() method to patch this function before calling into a function which uses it:
import os.path
def getssh(): # pseudo application code
return os.path.join(os.expanduser("~admin"), '.ssh')
def test_mytest(monkeypatch):
def mockreturn(path):
return '/abc'
monkeypatch.setattr(os.path, 'expanduser', mockreturn)
x = getssh()
assert x == '/abc'
After the test function finishes the os.path.expanduser modification will be undone.
object keeping a record of setattr/item/env/syspath changes.
set attribute name on obj to value, by default raise AttributeEror if the attribute did not exist.
delete attribute name from obj, by default raise AttributeError it the attribute did not previously exist.
delete name from dict, raise KeyError if it doesn’t exist.
monkeypatch.setattr/delattr/delitem/delenv() all by default raise an Exception if the target does not exist. Pass raising=False if you want to skip this check.