Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install collective.monkeypatcher

How to install collective.monkeypatcher

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install collective.monkeypatcher
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
1.0.1 Available View build log
1.0 Available View build log
1.0b2 Available View build log
Windows (64-bit)
1.0.1 Available View build log
1.0 Available View build log
1.0b2 Available View build log
Mac OS X (10.5+)
1.0.1 Available View build log
1.0 Available View build log
1.0b2 Available View build log
Linux (32-bit)
1.0.1 Available View build log
1.0 Available View build log
1.0b2 Available View build log
Linux (64-bit)
1.0.1 Available View build log
1.0 Available View build log
1.0b2 Available View build log
Lastest release
version 1.0.1 on Jan 26th, 2011


Sometimes, a monkey patch is a necessary evil.

This package makes it easier to apply a monkey patch during Zope startup. It uses the ZCML configuration machinery to ensure that patches are loaded "late" in the startup cycle, so that the original code has had time to be fully initialised and configured. This is similar to using the initialize() method in a product's __init__.py, except it does not require that the package be a full-blown Zope 2 product with a persistent Control_Panel entry.

Applying a monkey patch

Here's an example:


    <include package="collective.monkeypatcher" />

        description="This works around issue http://some.tracker.tld/ticket/123"


In this example, we patch Plone's CatalogTool's searchResults() function, replacing it with our own version in catalog.py. To patch a module level function, you can use module instead of class. The original class and function/method name and the replacement symbol will be checked to ensure that they actually exist.

If patching happens too soon (or too late), use the order attribute to specify a higher (later) or lower (earlier) number. The default is 1000.

By default, DocFinderTab and other TTW API browsers will emphasize the monkey patched methods/functions, appending the docstring with "Monkey patched with 'my.monkeypatched.function'". If you don't want this, you could set the docstringWarning attribute to false.

If you want to do more than just replace one function with another, you can provide your own patcher function via the handler attribute. This should be a callable like:

def apply_patch(scope, original, replacement):

Here, scope is the class/module that was specified. original is the string name of the function to replace, and replacement is the replacement function.

Full list of options:

  • class The class being patched
  • module The module being patched
  • handler A function to perform the patching. Must take three parameters: class/module, original (string), and replacement
  • original Method or function to replace
  • replacement Method to function to replace with
  • preservedoc Preserve docstrings?
  • preserveOriginal Preserve the original function so that it is reachable view prefix _old_. Only works for default handler
  • preconditions Preconditions (multiple, separated by space) to be satisified before applying this patch. Example: Products.LinguaPlone-=1.4.3 or Products.TextIndexNG3+=3.3.0
  • ignoreOriginal Ignore if the orginal function isn't present on the class/module being patched
  • docstringWarning Add monkey patch warning in docstring
  • description Some comments about your monkey patch
  • order Execution order

Handling monkey patches events

Applying a monkey patch fires an event. See the interfaces.py module. If you to handle such event add this ZCML bunch:


And add such Python:

def myHandler(event):
    """see collective.monkeypatcher.interfaces.IMonkeyPatchEvent"""


1.0.1 - 2011-01-25
  • Downgrade standard log message to debug level. [hannosch]
1.0 - 2010-07-01
  • Avoid a zope.app dependency. [hannosch]
  • Added new parameter preconditions that only patches if preconditions are met like version of a specific package. [spamsch]
  • Added new parameter preserveOriginal. Setting this to true makes it possible to access the patched method via _old_``name of patched method`` [spamsch]
1.0b2 - 2009-06-18
  • Add the possibility to ignore the error if the original function isn't present on the class/module being patched [jfroche]
  • Check if the docstring exists before changing it [jfroche]
  • Add buildout.cfg for test & test coverage [jfroche]
1.0b1 - 2009-04-17
  • Fires an event when a monkey patch is applied. See interfaces.py. [glenfant]
  • Added ZCML attributes "docstringWarning" and "description". [glenfant]
  • Added unit tests. [glenfant]
1.0a1 - 2009-03-29
  • Initial release [optilude]

Subscribe to package updates

Last updated Jan 26th, 2011

Download Stats

Last month:4

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.