Mock and MagicMock in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of Mock in pytest?

Mock is used to replace parts of your system under test with mock objects. It helps simulate and control the behavior of dependencies so you can test your code in isolation.

intermediate

How does MagicMock differ from Mock?

<p><code>MagicMock</code> is a subclass of <code>Mock</code> that has default implementations for most magic methods like <code>__len__</code>, <code>__getitem__</code>, and others. It is useful when you need to mock objects that use these special methods.</p>

beginner

How do you check if a mocked method was called in pytest?

You use the assert_called() or assert_called_once() methods on the mock object to verify if it was called during the test.

beginner

What does mock.return_value do?

mock.return_value sets the value that the mock object returns when called. This lets you control the output of the mocked function or method.

beginner

Why use mocking in unit tests?

Mocking helps isolate the code you want to test by replacing external dependencies. This makes tests faster, more reliable, and focused on the specific code behavior.

Which of the following is true about MagicMock?

A It only works with classes, not functions.

B It automatically mocks magic methods like <code>__len__</code> and <code>__getitem__</code>.

C It is slower than <code>Mock</code> and should be avoided.

D It cannot mock methods that start with an underscore.

MagicMock provides default implementations for magic methods, making it easier to mock objects that use them.

How do you set a mock to return a specific value when called?

A mock.return_value = value

B mock.call_value = value

C mock.set_return(value)

D mock.value = return

Use mock.return_value to specify what the mock returns when called.

What does mock.assert_called_once() check?

A The mock was never called.

B The mock was called at least once.

C The mock was called exactly once.

D The mock was called more than once.

This assertion passes only if the mock was called exactly one time.

Why is mocking useful in unit testing?

A It replaces dependencies to isolate the code under test.

B It automatically fixes bugs in the code.

C It makes tests slower but more accurate.

D It removes the need for assertions.

Mocking isolates the code by replacing dependencies, making tests focused and reliable.

Which method would you use to check if a mock was called with specific arguments?

A mock.called_with_args()

B mock.check_args()

C mock.verify_call()

D mock.assert_called_with()

assert_called_with() verifies the mock was called with the exact arguments provided.

Explain how you would use Mock and MagicMock in a pytest unit test.

Think about isolating code and controlling behavior of dependencies.

Describe the benefits of using mocking in software testing.

Consider how mocking affects test speed and reliability.

Practice

1. What is the main difference between Mock and MagicMock in pytest?

easy

A. MagicMock supports special methods like __len__ and __getitem__, Mock does not.

B. Mock can only mock functions, while MagicMock can mock classes.

C. Mock is used for asynchronous code, MagicMock is not.

D. MagicMock is slower and less flexible than Mock.

Solution

1. Step 1: Understand the purpose of Mock and MagicMock

   Mock creates fake objects for testing, but does not automatically support Python's special methods like __len__ or __getitem__.

2. Step 2: Recognize MagicMock's special feature

   MagicMock extends Mock by including default implementations for many special methods, making it useful when those methods are called during tests.

3. Final Answer:

   MagicMock supports special methods like __len__ and __getitem__, Mock does not. -> Option A

4. Quick Check:

   Special methods = MagicMock [OK]

Hint: MagicMock handles special methods automatically [OK]

Common Mistakes:

• Thinking Mock supports special methods by default
• Confusing MagicMock as only for classes
• Believing Mock is for async only

2. Which of the following is the correct way to create a MagicMock object in pytest?

easy

A. mock = MagicMock[]

B. mock = MagicMock()

C. mock = MagicMock

D. mock = MagicMock{}

Solution

1. Step 1: Recall the syntax for creating instances in Python

   To create an instance of a class, you call it with parentheses, e.g., MagicMock().

2. Step 2: Identify the correct syntax for MagicMock

   MagicMock is a class, so MagicMock() creates a new mock object. The other options use invalid syntax for instantiation.

3. Final Answer:

   mock = MagicMock() -> Option B

4. Quick Check:

   Instance creation uses parentheses () [OK]

Hint: Use parentheses () to create MagicMock instances [OK]

Common Mistakes:

• Forgetting parentheses when creating mock objects
• Using square or curly brackets instead of parentheses
• Assigning class without instantiation

3. What will be the output of this pytest code snippet?

from unittest.mock import MagicMock
mock = MagicMock()
mock.__len__.return_value = 5
print(len(mock))

medium

A. 0

B. TypeError

C. 5

D. AttributeError

Solution

1. Step 1: Understand MagicMock and special methods

   Setting mock.__len__.return_value = 5 tells the mock to return 5 when len() is called on it, because len() calls the __len__ method.

2. Step 2: Predict the output of print(len(mock))

   Since __len__ is mocked to return 5, len(mock) will print 5.

3. Final Answer:

   5 -> Option C

4. Quick Check:

   len(mock) returns mocked __len__ value [OK]

Hint: Set __len__.return_value to mock len() calls [OK]

Common Mistakes:

• Expecting default length 0 instead of mocked value
• Confusing len(mock) with attribute access
• Thinking TypeError occurs without __len__

4. Identify the error in this pytest mocking code:

from unittest.mock import Mock
mock = Mock()
mock.__getitem__.return_value = 'value'
print(mock[0])

medium

A. Mock does not support special methods like __getitem__ by default.

B. The syntax for setting return_value is incorrect.

C. You cannot use indexing on mock objects.

D. Missing import for MagicMock.

Solution

1. Step 1: Check support for special methods in Mock

   Mock does not implement special methods like __getitem__ automatically, so setting mock.__getitem__.return_value has no effect on indexing.

2. Step 2: Understand why the code fails

   Using mock[0] calls __getitem__, but since Mock does not handle it, this raises a TypeError. To mock indexing, use MagicMock.

3. Final Answer:

   Mock does not support special methods like __getitem__ by default. -> Option A

4. Quick Check:

   Special methods need MagicMock [OK]

Hint: Use MagicMock for special methods like indexing [OK]

Common Mistakes:

• Assuming Mock supports all special methods
• Confusing syntax errors with capability errors
• Not importing MagicMock when needed

5. You want to test a function that calls obj.__str__() internally. Which mock object and setup will correctly simulate str(obj) returning 'mocked string'?

hard

A. Use mock = Mock() and set mock.str = 'mocked string'

B. Use mock = Mock() and set mock.__str__ = lambda: 'mocked string'

C. Use mock = MagicMock() and set mock.str.return_value = 'mocked string'

D. Use mock = MagicMock() and set mock.__str__.return_value = 'mocked string'

Solution

1. Step 1: Identify the need to mock __str__ special method

   The str(obj) call internally uses the __str__ method, which is a special method.

2. Step 2: Choose the correct mock and setup

   MagicMock supports special methods like __str__. Setting mock.__str__.return_value = 'mocked string' makes str(mock) return 'mocked string'.

3. Step 3: Eliminate incorrect options

   Use mock = Mock() and set mock.__str__ = lambda: 'mocked string' uses Mock which does not support special methods by default. Options C and D use incorrect attribute names or types.

4. Final Answer:

   Use mock = MagicMock() and set mock.__str__.return_value = 'mocked string' -> Option D

5. Quick Check:

   Mock special methods with MagicMock and return_value [OK]

Hint: Set __str__.return_value on MagicMock for str() calls [OK]

Common Mistakes:

• Using Mock instead of MagicMock for special methods
• Setting wrong attribute names like str instead of __str__
• Assigning string directly instead of return_value