colour.utilities.verbose Module¶
Verbose¶
Defines verbose related objects.
-
exception
colour.utilities.verbose.
ColourWarning
[source]¶ Bases:
exceptions.Warning
This is the base class of Colour warnings. It is a subclass of Warning.
-
colour.utilities.verbose.
message_box
(message, width=79, padding=3)[source]¶ Prints a message inside a box.
Parameters: - message (unicode) – Message to print.
- width (int, optional) – Message box width.
- padding (unicode) – Padding on each sides of the message.
Returns: Definition success.
Return type: Examples
>>> message = ('Lorem ipsum dolor sit amet, consectetur adipiscing elit, ' ... 'sed do eiusmod tempor incididunt ut labore et dolore magna ' ... 'aliqua.') >>> message_box(message, width=75) =========================================================================== * * * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do * * eiusmod tempor incididunt ut labore et dolore magna aliqua. * * * =========================================================================== True >>> message_box(message, width=60) ============================================================ * * * Lorem ipsum dolor sit amet, consectetur adipiscing * * elit, sed do eiusmod tempor incididunt ut labore et * * dolore magna aliqua. * * * ============================================================ True >>> message_box(message, width=75, padding=16) =========================================================================== * * * Lorem ipsum dolor sit amet, consectetur * * adipiscing elit, sed do eiusmod tempor * * incididunt ut labore et dolore magna * * aliqua. * * * =========================================================================== True
-
colour.utilities.verbose.
warning
(*args, **kwargs)[source]¶ Issues a warning.
Parameters: - *args (list, optional) – Arguments.
- **kwargs (dict, optional) – Keywords arguments.
Returns: Definition success.
Return type: Examples
>>> warning('This is a warning!') /Users/.../colour/utilities/verbose.py:132: UserWarning: This is a warning!
-
colour.utilities.verbose.
filter_warnings
(state=True, colour_warnings_only=True)[source]¶ 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: Examples
# Filtering Colour only warnings: >>> filter_warnings() True
# Filtering Colour and also Python warnings: >>> filter_warnings(colour_warnings_only=False) True