colour.utilities.filter_warnings

colour.utilities.filter_warnings(state=True, colour_warnings_only=True)

Filters Colour and also optionally overall Python warnings.

Parameters:

• state (bool, optional) – Warnings filter state.
• colour_warnings_only (bool, optional) – Whether to only filter Colour warnings or also overall Python warnings.

Returns:

Definition success.

Return type:

bool

Examples

# Filtering Colour only warnings: >>> filter_warnings() True

# Filtering Colour and also Python warnings: >>> filter_warnings(colour_warnings_only=False) True