skip to navigation
skip to content

Not Logged In

black-magic 0.0.7

Decorator utility that operates on black magic

Latest Version: 0.0.10

Metaprogramming modules that operate on black magic!

Currently there is only one module available. However, I am all open for cool ideas.

black_magic.decorator

This is intended to become a more modern and flexible replacement for the the well known decorator module. This module benefits an API for more flexible usage. The behaviour of the decorator module can easily be duplicated.

For those who don’t know the decorator module: It can be used to create wrappers for functions that look identical to the original - a common task when replacing functions via decorators.

Furthermore, this module makes it possible to create wrappers with modified signatures. Currently, the only specialized function that is explicitly dedicated to this purpose is partial. If you are interested in doing more complex modifications you can pass a dynamically created Signature to wraps. If you make something useful, please consider contributing your functionality to this module.

.wraps()

wraps can be used similarly to the standard functools.wraps function. However, it returns a real function, i.e. something that will have a useful signature when being inspected with help() or by other metaprogramming tools. Furthermore, it knows how to copy the signature exactly, even remembering object identity of default arguments and annotations:

>>> from black_magic.decorator import wraps

>>> def real(a=[])
...     return a

>>> @wraps(real)
... def fake(*args, **kwargs):
...     return args

>>> fake()[0] is real()
True
>>> fake(a=1)
(1,)

If you want to get real crazy you can even use ast.expr’s:

>>> import ast
>>> fake = wraps(real)(ast.Num(n=1))
>>> fake(0)
1

WARNING: before using functools.partial with any of the functions in this module, make sure to read the warning below!

.partial()

This is similar to the functools.partial function.

>>> from black_magic.decorator import partial

>>> def real(arg):
...     print(arg)
>>> partial(real, arg=0)()
0

There are some differences, though:

  • this function returns a function object which looks like the input function, except for the modified parameters.

  • all overwritten parameters are completely removed from the signature. In functools.partial this is true only for arguments bound by position.

  • the **kwargs are stripped first, then *args

    >>> partial(lambda a,b,c: (a,b,c), 2, a=1)(3)
    (1, 2, 3)
    
  • by leaving the func argument empty partial can act as decorator:

    >>> @partial(None, bar=0)
    ... def foo(bar):
    ...     print(bar)
    >>> foo()
    0
    

.decorator()

This is the canonic utility to create decorators:

>>> from black_magic.decorator import decorator

>>> @decorator
... def plus_one(fn):
...     def fake(*args, **kwargs):
...         return 1 + fn(*args, **kwargs)
...     return fake

>>> @plus_one
... def mul_plus_one(a, b):
...     return a * b

>>> mul_plus_one(2, 3)
7

.flatorator()

flatorator imitates the functionality of the well known decorator module.

>>> from black_magic.decorator import flatorator

>>> @flatorator
... def times_two(fn, *args, **kwargs):
...     return 2 * fn(*args, **kwargs)

>>> @times_two
... def add_times_two(a, b):
...     return a + b

>>> add_times_two(1, 2)
6

Under the hood

Q: This uses ugly str concat and eval code, right?

A: No, it uses ugly abstract syntax tree code to do its dynamic code generation.

WARNING: performance hits incoming

Decorating a function with the tools in this module is a quite costy operation, so don’t do it very often! Invoking the wrapper is no problem on the other hand.

WARNING: functools.partial is evil

Be careful when passing functools.partial objects into .wraps, or any black magic functions more generally. functools.partial features very unsensible handling of arguments that are bound by keyword. These, and all subsequent arguments, become keyword-only parameters. Consider the following example:

>>> import functools
>>> def func(a, b, *args):
...     return (a, b, c, args)
>>> part = functools.partial(func, a=0)
>>> part(1)
Traceback (most recent call last):
    ...
TypeError: func() got multiple values for argument 'a'

Furthermore, note that the *args parameter becomes completely inaccessible, forever!

For compatibility between python versions and ease of use, I chose to handle functools.partial objects as if you had actually used black_magic.decorator.partial with the same arguments, i.e.:

>>> wrap = wraps(part)(part)
>>> wrap(1)
(0, 1, ())
>>> wrap(1, a=0)
Traceback (most recent call last):
    ...
TypeError: <lambda>() got an unexpected keyword argument 'a'

There are two exceptions:

  • unlike with black_magic.decorator.partial the *args argument stays inaccessible
  • Furthermore, the parameter a can be overwritten if the original function has a **kwargs argument:
>>> def kw_func(a, **kwargs):
...     return (a, kwargs):
>>> kw_part = functools.partial(kw_func, a=0)
>>> kw_wrap = wraps(kw_part)(kw_part)
>>> kw_wrap(a=1)
(1, {})

If you use functools.partial to bind only positional parameters, there should be no problem!

Tests

This module has been tested to work on python{2.6, 2.7, 3.2, 3.3} and PyPy1.9 using Travis CI.

License

To the extent possible under law, Thomas Gläßle has waived all copyright and related or neighboring rights to black-magic. This work is published from: Germany.

To the extent possible under law, the person who associated CC0 with black-magic has waived all copyright and related or neighboring rights to black-magic.

You should have received a copy of the CC0 legalcode along with this work. If not, see http://creativecommons.org/publicdomain/zero/1.0/.

Changelog

0.0.7

  • partial support for functools.partial

0.0.6

  • fix functools.update_wrapper emulation in black_magic.decorator.wraps()

0.0.5

  • add black_magic.decorator.partial

0.0.4

  • support any callable to be passed to ASTorator.decorate
  • convert README to .rst
 
File Type Py Version Uploaded on Size
black-magic-0.0.7.tar.gz (md5) Source 2014-03-12 14KB
  • Downloads (All Versions):
  • 0 downloads in the last day
  • 164 downloads in the last week
  • 709 downloads in the last month