colour.utilities.optional

colour.utilities.optional(value: Optional[colour.utilities.common.T], default: colour.utilities.common.T) → colour.utilities.common.T[source]

Handle optional argument value by providing a default value.

Parameters

  • value (Optional[colour.utilities.common.T]) – Optional argument value.

  • default (colour.utilities.common.T) – Default argument value if value is None.

Returns

Argument value.

Return type

T

Examples

>>> optional('Foo', 'Bar')
'Foo'
>>> optional(None, 'Bar')
'Bar'

previous

colour.utilities.validate_method

next

colour.utilities.MixinDataclassFields