require#

scikitplot.cleanprompt.require(tier)[source]#

Return the report for tier, raising when it is not usable.

Parameters:

tierstr

Tier name; one of the keys of TIERS.

Returns:

CapabilityReport

The report, guaranteed to be AVAILABLE.

Raises:

CapabilityError

If the tier is not usable. The message names the tier’s purpose, the observed status, and the exact install command.

Parameters:

tier (str)

Return type:

CapabilityReport

Notes

Developer notes. Call this before importing the tier’s dependency, not after. An actionable message placed below a module-scope third-party import is unreachable, because the import raises first.