Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python-version-sensitive monkeypatching.

Project description

Author: Zero Piraeus
Contact: z@etiol.net

ook is a simple library to assist with monkeypatching Python methods and functions on a per-Python-version basis. It provides one decorator, patch, which conditionally patches callables depending on which version of Python is running.

Example

Adding the compress() function to Python 2.6’s itertools module:

import itertools
from ook import patch

# http://docs.python.org/2.7/library/itertools.html#itertools.compress

@patch(itertools, 2.6)
def compress(data, selectors):
    # compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
    return (d for d, s in itertools.izip(data, selectors) if s)

Usage

patch accepts an arbitrary number of version arguments, in a variety of formats:

@patch(some.module.or.class, 2.7, "2.6.8", (3, 2, 5), 3)
def method_or_function(signature):
    """Do something."""
    pass

… as well as min and max keyword arguments:

@patch(some.module.or.class, min="2.6.5", max=2.7)
def method_or_function(signature):
    """Do something."""
    pass

… which can be combined:

@patch(some.module.or.class, "3.3.5", max=3.3)
def method_or_function(signature):
    """Do something."""
    pass

Note: If you specify both keyword and non-keyword version arguments, the patch will only take effect if both the explicitly specified versions and the implied version ranges are satisfied.

With no arguments other than the module or class to be patched, patch applies the patch regardless of Python version:

@patch(some.module.or.class)
def method_or_function(signature):
    """Do something, no matter what."""
    pass

Installation

This should do the trick:

pip install ook

Project details


Download files

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

Files for ook, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size ook-1.0.2-py2.py3-none-any.whl (6.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size ook-1.0.2.tar.gz (18.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page