What is monkey patching?

by

No, it’s not like any of those things. It’s simply the dynamic replacement of attributes at runtime.

For instance, consider a class that has a method get_data. This method does an external lookup (on a database or web API, for example), and various other methods in the class call it. However, in a unit test, you don’t want to depend on the external data source – so you dynamically replace the get_data method with a stub that returns some fixed data.

Because Python classes are mutable, and methods are just attributes of the class, you can do this as much as you like – and, in fact, you can even replace classes and functions in a module in exactly the same way.

But, as a commenter pointed out, use caution when monkeypatching:

  1. If anything else besides your test logic calls get_data as well, it will also call your monkey-patched replacement rather than the original — which can be good or bad. Just beware.

  2. If some variable or attribute exists that also points to the get_data function by the time you replace it, this alias will not change its meaning and will continue to point to the original get_data. (Why? Python just rebinds the name get_data in your class to some other function object; other name bindings are not impacted at all.)

More Related Contents:

  1. Adding a Method to an Existing Object Instance
  2. What exactly are iterator, iterable, and iteration?
  3. What does it mean if a Python object is “subscriptable” or not?
  4. Making object JSON serializable with regular encoder
  5. Can I add custom methods/attributes to built-in Python types?
  6. Can you monkey patch methods on core types in Python?
  7. How to add property to a class dynamically?
  8. What are iterator, iterable, and iteration?
  9. Can I patch a Python decorator before it wraps a function?
  10. Monkey-patch Python class
  11. Monkey patching a class in another module in Python
  12. Difference between ‘cls’ and ‘self’ in Python classes?
  13. Can you patch *just* a nested function with closure, or must the whole outer function be repeated?
  14. What does ‘# noqa’ mean in Python comments?
  15. How does one monkey patch a function in python?
  16. How to monkey patch Django?
  17. Adding a method to an existing object instance in Python
  18. Extending builtin classes in python
  19. What’s the difference between a module and package in Python?
  20. Regular expression doesn't produce expected result
  21. How to share x axes of two subplots after they have been created
  22. How to create key or append an element to key?
  23. Any yaml libraries in Python that support dumping of long strings as block literals or folded blocks?
  24. How to make a script automatically restart itself?
  25. How to make a command case insensitive in discord.py
  26. ipython notebook clear cell output in code
  27. Get Excel-Style Column Names from Column Number
  28. How do I log from my Python Spark script
  29. Swap values in a tuple/list inside a list in python?
  30. What values are valid in Pandas ‘Freq’ tags?

Leave a Comment