1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
|
import pytest
from boltons.funcutils import wraps, FunctionBuilder
def pita_wrap(flag=False):
def cedar_dec(func):
@wraps(func)
def cedar_wrapper(*a, **kw):
return (flag, func.__name__, func(*a, **kw))
return cedar_wrapper
return cedar_dec
def wrappable_func(a, b):
return a, b
def wrappable_varkw_func(a, b, **kw):
return a, b
def test_wraps_basic():
@pita_wrap(flag=True)
def simple_func():
'''"""a tricky docstring"""'''
return 'hello'
assert simple_func() == (True, 'simple_func', 'hello')
assert simple_func.__doc__ == '''"""a tricky docstring"""'''
assert callable(simple_func.__wrapped__)
assert simple_func.__wrapped__() == 'hello'
assert simple_func.__wrapped__.__doc__ == '''"""a tricky docstring"""'''
@pita_wrap(flag=False)
def less_simple_func(arg='hello'):
return arg
assert less_simple_func() == (False, 'less_simple_func', 'hello')
assert less_simple_func(arg='bye') == (False, 'less_simple_func', 'bye')
with pytest.raises(TypeError):
simple_func(no_such_arg='nope')
@pita_wrap(flag=False)
def default_non_roundtrippable_repr(x=lambda y: y + 1):
return x(1)
assert default_non_roundtrippable_repr() == (
False, 'default_non_roundtrippable_repr', 2)
def test_wraps_injected():
def inject_string(func):
@wraps(func, injected="a")
def wrapped(*args, **kwargs):
return func(1, *args, **kwargs)
return wrapped
assert inject_string(wrappable_func)(2) == (1, 2)
def inject_list(func):
@wraps(func, injected=["b"])
def wrapped(a, *args, **kwargs):
return func(a, 2, *args, **kwargs)
return wrapped
assert inject_list(wrappable_func)(1) == (1, 2)
def inject_nonexistent_arg(func):
@wraps(func, injected=["X"])
def wrapped(*args, **kwargs):
return func(*args, **kwargs)
return wrapped
with pytest.raises(ValueError):
inject_nonexistent_arg(wrappable_func)
def inject_missing_argument(func):
@wraps(func, injected="c")
def wrapped(*args, **kwargs):
return func(1, *args, **kwargs)
return wrapped
def inject_misc_argument(func):
# inject_to_varkw is default True, just being explicit
@wraps(func, injected="c", inject_to_varkw=True)
def wrapped(*args, **kwargs):
return func(c=1, *args, **kwargs)
return wrapped
assert inject_misc_argument(wrappable_varkw_func)(1, 2) == (1, 2)
def inject_misc_argument_no_varkw(func):
@wraps(func, injected="c", inject_to_varkw=False)
def wrapped(*args, **kwargs):
return func(c=1, *args, **kwargs)
return wrapped
with pytest.raises(ValueError):
inject_misc_argument_no_varkw(wrappable_varkw_func)
def test_wraps_update_dict():
def updated_dict(func):
@wraps(func, update_dict=True)
def wrapped(*args, **kwargs):
return func(*args, **kwargs)
return wrapped
def f(a, b):
return a, b
f.something = True
assert getattr(updated_dict(f), 'something')
def test_wraps_unknown_args():
def fails(func):
@wraps(func, foo="bar")
def wrapped(*args, **kwargs):
return func(*args, **kwargs)
return wrapped
with pytest.raises(TypeError):
fails(wrappable_func)
def test_FunctionBuilder_invalid_args():
with pytest.raises(TypeError):
FunctionBuilder(name="fails", foo="bar")
def test_FunctionBuilder_invalid_body():
with pytest.raises(SyntaxError):
FunctionBuilder(name="fails", body="*").get_func()
def test_FunctionBuilder_modify():
fb = FunctionBuilder('return_five', doc='returns the integer 5',
body='return 5')
f = fb.get_func()
assert f() == 5
fb.varkw = 'kw'
f_kw = fb.get_func()
assert f_kw(ignored_arg='ignored_val') == 5
def test_wraps_wrappers():
call_list = []
def call_list_appender(func):
@wraps(func)
def appender(*a, **kw):
call_list.append((a, kw))
return func(*a, **kw)
return appender
with pytest.raises(TypeError):
class Num:
def __init__(self, num):
self.num = num
@call_list_appender
@classmethod
def added(cls, x, y=1):
return cls(x + y)
return
def test_FunctionBuilder_add_arg():
fb = FunctionBuilder('return_five', doc='returns the integer 5',
body='return 5')
f = fb.get_func()
assert f() == 5
fb.add_arg('val')
f = fb.get_func()
assert f(val='ignored') == 5
with pytest.raises(ValueError) as excinfo:
fb.add_arg('val')
excinfo.typename == 'ExistingArgument'
fb = FunctionBuilder('return_val', doc='returns the value',
body='return val')
broken_func = fb.get_func()
with pytest.raises(NameError):
broken_func()
fb.add_arg('val', default='default_val')
better_func = fb.get_func()
assert better_func() == 'default_val'
assert better_func('positional') == 'positional'
assert better_func(val='keyword') == 'keyword'
def test_wraps_expected():
def expect_string(func):
@wraps(func, expected="c")
def wrapped(*args, **kwargs):
args, c = args[:2], args[-1]
return func(*args, **kwargs) + (c,)
return wrapped
expected_string = expect_string(wrappable_func)
assert expected_string(1, 2, 3) == (1, 2, 3)
with pytest.raises(TypeError) as excinfo:
expected_string(1, 2)
# a rough way of making sure we got the kind of error we expected
assert 'argument' in repr(excinfo.value)
def expect_list(func):
@wraps(func, expected=["c"])
def wrapped(*args, **kwargs):
args, c = args[:2], args[-1]
return func(*args, **kwargs) + (c,)
return wrapped
assert expect_list(wrappable_func)(1, 2, c=4) == (1, 2, 4)
def expect_pair(func):
@wraps(func, expected=[('c', 5)])
def wrapped(*args, **kwargs):
args, c = args[:2], args[-1]
return func(*args, **kwargs) + (c,)
return wrapped
assert expect_pair(wrappable_func)(1, 2) == (1, 2, 5)
def expect_dict(func):
@wraps(func, expected={'c': 6})
def wrapped(*args, **kwargs):
args, c = args[:2], args[-1]
return func(*args, **kwargs) + (c,)
return wrapped
assert expect_dict(wrappable_func)(1, 2) == (1, 2, 6)
def test_defaults_dict():
def example(req, test='default'):
return req
fb_example = FunctionBuilder.from_func(example)
assert 'test' in fb_example.args
dd = fb_example.get_defaults_dict()
assert dd['test'] == 'default'
assert 'req' not in dd
def test_get_arg_names():
def example(req, test='default'):
return req
fb_example = FunctionBuilder.from_func(example)
assert 'test' in fb_example.args
assert fb_example.get_arg_names() == ('req', 'test')
assert fb_example.get_arg_names(only_required=True) == ('req',)
@pytest.mark.parametrize(
"args, varargs, varkw, defaults, invocation_str, sig_str",
[
(["a", "b"], None, None, None, "a, b", "(a, b)"),
(None, "args", "kwargs", None, "*args, **kwargs", "(*args, **kwargs)"),
("a", None, None, dict(a="a"), "a", "(a)"),
],
)
def test_get_invocation_sig_str(
args, varargs, varkw, defaults, invocation_str, sig_str
):
fb = FunctionBuilder(
name='return_five',
body='return 5',
args=args,
varargs=varargs,
varkw=varkw,
defaults=defaults
)
assert fb.get_invocation_str() == invocation_str
assert fb.get_sig_str() == sig_str
|