File: test_dispatcher.py

package info (click to toggle)
python-multipledispatch 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 272 kB
  • sloc: python: 1,116; makefile: 141
file content (421 lines) | stat: -rw-r--r-- 8,655 bytes parent folder | download
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
import warnings

from multipledispatch.dispatcher import (
    Dispatcher,
    MDNotImplementedError,
    MethodDispatcher,
)
from multipledispatch.conflict import ambiguities
from multipledispatch.utils import raises


def identity(x):
    return x


def inc(x):
    return x + 1


def dec(x):
    return x - 1


def test_dispatcher():
    f = Dispatcher("f")
    f.add((int,), inc)
    f.add((float,), dec)

    with warnings.catch_warnings():
        warnings.simplefilter("ignore", DeprecationWarning)
        assert f.resolve((int,)) == inc
    assert f.dispatch(int) is inc

    assert f(1) == 2
    assert f(1.0) == 0.0


def test_union_types():
    f = Dispatcher("f")
    f.register((int, float))(inc)

    assert f(1) == 2
    assert f(1.0) == 2.0


def test_dispatcher_as_decorator():
    f = Dispatcher("f")

    @f.register(int)
    def inc(x):
        return x + 1

    @f.register(float)
    def dec(x):
        return x - 1

    assert f(1) == 2
    assert f(1.0) == 0.0


def test_register_instance_method():
    class Test(object):
        __init__ = MethodDispatcher("f")

        @__init__.register(list)
        def _init_list(self, data):
            self.data = data

        @__init__.register(object)
        def _init_obj(self, datum):
            self.data = [datum]

    a = Test(3)
    b = Test([3])
    assert a.data == b.data


def test_on_ambiguity():
    f = Dispatcher("f")

    def identity(x):
        return x

    ambiguities = [False]

    def on_ambiguity(dispatcher, amb):
        ambiguities[0] = True

    f.add((object, object), identity)
    f.add((object, float), identity)
    f.add((float, object), identity)

    assert not ambiguities[0]
    f.reorder(on_ambiguity=on_ambiguity)
    assert ambiguities[0]


def test_serializable():
    f = Dispatcher("f")
    f.add((int,), inc)
    f.add((float,), dec)
    f.add((object,), identity)

    import pickle

    assert isinstance(pickle.dumps(f), (str, bytes))

    g = pickle.loads(pickle.dumps(f))

    assert g(1) == 2
    assert g(1.0) == 0.0
    assert g("hello") == "hello"


def test_raise_error_on_non_class():
    f = Dispatcher("f")
    assert raises(TypeError, lambda: f.add((1,), inc))


def test_docstring():
    def one(x, y):
        """Docstring number one"""
        return x + y

    def two(x, y):
        """Docstring number two"""
        return x + y

    def three(x, y):
        return x + y

    master_doc = "Doc of the multimethod itself"

    f = Dispatcher("f", doc=master_doc)
    f.add((object, object), one)
    f.add((int, int), two)
    f.add((float, float), three)

    assert one.__doc__.strip() in f.__doc__
    assert two.__doc__.strip() in f.__doc__
    assert f.__doc__.find(one.__doc__.strip()) < f.__doc__.find(two.__doc__.strip())
    assert "object, object" in f.__doc__
    assert master_doc in f.__doc__


def test_help():
    def one(x, y):
        """Docstring number one"""
        return x + y

    def two(x, y):
        """Docstring number two"""
        return x + y

    def three(x, y):
        """Docstring number three"""
        return x + y

    master_doc = "Doc of the multimethod itself"

    f = Dispatcher("f", doc=master_doc)
    f.add((object, object), one)
    f.add((int, int), two)
    f.add((float, float), three)

    assert f._help(1, 1) == two.__doc__
    assert f._help(1.0, 2.0) == three.__doc__


def test_source():
    def one(x, y):
        """Docstring number one"""
        return x + y

    def two(x, y):
        """Docstring number two"""
        return x - y

    master_doc = "Doc of the multimethod itself"

    f = Dispatcher("f", doc=master_doc)
    f.add((int, int), one)
    f.add((float, float), two)

    assert "x + y" in f._source(1, 1)
    assert "x - y" in f._source(1.0, 1.0)


def test_source_raises_on_missing_function():
    f = Dispatcher("f")

    assert raises(TypeError, lambda: f.source(1))


def test_no_implementations():
    f = Dispatcher("f")
    assert raises(NotImplementedError, lambda: f("hello"))


def test_register_stacking():
    f = Dispatcher("f")

    @f.register(list)
    @f.register(tuple)
    def rev(x):
        return x[::-1]

    assert f((1, 2, 3)) == (3, 2, 1)
    assert f([1, 2, 3]) == [3, 2, 1]

    assert raises(NotImplementedError, lambda: f("hello"))
    assert rev("hello") == "olleh"


def test_dispatch_method():
    f = Dispatcher("f")

    @f.register(list)
    def rev(x):
        return x[::-1]

    @f.register(int, int)
    def add(x, y):
        return x + y

    class MyList(list):
        pass

    assert f.dispatch(list) is rev
    assert f.dispatch(MyList) is rev
    assert f.dispatch(int, int) is add


def test_not_implemented():
    f = Dispatcher("f")

    @f.register(object)
    def _1(x):
        return "default"

    @f.register(int)
    def _2(x):
        if x % 2 == 0:
            return "even"
        else:
            raise MDNotImplementedError()

    assert f("hello") == "default"  # default behavior
    assert f(2) == "even"  # specialized behavior
    assert f(3) == "default"  # fall back to default behavior
    assert raises(NotImplementedError, lambda: f(1, 2))


def test_not_implemented_error():
    f = Dispatcher("f")

    @f.register(float)
    def _(a):
        raise MDNotImplementedError()

    assert raises(NotImplementedError, lambda: f(1.0))


def test_vararg_not_last_element_of_signature():
    f = Dispatcher("f")
    assert raises(TypeError, lambda: f.register([float], str)(lambda: None))


def test_vararg_has_multiple_elements():
    f = Dispatcher("f")
    assert raises(TypeError, lambda: f.register([float, str])(lambda: None))


def test_vararg_dispatch_simple():
    f = Dispatcher("f")

    @f.register([float])
    def _1(*args):
        return args

    assert f(1.0) == (1.0,)
    assert f(1.0, 2.0, 3.0) == (1.0, 2.0, 3.0)


def test_vararg_dispatch_ambiguity():
    f = Dispatcher("f")

    @f.register(float, object, [int])
    def _1(a, b, *args):
        return 1

    @f.register(object, float, [int])
    def _2(a, b, *args):
        return 2

    assert ambiguities(f.funcs)


def test_vararg_dispatch_ambiguity_in_variadic():
    f = Dispatcher("f")

    @f.register(float, [object])
    def _1(a, b, *args):
        return 1

    @f.register(object, [float])
    def _2(a, b, *args):
        return 2

    assert ambiguities(f.funcs)


def test_vararg_dispatch_multiple_types_explicit_args():
    f = Dispatcher("f")

    @f.register(str, [float])
    def _1(a, *b):
        return (a, b)

    result = f("a", 1.0, 2.0, 3.0)
    assert result == ("a", (1.0, 2.0, 3.0))


def test_vararg_dispatch_multiple_implementations():
    f = Dispatcher("f")

    @f.register(str, [float])
    def _1(a, *b):
        return "mixed_string_floats"

    @f.register([float])
    def _2(*b):
        return "floats"

    @f.register([str])
    def _3(*strings):
        return "strings"

    assert f("a", 1.0, 2.0) == "mixed_string_floats"
    assert f(1.0, 2.0, 3.14) == "floats"
    assert f("a", "b", "c") == "strings"


def test_vararg_dispatch_unions():
    f = Dispatcher("f")

    @f.register(str, [(int, float)])
    def _1(a, *b):
        return "mixed_string_ints_floats"

    @f.register([str])
    def _2(*strings):
        return "strings"

    @f.register([(str, int)])
    def _3(*strings_ints):
        return "mixed_strings_ints"

    @f.register([object])
    def _4(*objects):
        return "objects"

    assert f("a", 1.0, 7, 2.0, 11) == "mixed_string_ints_floats"
    assert f("a", "b", "c") == "strings"
    assert f("a", 1, "b", 2) == "mixed_strings_ints"
    assert f([], (), {}) == "objects"


def test_vararg_no_args():
    f = Dispatcher("f")

    @f.register([str])
    def _1(*strings):
        return "strings"

    assert f() == "strings"


def test_vararg_no_args_failure():
    f = Dispatcher("f")

    @f.register(str, [str])
    def _2(*strings):
        return "strings"

    assert raises(NotImplementedError, f)


def test_vararg_no_args_failure_2():
    f = Dispatcher("f")

    @f.register([str])
    def _2(*strings):
        return "strings"

    assert raises(NotImplementedError, lambda: f("a", "b", 1))


def test_vararg_ordering():
    f = Dispatcher("f")

    @f.register(str, int, [object])
    def _1(string, integer, *objects):
        return 1

    @f.register(str, [object])
    def _2(string, *objects):
        return 2

    @f.register([object])
    def _3(*objects):
        return 3

    assert f("a", 1) == 1
    assert f("a", 1, ["a"]) == 1
    assert f("a", 1, "a") == 1
    assert f("a", "a") == 2
    assert f("a") == 2
    assert f("a", ["a"]) == 2
    assert f(1) == 3
    assert f() == 3