Skip to main content

Patch the source of python functions at runtime.

Project description
A patchy pirate.

Patch the source of python functions at runtime (not monkey-patching - actual patch-patching).

A quick example:

>>> def sample():
...    return 1
>>> patchy.patch(sample, """\
...     @@ -1,2 +1,2 @@
...      def sample():
...     -    return 1
...     +    return 9001
...     """)
>>> sample()


If you’re monkey-patching an external library to add or fix some functionality, you will probably forget to check the monkey patch when you upgrade it. By using a patch against its source code, you can specify some context that you expect to remain the same in the function that will be checked before the source is applied.

I found this with some small but important patches to Django for a project. Since it takes a lot of energy to maintain a fork, writing monkey patches was the chosen quick solution, but then writing actual patches would be better.

The patches are applied with the standard patch commandline utility.

Why not?

There are of course a lot of reasons against:

  • It’s (relatively) slow (since it writes the source to disk and calls the patch command)

  • If you have a patch file, why not just fork the library and apply it?

  • At least with monkey-patching you know you what end up with, rather than having the changes being done at runtime to source that may have changed.

All are valid arguments. However once in a while this might be the right solution.


The standard library function inspect.getsource() is used to retrieve the source code of the function, the patch is applied with the commandline utility patch, the code is recompiled, and the function’s code object is replaced the new one. Because nothing tends to poke around at code objects apart from dodgy hacks like this, you don’t need to worry about chasing any references that may exist to the function, unlike mock.patch.

A little special treatment is given to instancemethod, classmethod, and staticmethod objects to make sure the underlying function is what gets patched and that you don’t have to worry about the details.


patch(func, patch_text)

Apply the patch patch_text to the source of function func.

If the patch is invalid, for example the context lines don’t match, ValueError will be raised, with a message that includes all the output from the patch utility.

Note that patch_text will be textwrap.dedent()’ed, but leading whitespace will not be removed. Therefore the correct way to include the patch is with a triple-quoted string with a backslash - """\ - which starts the string and avoids including the first newline. A final newline is not required and will be automatically added if not present.


import patchy

def sample():
    return 1

patchy.patch(sample, """\
    @@ -2,2 +2,2 @@
    -    return 1
    +    return 2""")

print(sample())  # prints 2

unpatch(func, patch_text)

Unapply the patch patch_text from the source of function func. This is the reverse of patch()ing it, and calls patch --reverse.

The same error and formatting rules apply as in patch().


import patchy

def sample():
    return 2

patchy.unpatch(sample, """\
    @@ -2,2 +2,2 @@
    -    return 1
    +    return 2""")

print(sample())  # prints 1

temp_patch(func, patch_text)

Usable as a context manager or function decorator to wrap code with a call to patch before and unpatch after.

Context manager example:

def sample():
    return 1234

patch_text = """\
    @@ -1,2 +1,2 @@
     def sample():
    -    return 1234
    +    return 5678

with patchy.temp_patch(sample, patch_text):
    print(sample())  # prints 5678

Decorator example, using the same sample and patch_text:

@patchy.temp_patch(sample, patch_text)
def my_func():
    return sample() == 5678

print(my_func())  # prints True

How to Create a Patch

  1. Save the source of the function of interest in a .py file, e.g. Make sure you dedent it so there is no whitespace before the def:

    def foo():
        print("Change me")
  2. Copy that .py file, to e.g., and make the changes you want:

    def foo():
  3. Run diff, e.g. diff You will get output like:

    diff --git a/Users/chainz/tmp/ b/Users/chainz/tmp/
    index e6b32c6..31fe8d9 100644
    --- a/Users/chainz/tmp/
    +++ b/Users/chainz/tmp/
    @@ -1,2 +1,2 @@
     def foo():
    -    print("Change me")
    +    print("Changed")
  4. The filenames are not necessary for patchy to work. Take only from the first @@ line onwards into the multiline string you pass to patchy.patch():

    patchy.patch(foo, """\
        @@ -1,2 +1,2 @@
         def foo():
        -    print("Change me")
        +    print("Changed")


1.2.0 (2015-07-23)

  • Pirate mascot!

  • Patching caches the patched and unpatched versions, so unpatching and repeat patching/unpatching are both faster

  • Patching doesn’t attach an attribute to the function object any more

1.1.0 (2015-06-16)

  • Fixed code compilation to use the __future__ flags from the function that is being patched

  • Added unpatch method

  • Added temp_patch context manager/decorator

1.0.0 (2015-06-09)

  • First release on PyPI, featuring patch function.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

patchy-1.2.0.tar.gz (17.2 kB view hashes)

Uploaded Source

Built Distribution

patchy-1.2.0-py2.py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page