from __future__ import annotations
from typing import TYPE_CHECKING, Collection, Generic
from .structs import CT, KT, RT, RequirementInformation, State
if TYPE_CHECKING:
from .resolvers import Criterion
class BaseReporter(Generic[RT, CT, KT]):
"""Delegate class to provide progress reporting for the resolver."""
def starting(self) -> None:
"""Called before the resolution actually starts."""
def starting_round(self, index: int) -> None:
"""Called before each round of resolution starts.
The index is zero-based.
"""
def ending_round(self, index: int, state: State[RT, CT, KT]) -> None:
"""Called before each round of resolution ends.
This is NOT called if the resolution ends at this round. Use `ending`
if you want to report finalization. The index is zero-based.
"""
def ending(self, state: State[RT, CT, KT]) -> None:
"""Called before the resolution ends successfully."""
def adding_requirement(self, requirement: RT, parent: CT | None) -> None:
"""Called when adding a new requirement into the resolve criteria.
:param requirement: The additional requirement to be applied to filter
the available candidaites.
:param parent: The candidate that requires ``requirement`` as a
dependency, or None if ``requirement`` is one of the root
requirements passed in from ``Resolver.resolve()``.
"""
def resolving_conflicts(
self, causes: Collection[RequirementInformation[RT, CT]]
) -> None:
"""Called when starting to attempt requirement conflict resolution.
:param causes: The information on the collision that caused the backtracking.
"""
def rejecting_candidate(self, criterion: Criterion[RT, CT], candidate: CT) -> None:
"""Called when rejecting a candidate during backtracking."""
def pinning(self, candidate: CT) -> None:
"""Called when adding a candidate to the potential solution."""
|