generic_repr, counter, PluginLoader, hybridproperty, hybridmethod, \
safe_reraise,\
get_callable_argspec, only_once, attrsetter, ellipses_string, \
- warn_limited, map_bits, MemoizedSlots, EnsureKWArgType
+ warn_limited, map_bits, MemoizedSlots, EnsureKWArgType, wrap_callable
from .deprecations import warn_deprecated, warn_pending_deprecation, \
deprecated, pending_deprecation, inject_docstring_text
return fn(*arg)
return update_wrapper(wrap, fn)
+
+def wrap_callable(fn):
+ """Wrap callable and set __name__, __doc__, and __module__.
+
+ :param fn:
+ object with __call__ method
+ """
+ if hasattr(fn, '__name__'):
+ _f = update_wrapper(lambda ctx: fn(), fn)
+ _f.__doc__ = _f.__doc__ or fn.__name__
+ return _f
+ else:
+ _f = lambda ctx: fn()
+ _f.__name__ = fn.__class__.__name__
+ _f.__module__ = fn.__module__
+
+ if hasattr(fn.__call__, '__doc__') and fn.__call__.__doc__:
+ _f.__doc__ = fn.__call__.__doc__
+ elif hasattr(fn.__class__, '__doc__') and fn.__class__.__doc__:
+ _f.__doc__ = fn.__class__.__doc__
+ elif fn.__doc__:
+ _f.__doc__ = fn.__doc__
+ else:
+ _f.__doc__ = fn.__class__.__name__
+
+ return _f
c = sa.ColumnDefault(fn)
c.arg("context")
+ def test_wrapping_update_wrapper_fn(self):
+ def my_fancy_default():
+ """run the fancy default"""
+ return 10
+
+ c = sa.ColumnDefault(my_fancy_default)
+ eq_(c.arg.__name__, "my_fancy_default")
+ eq_(c.arg.__doc__, "run the fancy default")
+
+ def test_wrapping_update_wrapper_fn_nodocstring(self):
+ def my_fancy_default():
+ return 10
+
+ c = sa.ColumnDefault(my_fancy_default)
+ eq_(c.arg.__name__, "my_fancy_default")
+ eq_(c.arg.__doc__, "my_fancy_default")
+
+ def test_wrapping_update_wrapper_cls(self):
+ class MyFancyDefault(object):
+ """a fancy default"""
+
+ def __call__(self):
+ """run the fancy default"""
+ return 10
+
+ c = sa.ColumnDefault(MyFancyDefault())
+ eq_(c.arg.__name__, "MyFancyDefault")
+ eq_(c.arg.__doc__, "run the fancy default")
+
+ def test_wrapping_update_wrapper_cls_noclassdocstring(self):
+ class MyFancyDefault(object):
+
+ def __call__(self):
+ """run the fancy default"""
+ return 10
+
+ c = sa.ColumnDefault(MyFancyDefault())
+ eq_(c.arg.__name__, "MyFancyDefault")
+ eq_(c.arg.__doc__, "run the fancy default")
+
+ def test_wrapping_update_wrapper_cls_nomethoddocstring(self):
+ class MyFancyDefault(object):
+ """a fancy default"""
+
+ def __call__(self):
+ return 10
+
+ c = sa.ColumnDefault(MyFancyDefault())
+ eq_(c.arg.__name__, "MyFancyDefault")
+ eq_(c.arg.__doc__, "a fancy default")
+
+ def test_wrapping_update_wrapper_cls_noclassdocstring_nomethoddocstring(self):
+ class MyFancyDefault(object):
+
+ def __call__(self):
+ return 10
+
+ c = sa.ColumnDefault(MyFancyDefault())
+ eq_(c.arg.__name__, "MyFancyDefault")
+ eq_(c.arg.__doc__, "MyFancyDefault")
+
@testing.fails_on('firebird', 'Data type unknown')
def test_standalone(self):
c = testing.db.engine.contextual_connect()