Metadata-Version: 1.1
Name: ook
Version: 0.12.08a1
Summary: Python-version-sensitive monkeypatching.
Home-page: https://bitbucket.org/schesis/ook
Author: Zero Piraeus
Author-email: z@etiol.net
License: GPLv3
Description: 
        =============================================
        ook - Python-version-sensitive monkeypatching
        =============================================
        
        :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
        -------
        
        This one's used in **ook**'s test suite::
        
            import itertools
            from ook import patch
        
            @patch(itertools, 2.5)
            def combinations(iterable, r):
                # From <http://docs.python.org/release/2.6/library/itertools.html>.
                pool = tuple(iterable)
                n = len(pool)
                if r > n:
                    return
                indices = range(r)
                yield tuple(pool[i] for i in indices)
                while True:
                    for i in reversed(range(r)):
                        if indices[i] != i + n - r:
                            break
                    else:
                        return
                    indices[i] += 1
                    for j in range(i+1, r):
                        indices[j] = indices[j-1] + 1
                    yield tuple(pool[i] for i in indices)
        
        
        Usage
        -----
        
        ``patch`` accepts an arbitrary number of version arguments, in a variety of
        formats::
        
            @patch(some.module.or.class, 2.5, "2.6.8", (2, 7, 3), 3):
            def method_or_function(signature):
                """Do something."""
                pass
        
        ... as well as ``min`` and ``max`` keyword arguments::
        
            @patch(some.module.or.class, min="2.5.4", max=2.7):
            def method_or_function(signature):
                """Do something."""
                pass
        
        ... which can be combined::
        
            @patch(some.module.or.class, "3.1.5", max=3.1):
            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
        
        
        Credits / Copyright
        -------------------
        
        **ook** was (cough) "inspired" by Guido van Rossum's monkeypatch_ recipe.
        Thanks, Guido :-)
        
        It's released under the GNU General Public License (version 3 or later), a copy
        of which is included with this distribution in the file **COPYING**.
        
        
        .. _monkeypatch: http://mail.python.org/pipermail/python-dev/2008-January/076194.html
        
        
Keywords: version sensitive monkey patch
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Topic :: Software Development :: Libraries :: Python Modules
