colour.utilities.describe_environment#
- colour.utilities.describe_environment(runtime_packages: bool = True, development_packages: bool = False, extras_packages: bool = False, print_environment: bool = True, **kwargs: Any) defaultdict[source]#
Describe Colour running environment, i.e., interpreter, runtime and development packages.
- Parameters:
runtime_packages (bool) – Whether to return the runtime packages versions.
development_packages (bool) – Whether to return the development packages versions.
extras_packages (bool) – Whether to return the extras packages versions.
print_environment (bool) – Whether to print the environment.
padding – {
colour.utilities.message_box()}, Padding on each side of the message.print_callable – {
colour.utilities.message_box()}, Callable used to print the message box.width – {
colour.utilities.message_box()}, Message box width.kwargs (Any)
- Returns:
Environment.
- Return type:
Examples
>>> environment = describe_environment(width=75) =========================================================================== * * * Interpreter : * * python : 3.12.4 (main, Jun 6 2024, 18:26:44) [Clang 15.0.0 * * (clang-1500.3.9.4)] * * * * colour-science.org : * * colour : v0.4.3-282-gcb450ff50 * * * * Runtime : * * imageio : 2.35.1 * * matplotlib : 3.9.2 * * networkx : 3.3 * * numpy : 2.1.1 * * pandas : 2.2.3 * * pydot : 3.0.2 * * PyOpenColorIO : 2.3.2 * * scipy : 1.14.1 * * tqdm : 4.66.5 * * trimesh : 4.4.9 * * OpenImageIO : 2.5.14.0 * * xxhash : 3.5.0 * * * =========================================================================== >>> environment = describe_environment(True, True, True, width=75) ... =========================================================================== * * * Interpreter : * * python : 3.12.4 (main, Jun 6 2024, 18:26:44) [Clang 15.0.0 * * (clang-1500.3.9.4)] * * * * colour-science.org : * * colour : v0.4.3-282-gcb450ff50 * * * * Runtime : * * imageio : 2.35.1 * * matplotlib : 3.9.2 * * networkx : 3.3 * * numpy : 2.1.1 * * pandas : 2.2.3 * * pydot : 3.0.2 * * PyOpenColorIO : 2.3.2 * * scipy : 1.14.1 * * tqdm : 4.66.5 * * trimesh : 4.4.9 * * OpenImageIO : 2.5.14.0 * * xxhash : 3.5.0 * * * * Development : * * biblib-simple : 0.1.2 * * coverage : 6.5.0 * * coveralls : 4.0.1 * * invoke : 2.2.0 * * pre-commit : 3.8.0 * * pydata-sphinx-theme : 0.15.4 * * pyright : 1.1.382.post1 * * pytest : 8.3.3 * * pytest-cov : 5.0.0 * * restructuredtext-lint : 1.4.0 * * sphinxcontrib-bibtex : 2.6.3 * * toml : 0.10.2 * * twine : 5.1.1 * * * * Extras : * * ipywidgets : 8.1.5 * * notebook : 7.2.2 * * * ===========================================================================