Скачать или смотреть Fixing the Multiple Patch Issue in Python's Unittest Framework

Learn how to resolve the `multiple patch` problem in Python's unittest framework by understanding the decorator's order of execution.
---
This video is based on the question https://stackoverflow.com/q/63140257/ asked by the user 'Ankita' ( https://stackoverflow.com/u/14011380/ ) and on the answer https://stackoverflow.com/a/63140306/ provided by the user 'Ashutosh gupta' ( https://stackoverflow.com/u/7488260/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Muliple patch in Python unitest not working

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Fixing the Multiple Patch Issue in Python's Unittest Framework

When working with tests in Python, especially using the unittest framework, you may encounter occasions where multiple patches do not seem to work as expected. You might have faced a scenario like this in your test case, leading you to wonder about the proper implementation of patch decorators. In this post, we will break down a common problem related to the order of decorators in combination with the @ patch function and how to fix it.

Understanding the Problem

You have a test case that uses multiple @ patch decorators, such as in the following example:

[[See Video to Reveal this Text or Code Snippet]]

At first glance, this looks sensible, but you might be noticing that the mock returns are not functioning as expected when running the test.

What's Going Wrong?

One key aspect of Python decorators, including @ patch, is their order of execution. In Python, decorators are applied from the innermost to the outermost. Thus, in the case above, the testcase1 function receives the arguments in reverse order of how the patches are applied. This is where it gets problematic: your assertions are referencing the wrong objects.

The Solution: Correcting the Order of Decorators

To rectify the issue, you need to modify the order of the parameters in your test function so that they correspond with the patch decorators properly. Here’s how to do it correctly:

Step-by-Step Correction

Adjust the Argument Order: Change the order of the parameters in the test case so that it matches the order of the @ patch decorators. The first decorated method need to come last in the function's parameter list and so on.

Here’s the corrected function:

[[See Video to Reveal this Text or Code Snippet]]

Why This Works

Decorator Execution Order: The outermost decorator, @ patch('something.mysqlclient'), will provide the mysql mock as the second argument. Its corresponding mock should be the last in the parameter list to match the decorator layer structure. This way, esclient will get the mock created by the @ patch('something.esclient'), and everything will work correctly.

Conclusion

Using multiple patches in the Python unittest framework can be straightforward as long as you remember the order of execution for decorators. Always ensure your function parameters align with the order in which patches are applied. By following the structure outlined above, you can effectively debug and correct issues related to multiple patches in your unit tests.

With this knowledge, you're now equipped to tackle possible complications associated with decorators in Python testing. Happy coding and testing!