ovld 0.3.8__py3-none-any.whl → 0.4.0__py3-none-any.whl

ovld/typemap.py

@@ -0,0 +1,383 @@
+import inspect
+import math
+import typing
+from itertools import count
+from types import CodeType
+
+from .dependent import DependentType
+from .mro import sort_types
+from .recode import generate_dependent_dispatch
+from .utils import MISSING
+
+
+class GenericAliasMC(type):
+    def __instancecheck__(cls, obj):
+        return hasattr(obj, "__origin__")
+
+
+class GenericAlias(metaclass=GenericAliasMC):
+    pass
+
+
+def is_type_of_type(t):
+    return getattr(t, "__origin__", None) is type
+
+
+class TypeMap(dict):
+    """Represents a mapping from types to handlers.
+
+    The mro of a type is considered when getting the handler, so setting the
+    [object] key creates a default for all objects.
+
+    typemap[some_type] returns a tuple of a handler and a "level" that
+    represents the distance from the handler to the type `object`. Essentially,
+    the level is the index of the type for which the handler was registered
+    in the mro of `some_type`. So for example, `object` has level 0, a class
+    that inherits directly from `object` has level 1, and so on.
+    """
+
+    def __init__(self):
+        self.entries = {}
+        self.types = set()
+
+    def register(self, obj_t, handler):
+        """Register a handler for the given object type."""
+        self.clear()
+        self.types.add(obj_t)
+        s = self.entries.setdefault(obj_t, set())
+        s.add(handler)
+
+    def __missing__(self, obj_t):
+        """Get the handler for the given type.
+
+        The result is cached so that the normal dict getitem will find it
+        the next time getitem is called.
+        """
+        results = {}
+        groups = list(sort_types(obj_t, self.types))
+
+        for lvl, grp in enumerate(reversed(groups)):
+            for cls in grp:
+                handlers = self.entries.get(cls, None)
+                if handlers:
+                    results.update({h: lvl for h in handlers})
+
+        if results:
+            self[obj_t] = results
+            return results
+        else:
+            raise KeyError(obj_t)
+
+
+class MultiTypeMap(dict):
+    """Represents a mapping from tuples of types to handlers.
+
+    The mro is taken into account to find a match. If multiple registered
+    handlers match the tuple of types that's given, if one of the handlers is
+    more specific than every other handler, that handler is returned.
+    Otherwise, the resolution is considered ambiguous and an error is raised.
+
+    Handler A, registered for types (A1, A2, ..., An), is more specific than
+    handler B, registered for types (B1, B2, ..., Bn), if there exists n such
+    that An is more specific than Bn, and for all n, either An == Bn or An is
+    more specific than Bn. An is more specific than Bn if An is a direct or
+    indirect subclass of Bn.
+
+    In other words, [int, object] is more specific than [object, object] and
+    less specific than [int, int], but it is neither less specific nor more
+    specific than [object, int] (which means there is an ambiguity).
+    """
+
+    def __init__(self, name="_ovld", key_error=KeyError):
+        self.maps = {}
+        self.priorities = {}
+        self.dependent = {}
+        self.type_tuples = {}
+        self.empty = MISSING
+        self.key_error = key_error
+        self.name = name
+        self.dispatch_id = count()
+        self.all = {}
+        self.errors = {}
+
+    def transform(self, obj):
+        if isinstance(obj, GenericAlias):
+            return type[obj]
+        elif obj is typing.Any:
+            return type[object]
+        elif isinstance(obj, type):
+            return type[obj]
+        else:
+            return type(obj)
+
+    def mro(self, obj_t_tup):
+        specificities = {}
+        candidates = None
+        nargs = len([t for t in obj_t_tup if not isinstance(t, tuple)])
+        names = {t[0] for t in obj_t_tup if isinstance(t, tuple)}
+
+        for i, cls in enumerate(obj_t_tup):
+            if isinstance(cls, tuple):
+                i, cls = cls
+
+            try:
+                results = self.maps[i][cls]
+            except KeyError:
+                results = {}
+
+            results = {
+                handler: spc
+                for (handler, sig), spc in results.items()
+                if sig.req_pos
+                <= nargs
+                <= (math.inf if sig.vararg else sig.max_pos)
+                and not (sig.req_names - names)
+            }
+
+            try:
+                vararg_results = self.maps[-1][cls]
+            except KeyError:
+                vararg_results = {}
+
+            vararg_results = {
+                handler: spc
+                for (handler, sig), spc in vararg_results.items()
+                if sig.req_pos <= nargs and i >= sig.max_pos
+            }
+
+            results.update(vararg_results)
+
+            if candidates is None:
+                candidates = set(results.keys())
+            else:
+                candidates &= results.keys()
+            for c in candidates:
+                specificities.setdefault(c, []).append(results[c])
+
+        candidates = [
+            (c, self.priorities.get(c, 0), tuple(specificities[c]))
+            for c in candidates
+        ]
+
+        # The sort ensures that if candidate A dominates candidate B, A will
+        # appear before B in the list. That's because it must dominate all
+        # other possibilities on all arguments, so the sum of all specificities
+        # has to be greater.
+        # Note: priority is always more important than specificity
+        candidates.sort(key=lambda cspc: (cspc[1], sum(cspc[2])), reverse=True)
+
+        self.all[obj_t_tup] = {
+            getattr(c[0], "__code__", None) for c in candidates
+        }
+
+        processed = set()
+
+        def _pull(candidates):
+            candidates = [
+                (c, a, b) for (c, a, b) in candidates if c not in processed
+            ]
+            if not candidates:
+                return
+            rval = [candidates[0]]
+            c1, p1, spc1 = candidates[0]
+            for c2, p2, spc2 in candidates[1:]:
+                if p1 > p2 or (
+                    spc1 != spc2 and all(s1 >= s2 for s1, s2 in zip(spc1, spc2))
+                ):
+                    # Candidate 1 dominates candidate 2
+                    continue
+                else:
+                    processed.add(c2)
+                    # Candidate 1 does not dominate candidate 2, so we add it
+                    # to the list.
+                    rval.append((c2, p2, spc2))
+            yield rval
+            if len(rval) >= 1:
+                yield from _pull(candidates[1:])
+
+        return list(_pull(candidates))
+
+    def register(self, sig, handler):
+        """Register a handler for a tuple of argument types.
+
+        Arguments:
+            sig: A Signature object.
+            handler: A function to handle the tuple.
+        """
+        self.clear()
+
+        obj_t_tup = sig.types
+        entry = (handler, sig)
+        if not obj_t_tup:
+            self.empty = entry
+
+        self.priorities[handler] = sig.priority
+        self.type_tuples[handler] = obj_t_tup
+        self.dependent[handler] = any(
+            isinstance(t[1] if isinstance(t, tuple) else t, DependentType)
+            for t in obj_t_tup
+        )
+
+        for i, cls in enumerate(obj_t_tup):
+            if isinstance(cls, tuple):
+                i, cls = cls
+            if i not in self.maps:
+                self.maps[i] = TypeMap()
+            self.maps[i].register(cls, entry)
+
+        if sig.vararg:  # pragma: no cover
+            # TODO: either add this back in, or remove it
+            if -1 not in self.maps:
+                self.maps[-1] = TypeMap()
+            self.maps[-1].register(object, entry)
+
+    def display_methods(self):
+        for h, prio in sorted(self.priorities.items(), key=lambda kv: -kv[1]):
+            prio = f"[{prio}]"
+            width = 6
+            print(f"{prio:{width}} \033[1m{h.__name__}\033[0m")
+            co = h.__code__
+            print(f"{'':{width-2}} @ {co.co_filename}:{co.co_firstlineno}")
+
+    def display_resolution(self, *args, **kwargs):
+        def dependent_match(tup, args):
+            for t, a in zip(tup, args):
+                if isinstance(t, tuple):
+                    t = t[1]
+                    a = a[1]
+                if isinstance(t, DependentType) and not t.check(a):
+                    return False
+            return True
+
+        message = "No method will be called."
+        argt = [
+            *map(self.transform, args),
+            *[(k, self.transform(v)) for k, v in kwargs.items()],
+        ]
+        finished = False
+        rank = 1
+        for grp in self.mro(tuple(argt)):
+            grp.sort(key=lambda x: x[0].__name__)
+            match = [
+                dependent_match(
+                    self.type_tuples[handler], [*args, *kwargs.items()]
+                )
+                for handler, _, _ in grp
+            ]
+            ambiguous = len([m for m in match if m]) > 1
+            for m, (handler, prio, spec) in zip(match, grp):
+                color = "\033[0m"
+                if finished:
+                    bullet = "--"
+                    color = "\033[1;90m"
+                elif not m:
+                    bullet = "!="
+                    color = "\033[1;90m"
+                elif ambiguous:
+                    bullet = "=="
+                    color = "\033[1;31m"
+                else:
+                    bullet = f"#{rank}"
+                    if rank == 1:
+                        message = f"{handler.__name__} will be called first."
+                        color = "\033[1;32m"
+                    rank += 1
+                spec = ".".join(map(str, spec))
+                lvl = f"[{prio}:{spec}]"
+                width = 2 * len(args) + 6
+                print(f"{color}{bullet} {lvl:{width}} {handler.__name__}")
+                co = handler.__code__
+                print(
+                    f"   {'':{width-1}}@ {co.co_filename}:{co.co_firstlineno}\033[0m"
+                )
+            if ambiguous:
+                message += " There is ambiguity between multiple matching methods, marked '=='."
+                finished = True
+        print("Resolution:", message)
+
+    def wrap_dependent(self, tup, handlers, group, next_call):
+        handlers = list(handlers)
+        htup = [(h, self.type_tuples[h]) for h in handlers]
+        slf = (
+            "self, "
+            if inspect.getfullargspec(handlers[0]).args[0] == "self"
+            else ""
+        )
+        return generate_dependent_dispatch(
+            tup,
+            htup,
+            next_call,
+            slf,
+            name=f"{self.name}.specialized_dispatch_{next(self.dispatch_id)}",
+            err=self.key_error(tup, group),
+            nerr=self.key_error(tup, ()),
+        )
+
+    def resolve(self, obj_t_tup):
+        results = self.mro(obj_t_tup)
+        if not results:
+            raise self.key_error(obj_t_tup, ())
+
+        funcs = []
+        for group in reversed(results):
+            handlers = [fn for (fn, _, _) in group]
+            dependent = any(self.dependent[fn] for (fn, _, _) in group)
+            if dependent:
+                nxt = self.wrap_dependent(
+                    obj_t_tup, handlers, group, funcs[-1] if funcs else None
+                )
+            elif len(group) != 1:
+                nxt = None
+            else:
+                nxt = handlers[0]
+            codes = [h.__code__ for h in handlers if hasattr(h, "__code__")]
+            funcs.append((nxt, codes))
+
+        funcs.reverse()
+
+        parents = []
+        for group, (func, codes) in zip(results, funcs):
+            tups = (
+                [obj_t_tup]
+                if not parents
+                else [(parent, *obj_t_tup) for parent in parents]
+            )
+            if func is None:
+                for tup in tups:
+                    self.errors[tup] = self.key_error(obj_t_tup, group)
+                break
+            else:
+                for tup in tups:
+                    self[tup] = func
+            if not codes:
+                break
+            parents = codes
+
+        return True
+
+    def __missing__(self, obj_t_tup):
+        if obj_t_tup and isinstance(obj_t_tup[0], CodeType):
+            real_tup = obj_t_tup[1:]
+            self[real_tup]
+            if obj_t_tup[0] not in self.all[real_tup]:
+                return self[real_tup]
+            elif obj_t_tup in self.errors:
+                raise self.errors[obj_t_tup]
+            elif obj_t_tup in self:  # pragma: no cover
+                # PROBABLY not reachable
+                return self[obj_t_tup]
+            else:
+                raise self.key_error(real_tup, ())
+
+        if not obj_t_tup:
+            if self.empty is MISSING:  # pragma: no cover
+                # Might not be reachable because of codegen
+                raise self.key_error(obj_t_tup, ())
+            else:
+                return self.empty[0]
+
+        self.resolve(obj_t_tup)
+        if obj_t_tup in self.errors:
+            raise self.errors[obj_t_tup]
+        else:
+            return self[obj_t_tup]

ovld/types.py

@@ -0,0 +1,219 @@
+import inspect
+import sys
+import typing
+from dataclasses import dataclass
+from typing import Protocol, runtime_checkable
+
+from ovld.utils import UsageError
+
+from .mro import Order, TypeRelationship, subclasscheck, typeorder
+
+try:
+    from types import UnionType
+except ImportError:  # pragma: no cover
+    UnionType = None
+
+
+def normalize_type(t, fn):
+    from .dependent import DependentType, Equals
+
+    if isinstance(t, str):
+        t = eval(t, getattr(fn, "__globals__", {}))
+
+    if t is type:
+        t = type[object]
+    elif t is typing.Any:
+        t = object
+    elif t is inspect._empty:
+        t = object
+    elif isinstance(t, typing._AnnotatedAlias):
+        t = t.__origin__
+
+    origin = getattr(t, "__origin__", None)
+    if UnionType and isinstance(t, UnionType):
+        return normalize_type(t.__args__, fn)
+    elif origin is type:
+        return t
+    elif origin is typing.Union:
+        return normalize_type(t.__args__, fn)
+    elif origin is typing.Literal:
+        return Equals(*t.__args__)
+    elif origin and not getattr(t, "__args__", None):
+        return t
+    elif origin is not None:
+        raise TypeError(
+            f"ovld does not accept generic types except type, Union, Optional, Literal, but not: {t}"
+        )
+    elif isinstance(t, tuple):
+        return typing.Union[tuple(normalize_type(t2, fn) for t2 in t)]
+    elif isinstance(t, DependentType) and not t.bound:
+        raise UsageError(
+            f"Dependent type {t} has not been given a type bound. Please use Dependent[<bound>, {t}] instead."
+        )
+    else:
+        return t
+
+
+class MetaMC(type):
+    def __new__(T, name, order):
+        return super().__new__(T, name, (), {"order": order})
+
+    def __init__(cls, name, order):
+        pass
+
+    def __typeorder__(cls, other):
+        order = cls.order(other)
+        if isinstance(order, bool):
+            return NotImplemented
+        else:
+            return order
+
+    def __subclasscheck__(cls, sub):
+        result = cls.order(sub)
+        if isinstance(result, TypeRelationship):
+            return result.order in (Order.MORE, Order.SAME)
+        else:
+            return result
+
+
+def class_check(condition):
+    """Return a class with a subclassing relation defined by condition.
+
+    For example, a dataclass is a subclass of `class_check(dataclasses.is_dataclass)`,
+    and a class which name starts with "X" is a subclass of
+    `class_check(lambda cls: cls.__name__.startswith("X"))`.
+
+    Arguments:
+        condition: A function that takes a class as an argument and returns
+            True or False depending on whether it matches some condition.
+    """
+    return MetaMC(condition.__name__, condition)
+
+
+def parametrized_class_check(fn):
+    """Return a parametrized class checker.
+
+    In essence, parametrized_class_check(fn)[X] will call fn(cls, X) in order
+    to check whether cls matches the condition defined by fn and X.
+
+    Arguments:
+        fn: A function that takes a class and one or more additional arguments,
+            and returns True or False depending on whether the class matches.
+    """
+
+    class _C:
+        def __class_getitem__(_, arg):
+            if not isinstance(arg, tuple):
+                arg = (arg,)
+
+            def arg_to_str(x):
+                if isinstance(x, type):
+                    return x.__name__
+                else:
+                    return repr(x)
+
+            name = f"{fn.__name__}[{', '.join(map(arg_to_str, arg))}]"
+            return MetaMC(name, lambda sub: fn(sub, *arg))
+
+    _C.__name__ = fn.__name__
+    _C.__qualname__ = fn.__qualname__
+    return _C
+
+
+def _getcls(ref):
+    module, *parts = ref.split(".")
+    curr = __import__(module)
+    for part in parts:
+        curr = getattr(curr, part)
+    return curr
+
+
+class Deferred:
+    """Represent a class from an external module without importing it.
+
+    For instance, `Deferred["numpy.ndarray"]` matches instances of
+    numpy.ndarray, but it does not import numpy. When tested against a
+    class, if the first part of class's `__module__` is `numpy`, then
+    we do get the class and perform a normal issubclass check.
+
+    If the module is already loaded, `Deferred` returns the class directly.
+
+    Arguments:
+        ref: A string starting with a module name representing the path
+            to import a class.
+    """
+
+    def __class_getitem__(cls, ref):
+        module, _ = ref.split(".", 1)
+        if module in sys.modules:
+            return _getcls(ref)
+
+        def check(cls):
+            full_cls_mod = getattr(cls, "__module__", None)
+            cls_module = full_cls_mod.split(".", 1)[0] if full_cls_mod else None
+            if cls_module == module:
+                return issubclass(cls, _getcls(ref))
+            else:
+                return False
+
+        return MetaMC(f"Deferred[{ref}]", check)
+
+
+@parametrized_class_check
+def Exactly(cls, base_cls):
+    """Match the class but not its subclasses."""
+    return TypeRelationship(
+        order=Order.LESS if cls is base_cls else typeorder(base_cls, cls),
+        matches=cls is base_cls,
+    )
+
+
+@parametrized_class_check
+def StrictSubclass(cls, base_cls):
+    """Match subclasses but not the base class."""
+    return (
+        isinstance(cls, type)
+        and issubclass(cls, base_cls)
+        and cls is not base_cls
+    )
+
+
+@parametrized_class_check
+def Intersection(cls, *classes):
+    """Match all classes."""
+    matches = all(subclasscheck(cls, t) for t in classes)
+    compare = [x for t in classes if (x := typeorder(t, cls)) is not Order.NONE]
+    if not compare:
+        return TypeRelationship(Order.NONE, matches=matches)
+    elif any(x is Order.LESS or x is Order.SAME for x in compare):
+        return TypeRelationship(Order.LESS, matches=matches)
+    else:
+        return TypeRelationship(Order.MORE, matches=matches)
+
+
+@parametrized_class_check
+def HasMethod(cls, method_name):
+    """Match classes that have a specific method."""
+    return hasattr(cls, method_name)
+
+
+@runtime_checkable
+@dataclass
+class Dataclass(Protocol):
+    @classmethod
+    def __subclasshook__(cls, subclass):
+        return hasattr(subclass, "__dataclass_fields__") and hasattr(
+            subclass, "__dataclass_params__"
+        )
+
+
+__all__ = [
+    "Dataclass",
+    "Deferred",
+    "Exactly",
+    "HasMethod",
+    "Intersection",
+    "StrictSubclass",
+    "class_check",
+    "parametrized_class_check",
+]