Source code for nlp_shap.runtime.progress

"""Optional synchronous progress callbacks for coalition execution."""

from typing import Protocol




class CoalitionProgress(Protocol):
    """Sync hooks notified as coalition jobs are planned and finished."""



    def on_coalitions_planned(self, total: int) -> None:
        """Report the number of coalition jobs about to be scheduled."""




    def on_coalition_finished(self, done: int, total: int) -> None:
        """Report that ``done`` of ``total`` coalition jobs have finished."""






class NullCoalitionProgress:
    """No-op progress sink used when callers omit a progress callback."""



    def on_coalitions_planned(self, total: int) -> None:
        """Ignore planned coalition count."""
        _ = total




    def on_coalition_finished(self, done: int, total: int) -> None:
        """Ignore finished coalition count."""
        _ = done
        _ = total