-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathdispatch.py
More file actions
760 lines (605 loc) · 34.7 KB
/
dispatch.py
File metadata and controls
760 lines (605 loc) · 34.7 KB
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
# -*- coding: utf-8; -*-
"""A multiple-dispatch system (a.k.a. multimethods) for Python.
Terminology:
- The function that supports multiple call signatures is a *generic function*.
- Its individual implementations are *multimethods*.
We use the term *multimethod* to distinguish them from the usual sense of *method*
in Python, and because this is multiple dispatch.
Somewhat like `functools.singledispatch`, but for multiple dispatch.
https://docs.python.org/3/library/functools.html#functools.singledispatch
Somewhat like `typing.overload`, but for run-time use, not static type-checking.
Here the implementations are given in the multimethod bodies.
https://docs.python.org/3/library/typing.html#typing.overload
"""
# TODO: Reimplement in the same spirit as `functools.singledispatch`?
# TODO: The complication is, we support `typing` type specifications, not only concrete types.
# TODO: OTOH, `singledispatch` does handle the specific case of ABCs, via the subtype hooks.
__all__ = ["isgeneric", "generic", "augment", "typed",
"methods", "format_methods", "list_methods"]
from functools import partial, wraps
from itertools import chain
import inspect
import typing
from .arity import getfunc, _resolve_bindings
from .typecheck import isoftype
from .regutil import register_decorator
_dispatcher_registry = {}
# Not strictly part of "the" public API, but stealthily public (with the usual
# public-API guarantees) because, although unlikely, an occasional user may
# need to customize this.
self_parameter_names = ["self", "this", "cls", "klass"]
# TODO: meh, a list instance's __doc__ is not writable. Put this doc somewhere.
#
# self_parameter_names.__doc__ = """`self`/`cls` parameter names for `@generic`.
#
# When one of these parameter names appears in the first positional parameter position
# of a function decorated with `@generic` (or `@typed`), it is detected as being an
# OOP-related `self` or `cls` parameter, triggering special handling.
#
# If you use something other than the usual Python naming conventions for the `self`/`cls`
# parameter, just append the names you use to this list.
# """
def isgeneric(f):
"""Return whether the callable `f` is a generic function.
If `f` was declared `@generic` (which see), return the string `"generic"`.
If `f` was declared `@typed` (which see), return the string `"typed"`.
Else return `False`.
"""
if hasattr(f, "_method_registry"):
if hasattr(f, "_register"):
return "generic"
return "typed"
return False
# TODO: We essentially need the fullname because the second and further invocations
# TODO: of `@generic`, for the same generic function, receive an entirely different
# TODO: run-time object - the new multimethod. There is no way to know which existing
# TODO: dispatcher to connect that to, other than having a registry that maps the
# TODO: fullname of each already-existing generic function to its dispatcher object.
@register_decorator(priority=98)
def generic(f):
"""Decorator. Make `f` a generic function (in the sense of CLOS or Julia).
Multiple dispatch solves *the expression problem*:
https://en.wikipedia.org/wiki/Expression_problem
Practical use cases:
- Eliminate `if`/`elif`/`elif`... blocks that switch by `isinstance` on
function arguments, and then raise `TypeError` in the final `else`,
by having a central implementation for this machinery.
This not only kills boilerplate, but makes the dispatch extensible,
since the dispatcher lives outside the original function definition.
There is no need to monkey-patch the original to add a new case.
See `@augment`.
- Dispatch on an extensible hierarchy of abstract features (called *traits*)
that is separate from the concrete type hierarchy, using the *holy traits*
pattern. For example, "behaves like a number" can be a trait.
See `unpythonic/tests/test_dispatch.py` for an example.
- Functions like the builtin `range`, where the *role* of an argument in a
particular position depends on the *number of* arguments passed in the call.
With `@generic`, each case can have its parameters named descriptively.
**How to use**:
Make several function definitions, with the same name in the same lexical
scope, one for each call signature you want to support, and decorate each of
them with `@generic`. Here *signature* refers to specific combinations of
argument types and/or different shapes for the argument list.
The first definition implicitly creates the generic function (like in
Julia). All of the definitions, including the first one, become registered
as *multimethods* of the *generic function*.
The return value of `generic` is the multiple-dispatch dispatcher
for the generic function that was created or modified.
A generic function is identified by its *fullname*, defined as
"{f.__module__}.{f.__qualname__}". The fullname is computed
automatically when the `@generic` decorator runs. For example:
- Top-level function in main module: "__main__.myfunction"
- Top-level function in another module: "unpythonic.fold.scanl"
- Nested function (closure) in main module: "__main__.test.<locals>.myhelper"
Example::
@generic
def example(x: int, y: int):
... # implementation here
@generic # noqa: F811, registered as a multimethod of the same generic function.
def example(x: str, y: int):
... # implementation here
@generic # noqa: F811
def example(x: str, y: float):
... # implementation here
@generic # noqa: F811
def example(x: str):
... # implementation here
@generic # noqa: F811
def example():
... # implementation here
Due to the need to have a meaningful `__qualname__` to construct the
fullname, lambdas are not officially supported. If you must, you can try to
`unpythonic.misc.namelambda` your lambda first, but be aware that even
then, nested lambdas are not supported.
Be careful that if you later rebind a variable that refers to a generic
function, that will not remove previously existing method definitions.
If you later rebind the same name again, pointing to a new generic function,
it will suddenly gain all of the methods of the previous function that had
the same fullname.
As of v0.15.0, multimethods cannot be unregistered.
**Multimethod lookup**:
Each method definition must specify type hints **on all of its parameters**.
Then, at call time, the types of **all** arguments, as well as the number
of arguments, are automatically used for *dispatching*, i.e. choosing which
implementation to call. In other words, multiple parameters participate in
dispatching, hence *multiple dispatch*.
**Varargs are supported**. Vararg type hint examples::
- `*args: typing.Tuple[int, ...]` means "any number of `int`s"
- `*args: typing.Tuple[int, float, str]` means "exactly `(int, float, str)`,
in that order"
- `**kwargs: typing.Dict[str, int]` means "all **kwargs are of type `int`".
Note the key type for the `**kwargs` dict is always `str`.
**The first multimethod that matches wins, in most-recently-registered order.**
(This is unlike in Julia, which matches the most specific applicable multimethod.)
In other words, later multimethod definitions override earlier ones. So specify
the implementation with the most generic types first, and then move on to the
more specific ones. The mnemonic is, "the function is generally defined like
this, except if the arguments match these particular types..."
**Differences to tools in the standard library**:
Unlike in `functools.singledispatch`, there is no "master" definition and
no public `register` attribute. Instead, generic functions are saved in a
global registry.
Unlike `typing.overload`, the implementations are given in the multimethod
bodies.
**Interaction with OOP**:
Beside regular functions, `@generic` can be installed on instance, class
or static *methods* (in the OOP sense). `self` and `cls` parameters do not
participate in dispatching, and need no type annotation.
On instance and class methods, the self-like parameter, beside appearing as
the first positional-or-keyword parameter, **must be named** one of `self`,
`this`, `cls`, or `klass` to be detected by the ignore mechanism. This
limitation is due to implementation reasons; while a class body is being
evaluated, the context needed to distinguish a method from a regular function
is not yet present.
When `@generic` is installed on an instance method or on a `@classmethod`,
then at call time, classes are tried in MRO order. **All** multimethods
of the method defined in the class currently being looked up are tested
for matches first, **before** moving on to the next class in the MRO.
This has subtle consequences, related to in which class in the hierarchy
the various multimethods for a particular method are defined.
For *static methods* MRO lookup is not supported. Basically, one of the
roles of `cls` or `self` is to define the MRO; a `@staticmethod` doesn't
have that.
To work with OOP inheritance, in the decorator list, `@generic` must be
on inside of (i.e. run before) `@classmethod` or `@staticmethod`.
**Interaction with `curry`**:
Starting with v0.15.0, `curry` supports `@generic`. In the case where the
*number* of positional arguments supplied so far is acceptable for *some*
registered multimethod, but some parameters of that multimethod are still
missing bindings (i.e. it is not a full match), `curry` waits for more
arguments (returning the curried function).
Passing an argument of an invalid type at any step of currying immediately
raises `TypeError`. Here "invalid type" means that for the partial application
constructed so far, no registered multimethod accepts the new argument(s).
**CAUTION**:
To declare a parameter of a multimethod as dynamically typed, explicitly
annotate it as `typing.Any`; don't just omit the type annotation.
Explicit is better than implicit; **this is a feature**.
See the limitations in `unpythonic.typecheck` for which features of the
`typing` module are supported and which are not.
Code using the `with lazify` macro cannot usefully use `@generic` or `@typed`,
because all arguments of each function call will be wrapped in a promise
(`unpythonic.lazyutil.Lazy`) that carries no type information on its contents.
"""
return _setup(_function_fullname(f), f)
@register_decorator(priority=98)
def augment(target):
"""Parametric decorator. Add a multimethod to generic function `target`.
Like `@generic`, but the generic function on which the method will be
registered is chosen separately, so that you can augment a generic
function previously defined in some other `.py` source file.
The return value of `augment` is the multiple-dispatch dispatcher
for the generic function that was modified.
Usage::
# example.py
from unpythonic import generic
@generic
def f(x: int):
...
# main.py
from unpythonic import augment
import example
class MyOwnType:
...
@augment(example.f)
def f(x: MyOwnType):
...
**CAUTION**: Beware of type piracy when you use `@augment`. That is:
1. For arbitrary input types you don't own, augment only a function you own, OR
2. Augment a function defined somewhere else only if at least one parameter
(in the call signature you are adding) is of a type you own.
Satisfying **one** of these conditions is sufficient to avoid type piracy.
See:
https://lexi-lambda.github.io/blog/2016/02/18/simple-safe-multimethods-in-racket/
https://en.wikipedia.org/wiki/Action_at_a_distance_(computer_programming)
https://docs.julialang.org/en/v1/manual/style-guide/#Avoid-type-piracy
"""
if not isgeneric(target):
raise TypeError(f"{_function_fullname(target)} is not a generic function, cannot add multimethods to it.")
return partial(_setup, _function_fullname(target))
@register_decorator(priority=98)
def typed(f):
"""Decorator. Restrict allowed argument types to one combination only.
This can be used to eliminate `isinstance` boilerplate code in the
function body, by allowing the types (for dynamic, run-time checking)
to be specified with a very compact syntax - namely, type annotations.
Also, unlike a basic `isinstance` check, this allows using features
from the `typing` stdlib module in the type specifications.
Once a `@typed` function has been created, no more multimethods can be
attached to it.
**CAUTION**:
Code using the `with lazify` macro cannot usefully use `@generic` or `@typed`,
because all arguments of each function call will be wrapped in a promise
(`unpythonic.lazyutil.Lazy`) that carries no type information on its contents.
"""
s = generic(f)
del s._register # remove the ability to register more methods
return s
def methods(f):
"""Print, to stdout, a human-readable list of multimethods currently registered to `f`.
For introspection in the REPL. This works by calling `list_methods`, which see.
Example - entering this in an IPython session::
from unpythonic import generic, methods
@generic
def f(x: int):
return "int"
@generic
def f(x: float):
return "float"
methods(f)
the result is:
Multimethods for @generic __main__.f:
f(x: float) from <ipython-input-3-16b8c86cf15d>:1
f(x: int) from <ipython-input-2-f723dd86dcd6>:1
This is like the `methods` function of Julia.
"""
print(format_methods(f))
def format_methods(f):
"""Format, as a string, a human-readable list of multimethods currently registered to `f`.
One level lower than `methods`; format a human-readable message, but return it
instead of printing it.
This works by calling `list_methods`, which see.
"""
function, _ = getfunc(f)
multimethods = list_methods(f)
if multimethods:
thecallables = [thecallable for thecallable, type_signature in multimethods]
methods_list = [f" {_format_callable(x)}" for x in thecallables]
methods_str = "\n".join(methods_list)
else: # pragma: no cover, in practice a generic should always have at least one method.
methods_str = " <no multimethods registered>"
return f"Multimethods for @{isgeneric(f)} {_function_fullname(function)}:\n{methods_str}"
def list_methods(f):
"""Return a list of the multimethods currently registered to `f`.
The multimethods are returned in the order they would be tested by the dispatcher
when the generic function is called.
The return value is a list, where each item is `(callable, type_signature)`.
Each type signature is in the format returned by `typing.get_type_hints`.
`f`: a callable that has been declared `@generic` or `@typed`.
**Interaction with OOP**:
Bound methods are resolved to the underlying function automatically.
The `self`/`cls` argument is extracted from the `__self__` attribute of
the bound method, enabling linked dispatcher lookups in the MRO.
**CAUTION**:
Recall that in Python, instance methods when accessed through the *class*
are just raw functions; the method becomes bound, and thus `self` is set,
when accessed through *an instance* of that class.
Let `Cat` be a class with an OOP instance method `meow`, and `cat` an
instance of that class. If you call `list_methods(cat.meow)`, you get the
MRO lookup for linked dispatchers, as expected.
But if you call `list_methods(Cat.meow)` instead, it won't see the MRO,
because the value of the `self` argument isn't set for an unbound method
(which is really just a raw function).
If `Cat` has a `@classmethod` `iscute`, calling `list_methods(Cat.iscute)`
performs the MRO lookup for linked dispatchers. This is because a class
method is already bound (to the class, so the `cls` argument already has
a value) when it is accessed through the class.
Finally, note that while that is how `list_methods` works, it is not the
mechanism actually used to determine `self`/`cls` when *calling* the
generic function. There, the value of `self`/`cls` is extracted from the
first positional argument of the call. This is because the dispatcher is
actually installed on the underlying raw function, so it has no access to
the metadata of the bound method (which, as seen from the dispatcher, is
on the outside).
"""
function, _ = getfunc(f)
if not isgeneric(function):
raise TypeError(f"{_function_fullname(function)} is not a generic function, it does not have multimethods.")
# In case of a bound method (either `Foo.classmeth` or `foo.instmeth`),
# we can get the value for `self`/`cls` argument from its `__self__` attribute.
#
# Otherwise we have a regular function, an unbound method, or a `@staticmethod`;
# in those cases, there's no `self`/`cls`. (Technically, an unbound method has
# a parameter to receive it, but no value has been set yet.)
self_or_cls = f.__self__ if hasattr(f, "__self__") else None
return _list_multimethods(function, self_or_cls)
# --------------------------------------------------------------------------------
# Modeled after `mcpyrate.utils.format_macrofunction`, which does the same thing for macros.
def _function_fullname(f):
"""Return the full name of the callable `f`, including also its module name."""
function, _ = getfunc(f) # get the raw function also for OOP methods
if not function.__module__: # At least macros defined in the REPL have `__module__=None`.
return function.__qualname__
return f"{function.__module__}.{function.__qualname__}"
def _name_of_1st_positional_parameter(f):
"""Return the name, as a string, of the first positional parameter of the callable `f`."""
function, _ = getfunc(f) # get the raw function also for OOP methods
parameters = inspect.signature(function).parameters
poskinds = set((inspect.Parameter.POSITIONAL_ONLY,
inspect.Parameter.POSITIONAL_OR_KEYWORD))
for param in parameters.values():
if param.kind in poskinds:
return param.name
return None
def _list_multimethods(dispatcher, self_or_cls=None):
"""List multimethods currently registered to a given dispatcher.
`self_or_cls`: If `dispatcher` is installed on an instance method
or on a `@classmethod`, set this to perform MRO
lookups to find linked dispatchers.
"""
# TODO: Compute closest candidates, like Julia does? (see `methods`, `MethodError` in Julia)
# TODO: (If we do that, we need to look at the bound arguments. When just listing multimethods
# TODO: in the REPL, the current ordering is probably fine.)
# For regular functions, ours is the only registry we need to look at:
relevant_registries = [reversed(dispatcher._method_registry)]
# But if this dispatcher is installed on a method, we must
# look up multimethods also in the class's MRO.
#
# For *static methods* MRO is not supported. Basically, one of
# the roles of `cls` or `self` is to define the MRO; a static
# method doesn't have that.
#
# See discussions on interaction between `@staticmethod` and `super` in Python:
# https://bugs.python.org/issue31118
# https://stackoverflow.com/questions/26788214/super-and-staticmethod-interaction/26807879
if self_or_cls:
if isinstance(self_or_cls, type):
cls = self_or_cls
elif hasattr(self_or_cls, "__class__"):
cls = self_or_cls.__class__
else:
assert False
for base in cls.__mro__[1:]: # skip the class itself in the MRO
if hasattr(base, dispatcher.__name__): # does this particular super have f?
base_oop_method = getattr(base, dispatcher.__name__)
base_raw_function, _ = getfunc(base_oop_method)
if isgeneric(base_raw_function): # it's @generic or @typed
base_registry = getattr(base_raw_function, "_method_registry")
relevant_registries.append(reversed(base_registry))
return list(chain.from_iterable(relevant_registries))
# TODO: move this utility to `unpythonic.fun`? Belongs there, but doing so introduces a circular dependency.
def _format_callable(thecallable):
"""Format, as a string, a human-readable description of a callable.
The returned string includes the call signature, and the source filename
and starting line number. This output format takes a page from Julia,
with some artistic liberty.
"""
# Our `type_signature` is based on `typing.get_type_hints`,
# but for the error message, we need something that formats
# like source code. Hence we use `inspect.signature`.
thesignature = inspect.signature(thecallable)
function, _ = getfunc(thecallable) # raw function for OOP methods, too
# TODO: Python 3.8: filename sometimes detected incorrectly
# - This is because `inspect.getsourcefile` uses `inspect.getfile`, which looks at
# the `co_filename` of the code object. If the function is decorated, then it sees
# the source file where the decorator was defined, not the original function.
# function = inspect.unwrap(function) # maybe this helps? But now I can't reproduce the bug to test it.
filename = inspect.getsourcefile(function)
source, firstlineno = inspect.getsourcelines(function)
return f"{thecallable.__qualname__}{str(thesignature)} from {filename}:{firstlineno}"
def _resolve_multimethod(dispatcher, args, kwargs, *, _partial=False):
"""Return the first matching multimethod on `dispatcher` for the given `args` and `kwargs`.
If `_partial` is `True`, allow leaving some parameters of the function unbound,
and return the first multimethod that matches the given partial `args` and `kwargs`.
The partial mode is useful for type-checking arguments for partial application of a generic
function. If any multimethod matches (this function returns something other than `None`),
then the generic function can accept those partial arguments.
Note it is only possible to dispatch, i.e. determine which multimethod is the one to be
called, only once we have full (non-partial) `args` and `kwargs`, because in general
the remaining not-yet-passed `args` or `kwargs` may cause the search to match a
different multimethod. In partial mode, this function says only that there is
*at least one* match when given those partial arguments.
"""
multimethods = _list_multimethods(dispatcher, _extract_self_or_cls(dispatcher, args))
for thecallable, type_signature in multimethods:
try:
bound_arguments = _resolve_bindings(thecallable, args, kwargs, _partial=_partial)
if not _get_argument_type_mismatches(type_signature, bound_arguments):
return thecallable
except TypeError: # could not accept the given arguments; this isn't the multimethod we're looking for.
continue
return None
def _get_argument_type_mismatches(type_signature, bound_arguments, *, skip_unannotated=False):
"""Match bound arguments against the given type signature.
Return a list of type mismatches. If it is empty, everything is ok.
When not, each item is of the form `(parameter, value, expected_type)`.
`type_signature`: in the format returned by `typing.get_type_hints`.
Is allowed to contain additional items not present
in `bound_arguments`, useful for type-checking during
partial application.
If `skip_unannotated=False` (default), `type_signature`
**must** contain an item for each key of `bound_arguments`.
If `skip_unannotated=True`, then any binding whose key
is not in `type_signature` will not be type-checked.
In plain English, the function can have some unannotated
parameters, to denote those parameters should not be
type-checked.
`unpythonic`'s multiple-dispatch subsystem requires
explicitly annotating `typing.Any` instead of omitting
the type annotation, but this function can be used
by other parts of `unpythonic`.
`bound_arguments`: see `unpythonic.arity.resolve_bindings`.
"""
mismatches = []
for parameter, value in bound_arguments.arguments.items():
if parameter not in type_signature:
if skip_unannotated:
continue
raise ValueError(f"type_signature has no item for parameter {parameter}, which was supplied in `bound_arguments`. If that was intended, please use `skip_unannotated=True`.")
expected_type = type_signature[parameter]
if not isoftype(value, expected_type):
mismatches.append((parameter, value, expected_type))
return mismatches
def _extract_self_or_cls(thecallable, args):
"""From `thecallable` and positional arguments `args`, extract the value of `self`/`cls`, if any.
Return value is either the value bound that would be bound to `self`/`cls`
(the first positional parameter), or `None`.
"""
# TODO/FIXME: Not possible to detect `self`/`cls` parameters correctly.
#
# Here we're operating at the wrong abstraction level for that,
# since we see just bare functions. In the OOP case, the dispatcher
# is installed on the raw function before it becomes a bound method.
# (That in itself is just as it should be.)
first_param_name = _name_of_1st_positional_parameter(thecallable)
most_likely_an_oop_method = first_param_name in self_parameter_names
# Let's see if we might have been passed a `self`/`cls` parameter,
# and if so, get its value. (Recall that in Python, it is always
# the first positional parameter.)
if most_likely_an_oop_method:
if len(args) < 1: # pragma: no cover, shouldn't happen.
raise TypeError(f"MRO lookup failed: no value provided for self-like parameter {repr(first_param_name)} for OOP method-like generic function {_function_fullname(thecallable)}")
self_or_cls = args[0]
else:
self_or_cls = None
return self_or_cls
def _raise_multiple_dispatch_error(dispatcher, args, kwargs, *, candidates, _partial=False):
"""Raise a nicely formatted `TypeError` regarding a failed multiple dispatch (no matching multimethod).
`candidates`: list of `(thecallable, type_signature)` that were attempted, but did not match.
`_partial`: if `True`, report a failure in a *partial application*.
if `False`, report a failure in a *call*.
"""
# For `@typed` functions, which have just one valid call signature, we can easily
# report which args or kwargs failed to match.
if len(candidates) == 1:
# TODO: There's some repeated error-reporting code in `unpythonic.fun`.
thecallable, type_signature = candidates[0]
bound_arguments = _resolve_bindings(thecallable, args, kwargs, _partial=_partial)
mismatches = _get_argument_type_mismatches(type_signature, bound_arguments)
mismatches_list = [f"{parameter}={repr(value)}, expected {expected_type}"
for parameter, value, expected_type in mismatches]
mismatches_str = "; ".join(mismatches_list)
one_multimethod_msg_str = f"\nParameter binding(s) do not match type specification: {mismatches_str}"
else:
one_multimethod_msg_str = ""
# TODO: It would be nice to show the type signature of the args actually given,
# TODO: but in the general case this is difficult. We can't just `type(x)`, since
# TODO: the signature may specify something like `Sequence[int]`. Knowing a `list`
# TODO: was passed doesn't help debug that it was `Sequence[str]` when a `Sequence[int]`
# TODO: was expected. The actual value at least implicitly contains the type information.
args_list = [repr(x) for x in args]
args_str = ", ".join(args_list)
if _partial and args_str:
args_str += ", ..."
sep = ", " if args and kwargs else ""
kws_list = [f"{k}={repr(v)}" for k, v in kwargs.items()]
kws_str = ", ".join(kws_list)
if _partial and kws_str:
kws_str += ", ..."
if _partial and not args_str and not kws_str:
args_str = "..."
thecallables = [thecallable for thecallable, type_signature in candidates]
methods_list = [f" {_format_callable(x)}" for x in thecallables]
methods_str = "\n".join(methods_list)
op = "partial application" if _partial else "call"
msg = (f"No multiple-dispatch match for the {op} {dispatcher.__qualname__}({args_str}{sep}{kws_str}).\n"
f"Multimethods for @{isgeneric(dispatcher)} {_function_fullname(dispatcher)} (most recent match attempt last):\n{methods_str}"
f"{one_multimethod_msg_str}")
raise TypeError(msg)
def _setup(fullname, multimethod):
"""Register a multimethod for a generic function, creating the generic function if necessary.
This is a low-level function; you'll likely want `@generic` or `@augment`.
`fullname`: str, fully qualified name of function to register the multimethod
on, used as key in the dispatcher registry.
Registering the first multimethod on a given `fullname` makes
that function generic, and creates the dispatcher for it.
Second and further registrations using the same `fullname` add
the new multimethod to the existing dispatcher.
`multimethod`: callable, the new multimethod to register.
Return value is the dispatcher.
"""
if fullname not in _dispatcher_registry:
# Create the dispatcher. This will replace the original function.
@wraps(multimethod)
def dispatcher(*args, **kwargs):
thecallable = _resolve_multimethod(dispatcher, args, kwargs)
if thecallable:
return thecallable(*args, **kwargs)
_raise_multiple_dispatch_error(dispatcher, args, kwargs,
candidates=_list_multimethods(dispatcher,
_extract_self_or_cls(dispatcher, args)))
dispatcher._method_registry = []
dispatcher._register = partial(_register_to, dispatcher)
_dispatcher_registry[fullname] = dispatcher
dispatcher = _dispatcher_registry[fullname]
if isgeneric(dispatcher) == "typed":
raise TypeError("@typed: cannot register additional multimethods.")
return dispatcher._register(multimethod) # this returns the *dispatcher*
def _register_to(dispatcher, multimethod):
"""Decorator. Register a new `multimethod` to `dispatcher`.
This is a low-level function used by `_setup`.
The multimethod must have type annotations for all of its parameters;
these are used for dispatching.
An exception is the `self` or `cls` parameter of an OOP instance
method or class method; that does not participate in dispatching,
and does not need a type annotation.
After registering, this returns `dispatcher`.
"""
# Using `inspect.signature` et al., we could auto-`Any` parameters
# that have no type annotation, but that would likely be a footgun.
# So we require a type annotation for each parameter.
#
# One exception: the `self`/`cls` parameter of OOP instance methods and
# class methods is not meaningful for dispatching, and we don't
# have a runtime value to auto-populate its expected type when the
# definition runs. So we set it to `typing.Any` in the multimethod's
# expected type signature, which makes the dispatcher ignore it.
function, _ = getfunc(multimethod)
parameters = inspect.signature(function).parameters
parameter_names = [p.name for p in parameters.values()]
type_signature = typing.get_type_hints(function)
# In the type signature, auto-`Any` the `self`/`cls` parameter, if any.
#
# TODO/FIXME: Not possible to detect `self`/`cls` parameters correctly.
#
# The `@generic` decorator runs while the class body is being
# evaluated. In that context, an instance method looks just like a
# regular function.
#
# Also if `@generic` runs before `@classmethod` (to place Python's
# implicit `cls` handling outermost), also a class method looks
# just like a regular function to us.
#
# So we HACK, and special-case some suggestive *parameter names*
# when they appear the first position, though **Python itself
# doesn't do that**. For any crazy person not following Python
# naming conventions, our approach won't work.
if len(parameter_names) >= 1 and parameter_names[0] in self_parameter_names:
# In Python 3.6+, `dict` preserves insertion order. Make sure
# the `self` parameter appears first, for clearer error messages
# when no matching method is found.
type_signature = {parameter_names[0]: typing.Any, **type_signature}
if not all(name in type_signature for name in parameter_names):
failures = [name for name in parameter_names if name not in type_signature]
plural = "s" if len(failures) > 1 else ""
repr_list = [repr(x) for x in failures]
repr_str = ", ".join(repr_list)
msg = f"Multimethod definition missing type annotation for parameter{plural}: {repr_str}"
raise TypeError(msg)
dispatcher._method_registry.append((multimethod, type_signature))
# Update entry point docstring to include docs for the new multimethod,
# and its call signature.
call_signature_desc = _format_callable(multimethod)
our_doc = call_signature_desc
if multimethod.__doc__:
our_doc += "\n" + multimethod.__doc__
isfirstmultimethod = len(dispatcher._method_registry) == 1
if isfirstmultimethod or not dispatcher.__doc__:
# Override the original doc of the function that was converted
# into the dispatcher; this adds the call signature to the top.
dispatcher.__doc__ = our_doc
else:
# Add the call signature and doc for the new multimethod.
dispatcher.__doc__ += "\n\n" + ("-" * 80) + "\n"
dispatcher.__doc__ += our_doc
return dispatcher # Replace the multimethod callable with this generic function's dispatcher.