BatchBuildResult#

class scikitplot.cython.BatchBuildResult(successes, failures, committed, policy)[source]#

Structured result of a batch compile/import (CYTHON-BATCH-001).

cython_import_all was fail-fast: a mid-batch failure left earlier compiled artifacts and imported modules committed but returned no report of what had already succeeded. This type makes the partial outcome explicit: ordered successes, ordered failures, and the list of side effects that were committed before the batch stopped (or completed).

Parameters:
successesMapping[str, BuildResult]

Ordered mapping of batch key → BuildResult for each item that built and imported successfully.

failuresSequence[BatchFailure]

Ordered failures (empty when every item succeeded).

committedSequence[str]

Ordered batch keys whose native side effects (compiled artifact + imported module) were committed. Equal to list(successes); provided explicitly so callers can reason about what to roll back or resume.

policystr

The batch policy that produced this result: "fail_fast" (stop at the first failure) or "collect" (attempt every item).

Parameters:

Notes

  • ok is True only when there were no failures.

  • resume_token is the sorted tuple of keys still to attempt after a fail-fast stop; feed it back via the only argument to resume.

committed: Sequence[str][source]#
failures: Sequence[BatchFailure][source]#
property n_failed: int#

Number of items that failed.

property n_succeeded: int#

Number of items that built and imported successfully.

property ok: bool#

Whether the batch completed with no failures.

policy: str[source]#
successes: Mapping[str, BuildResult][source]#