Скачать или смотреть How to Override Functions in Python Using Monkey Patching

Discover a straightforward approach to override functions in Python modules using monkey patching techniques.
---
This video is based on the question https://stackoverflow.com/q/62925121/ asked by the user 'physicus' ( https://stackoverflow.com/u/3874707/ ) and on the answer https://stackoverflow.com/a/62925595/ provided by the user 'martineau' ( https://stackoverflow.com/u/355230/ ) 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: Overriding functions imported by a subsequent import?

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.
---
How to Override Functions in Python Using Monkey Patching

In the world of Python programming, developers often find themselves needing to override functions from imported modules for various reasons, such as testing or modifying behavior without changing the original code. One of the common techniques to achieve this is called monkey patching. In this post, we'll discuss how to substitute a function from a module effectively and explore the problem that arises when trying to use different import styles.

The Problem: Function Not Overridden

Let's consider an example scenario where we have two modules: mod.py and mod2.py.

The Original Function

In mod.py, we have:

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

The Function to Override

In mod2.py, we define a new function f2() that we want to use to override f() in mod.py:

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

We aim to patch the function from mod.py with our new function from mod2.py using the following line:

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

The Import That Triggers the Issue

In our main script, main.py, we import the original function like this:

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

The problem arises because when you import the function directly using from mod import f, the local reference f in main.py does not point to sys.modules["mod"].f. Instead, it maintains its original reference, causing it to print "mod.py” instead of "mod2.py".

The Solution: Monkey Patching Correctly

To successfully override the function, you need to import the entire module rather than just the function. Here’s how you can do that effectively.

Step-by-Step Solution

Module definitions:

First, let's look at our module definitions:

mod.py:

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

mod2.py:

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

Main Script Adjustments

In main.py, ensure to import the entire module:

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

Why This Works

Module Caching: When a module is imported, Python caches it in sys.modules. By importing mod2, which modifies mod.f, you can achieve the desired result without directly referencing sys.modules.

Avoiding Local References: By avoiding the direct function import (from mod import f), you ensure that calls to mod.f() will always reference the latest version of f, which is the overridden one.

Conclusion

In summary, monkey patching is a powerful technique in Python that allows developers to modify or extend the behavior of modules dynamically. By keeping these strategies in mind, you can effectively manage function overrides across your projects.

Whether you're debugging or simply aiming to change function behavior on-the-fly, understanding how imports and patches interact is crucial.

We hope that this guide helps you navigate the complexities of function overriding in Python!