PR: Implement support for injecting vaab/colour objects into our namespace.

[KelSolaar]

Summary

This PR injects vaab/colour objects into our namespace to address #1221, #958 and vaab/colour#62.

This is really gross but it will help users so...

from colour import Color, web2rgb

print(Color, web2rgb)

/Users/kelsolaar/Library/Caches/pypoetry/virtualenvs/colour-science-49B8_mty-py3.11/bin/python /Users/kelsolaar/Applications/PyCharm Professional Edition.app/Contents/plugins/python/helpers/pydev/pydevconsole.py --mode=client --host=127.0.0.1 --port=56376 
import sys; print('Python %s on %s' % (sys.version, sys.platform))
sys.path.extend(['/Users/kelsolaar/Documents/Development/colour-science/colour'])
Python 3.11.6 (main, Oct  2 2023, 20:46:14) [Clang 14.0.3 (clang-1403.0.22.14.1)]
Type 'copyright', 'credits' or 'license' for more information
IPython 8.16.1 -- An enhanced Interactive Python. Type '?' for help.
PyDev console: using IPython 8.16.1
Python 3.11.6 (main, Oct  2 2023, 20:46:14) [Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
runfile('/Users/kelsolaar/Library/Application Support/JetBrains/PyCharm2023.2/scratches/scratch_127.py', wdir='/Users/kelsolaar/Library/Application Support/JetBrains/PyCharm2023.2/scratches')
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "COLOR_NAME_TO_RGB" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "C_HEX" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "C_HSL" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "C_RGB" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "Color" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "HEX" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "HSL" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "HSL_equivalence" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "LONG_HEX_COLOR" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "RGB" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "RGB_TO_COLOR_NAMES" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "RGB_color_picker" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "RGB_equivalence" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "SHORT_HEX_COLOR" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "color_scale" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hash_or_str" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hex2hsl" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hex2rgb" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hex2web" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hsl2hex" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hsl2rgb" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "hsl2web" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "make_color_factory" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "rgb2hex" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "rgb2hsl" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "rgb2web" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "web2hex" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "web2hsl" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
/Users/kelsolaar/Documents/Development/colour-science/colour/colour/utilities/verbose.py:265: ColourWarning: Injecting "vaab/colour" "web2rgb" object into "Colour"'s namespace!
  warn(*args, **kwargs)  # noqa: B028
<class '__vaab_colour__.Color'> <function <lambda> at 0x16f085da0>

Preflight

Code Style and Quality

• [N/A] Unit tests have been implemented and passed.
• Pyright static checking has been run and passed.
• Pre-commit hooks have been run and passed.
• [N/A] New transformations have been added to the Automatic Colour Conversion Graph.
• [N/A] New transformations have been exported to the relevant namespaces, e.g. colour, colour.models.

Documentation

• New features are documented along with examples if relevant.
• The documentation is Sphinx and numpydoc compliant.

[coveralls]

coverage: 99.733% (-0.03%) from 99.763%
when pulling 6e828f6 on feature/vaab_colour
into c1dd25a on develop.

[KelSolaar]

After discussion with @tjdcs, we are going for an opt-in behaviour, default is to warn if vaab/colour is detected, proposing to set the COLOUR_SCIENCE__COLOUR__IMPORT_VAAB_COLOUR variable to import its objects into our namespace.