colour.utilities.optional#

colour.utilities.optional(value: T | None, default: T) T[source]#

Handle optional argument value by providing a default value.

Parameters:
  • value (T | None) – Optional argument value.

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

Returns:

Argument value.

Return type:

T

Examples

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