Errors

exception confetti.errors.CONFETTIConfigurationError(message: str, config: Mapping[str, Any] | None = None, param: str | None = None, hint: str | None = None, source: str | None = None)

Bases: CONFETTIError

Error to raise when users input a configuration that is not compatible with CONFETTI’s design.

Parameters:

  • message (str) – Description of the configuration problem.

  • config (Mapping[str, Any] | None) – The configuration mapping that triggered the error, or a relevant subset.

  • param (str | None) – The specific configuration key that is invalid, if known.

  • hint (str | None) – Optional remediation advice that helps the user fix the issue, if known.

  • source (str | None) – Where the configuration came from.

exception confetti.errors.CONFETTIDataTypeError(message: str, config: Mapping[str, Any] | None = None, param: str | None = None, hint: str | None = None, source: str | None = None)

Bases: CONFETTIError

Error to raise when there is a data type mismatch in CONFETTI’s operations.

Parameters:

  • message (str) – Description of the configuration problem.

  • config (Mapping[str, Any] | None) – The configuration mapping that triggered the error, or a relevant subset.

  • param (str | None) – The specific configuration key that is invalid, if known.

  • hint (str | None) – Optional remediation advice that helps the user fix the issue, if known.

  • source (str | None) – Where the configuration came from.

exception confetti.errors.CONFETTIError(message: str, config: Mapping[str, Any] | None = None, param: str | None = None, hint: str | None = None, source: str | None = None)

Bases: Exception

Base class for all CONFETTI errors.

Parameters:

  • message (str) – Description of the configuration problem.

  • config (Mapping[str, Any] | None) – The configuration mapping that triggered the error, or a relevant subset.

  • param (str | None) – The specific configuration key that is invalid, if known.

  • hint (str | None) – Optional remediation advice that helps the user fix the issue, if known.

  • source (str | None) – Where the configuration came from.

config: Mapping[str, Any] | None
hint: str | None
message: str
param: str | None
source: str | None