48 lines
1.5 KiB
Python
48 lines
1.5 KiB
Python
from __future__ import annotations
|
|
|
|
import collections
|
|
from typing import TYPE_CHECKING, Any, Generic, Iterable, NamedTuple
|
|
|
|
from ..structs import CT, KT, RT, DirectedGraph
|
|
|
|
if TYPE_CHECKING:
|
|
from ..providers import AbstractProvider
|
|
from ..reporters import BaseReporter
|
|
from .criterion import Criterion
|
|
|
|
class Result(NamedTuple, Generic[RT, CT, KT]):
|
|
mapping: dict[KT, CT]
|
|
graph: DirectedGraph[KT | None]
|
|
criteria: dict[KT, Criterion[RT, CT]]
|
|
|
|
else:
|
|
Result = collections.namedtuple("Result", ["mapping", "graph", "criteria"])
|
|
|
|
|
|
class AbstractResolver(Generic[RT, CT, KT]):
|
|
"""The thing that performs the actual resolution work."""
|
|
|
|
base_exception = Exception
|
|
|
|
def __init__(
|
|
self,
|
|
provider: AbstractProvider[RT, CT, KT],
|
|
reporter: BaseReporter[RT, CT, KT],
|
|
) -> None:
|
|
self.provider = provider
|
|
self.reporter = reporter
|
|
|
|
def resolve(self, requirements: Iterable[RT], **kwargs: Any) -> Result[RT, CT, KT]:
|
|
"""Take a collection of constraints, spit out the resolution result.
|
|
|
|
This returns a representation of the final resolution state, with one
|
|
guarenteed attribute ``mapping`` that contains resolved candidates as
|
|
values. The keys are their respective identifiers.
|
|
|
|
:param requirements: A collection of constraints.
|
|
:param kwargs: Additional keyword arguments that subclasses may accept.
|
|
|
|
:raises: ``self.base_exception`` or its subclass.
|
|
"""
|
|
raise NotImplementedError
|