-# Copyright
+# Copyright (C) 2010-2012 W. Trevor King <wking@tremily.us>
+#
+# This file is part of Hooke.
+#
+# Hooke is free software: you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# Hooke is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Hooke. If not, see <http://www.gnu.org/licenses/>.
"""Define the `@callback` decorator.
See :pep:`318` for an introduction to decorators.
"""
+import logging
+
from .caller import caller_name
returned arguments of the method they're attached to.
>>> def c(self, method, *args):
- ... print '\\n '.join([
+ ... print('\\n '.join([
... 'callback:',
... 'class: %s' % self,
... 'method: %s' % method,
- ... 'returned: %s' % args])
+ ... 'returned: %s' % args]))
For some class, decorate any functions you're interested in
attaching callbacks too. Also, add a `_callbacks` attribute
... @callback
... def xyz(self):
... "xyz's docstring"
- ... print 'usual xyz business'
+ ... print('usual xyz business')
... return (0, 1, 1, 2, 3, 5)
...
... @callback
... def abc(self):
... "abc's docstring"
- ... print 'usual abc business'
+ ... print('usual abc business')
...
>>> x = X()
The decorated method preserves the original docstring.
- >>> print x.xyz.__doc__
+ >>> print(x.xyz.__doc__)
xyz's docstring
So far, we haven't attached a callback to `abc`.
array of callbacks in series.
>>> def d(self, method, *args):
- ... print 'callback d'
+ ... print('callback d')
>>> x._callbacks['abc'] = [d, c, d]
>>> r = x.abc() # doctest: +ELLIPSIS
usual abc business
def new_m(self, *args, **kwargs):
result = method(self, *args, **kwargs)
callback = self._callbacks.get(method.func_name, None)
- nm = getattr(self, method.func_name)
+ mn = getattr(self, method.func_name)
+ log = logging.getLogger('hooke')
+ log.debug('callback: %s (%s) calling %s' % (method.func_name, mn, callback))
if is_iterable(callback):
for cb in callback:
- cb(self, nm, result)
+ cb(self, mn, result)
elif callback != None:
- callback(self, nm, result)
+ callback(self, mn, result)
return result
new_m.func_name = method.func_name
new_m.func_doc = method.func_doc
returned arguments of the method they're attached to.
>>> def c(self, method, *args, **kwargs):
- ... print '\\n '.join([
+ ... print('\\n '.join([
... 'callback:',
... 'class: %s' % self,
... 'method: %s' % method,
... 'args: %s' % (args,),
- ... 'kwargs: %s' % kwargs])
+ ... 'kwargs: %s' % kwargs]))
Now place `in_callback` calls inside any interesting methods.
...
... def xyz(self):
... "xyz's docstring"
- ... print 'usual xyz business'
+ ... print('usual xyz business')
... in_callback(self, 5, my_kw=17)
... return (0, 1, 1, 2, 3, 5)
...
... def abc(self):
... "abc's docstring"
... in_callback(self, p1=3.14, p2=159)
- ... print 'usual abc business'
+ ... print('usual abc business')
...
>>> x = X()
array of callbacks in series.
>>> def d(self, method, *args, **kwargs):
- ... print 'callback d'
+ ... print('callback d')
>>> x._callbacks['abc'] = [d, c, d]
>>> r = x.abc() # doctest: +ELLIPSIS
callback d
"""
method_name = caller_name(depth=2)
callback = self._callbacks.get(method_name, None)
- nm = getattr(self, method_name)
+ mn = getattr(self, method_name)
+ log = logging.getLogger('hooke')
+ log.debug('callback: %s (%s) calling %s' % (method_name, mn, callback))
if is_iterable(callback):
for cb in callback:
- cb(self, nm, *args, **kwargs)
+ cb(self, mn, *args, **kwargs)
elif callback != None:
- callback(self, nm, *args, **kwargs)
+ callback(self, mn, *args, **kwargs)