Merge branch 'feature/v0.1.13' into develop

Author: KelSolaar

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203

.pre-commit-config.yaml

@@ -1,10 +1,26 @@
 repos:
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.7.8
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.32.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/ikamensh/flynt/
+    rev: '0.76'
+    hooks:
+    -   id: flynt
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+      language_version: python3.8
+-   repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
     hooks:
     -   id: flake8
-        exclude: examples
--   repo: https://github.com/pre-commit/mirrors-yapf
-    rev: v0.23.0
+-   repo: https://github.com/pycqa/pydocstyle
+    rev: 6.1.1
     hooks:
-    -   id: yapf
+    -   id: pydocstyle
+        args:
+        - --convention=numpy
+        - --add-ignore=D104,D200,D202,D205,D301,D400

CONTRIBUTORS.rst

@@ -4,7 +4,7 @@ Contributors
 Colour - Dash
 -------------
 
--   **Thomas Mansencal**, *Visual Effects Artist @ Weta Digital*
+-   **Thomas Mansencal**, *Lead Pipeline Developer @ WetaFX*
 
     Project coordination, writing.
 

README.rst

@@ -51,7 +51,6 @@ Contact & Social
 The *Colour Developers* can be reached via different means:
 
 - `Email <mailto:colour-developers@colour-science.org>`__
-- `Discourse <https://colour-science.discourse.group/>`__
 - `Facebook <https://www.facebook.com/python.colour.science>`__
 - `Gitter <https://gitter.im/colour-science/colour>`__
 - `Twitter <https://twitter.com/colour_science>`__

app.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 Application
 ===========
@@ -8,48 +7,42 @@
 import os
 from flask import Flask
 
-__author__ = 'Colour Developers'
-__copyright__ = 'Copyright (C) 2018-2021 - Colour Developers'
-__license__ = 'New BSD License - https://opensource.org/licenses/BSD-3-Clause'
-__maintainer__ = 'Colour Developers'
-__email__ = 'colour-developers@colour-science.org'
-__status__ = 'Production'
+__author__ = "Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
+__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
+__maintainer__ = "Colour Developers"
+__email__ = "colour-developers@colour-science.org"
+__status__ = "Production"
 
-__application_name__ = 'Colour - Dash'
+__application_name__ = "Colour - Dash"
 
-__major_version__ = '0'
-__minor_version__ = '1'
-__change_version__ = '12'
-__version__ = '.'.join(
-    (__major_version__,
-     __minor_version__,
-     __change_version__))  # yapf: disable
+__major_version__ = "0"
+__minor_version__ = "1"
+__change_version__ = "13"
+__version__ = ".".join(
+    (__major_version__, __minor_version__, __change_version__)
+)
 
-__all__ = ['SERVER', 'SERVER_URL', 'APP']
+__all__ = ["SERVER", "SERVER_URL", "APP"]
 
-SERVER = Flask(__name__)
+SERVER: Flask = Flask(__name__)
 """
 *Flask* server hosting the *Dash* app.
-
-SERVER : Flask
 """
 
-SERVER_URL = os.environ.get('COLOUR_DASH_SERVER')
+SERVER_URL: str = os.environ.get("COLOUR_DASH_SERVER")
 """
 Server url used to construct permanent links for the individual apps.
-
-SERVER_URL : unicode
 """
 
-APP = dash.Dash(
+APP: dash.Dash = dash.Dash(
     __application_name__,
-    external_scripts=os.environ.get('COLOUR_DASH_JS', '').split(','),
-    external_stylesheets=os.environ.get('COLOUR_DASH_CSS', '').split(','),
-    server=SERVER)
+    external_scripts=os.environ.get("COLOUR_DASH_JS", "").split(","),
+    external_stylesheets=os.environ.get("COLOUR_DASH_CSS", "").split(","),
+    server=SERVER,
+)
 """
 *Dash* app.
-
-APP : Dash
 """
 
-APP.config['suppress_callback_exceptions'] = True
+APP.config["suppress_callback_exceptions"] = True

apps/__init__.py

@@ -1 +0,0 @@
-# -*- coding: utf-8 -*-

apps/common.py

@@ -1,59 +1,57 @@
-# -*- coding: utf-8 -*-
 """
 Common
 ======
 """
 
 import colour
 
-__author__ = 'Colour Developers'
-__copyright__ = 'Copyright (C) 2018-2021 - Colour Developers'
-__license__ = 'New BSD License - https://opensource.org/licenses/BSD-3-Clause'
-__maintainer__ = 'Colour Developers'
-__email__ = 'colour-developers@colour-science.org'
-__status__ = 'Production'
+from colour.hints import ArrayLike, Dict, Integer, List
+
+__author__ = "Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
+__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
+__maintainer__ = "Colour Developers"
+__email__ = "colour-developers@colour-science.org"
+__status__ = "Production"
 
 __all__ = [
-    'RGB_COLOURSPACE_OPTIONS', 'CHROMATIC_ADAPTATION_TRANSFORM_OPTIONS',
-    'ILLUMINANTS_OPTIONS', 'NUKE_COLORMATRIX_NODE_TEMPLATE',
-    'nuke_format_matrix'
+    "RGB_COLOURSPACE_OPTIONS",
+    "CHROMATIC_ADAPTATION_TRANSFORM_OPTIONS",
+    "ILLUMINANTS_OPTIONS",
+    "NUKE_COLORMATRIX_NODE_TEMPLATE",
+    "nuke_format_matrix",
 ]
 
-RGB_COLOURSPACE_OPTIONS = [{
-    'label': key,
-    'value': key
-} for key in sorted(colour.RGB_COLOURSPACES.keys())
-                           if key not in ('aces', 'adobe1998', 'prophoto')]
+RGB_COLOURSPACE_OPTIONS: List[Dict] = [
+    {"label": key, "value": key}
+    for key in sorted(colour.RGB_COLOURSPACES.keys())
+    if key not in ("aces", "adobe1998", "prophoto")
+]
 """
 *RGB* colourspace options for a :class:`Dropdown` class instance.
-
-RGB_COLOURSPACE_OPTIONS : list
 """
 
-CHROMATIC_ADAPTATION_TRANSFORM_OPTIONS = [{
-    'label': key,
-    'value': key
-} for key in sorted(colour.CHROMATIC_ADAPTATION_TRANSFORMS.keys())]
+CHROMATIC_ADAPTATION_TRANSFORM_OPTIONS: List[Dict] = [
+    {"label": key, "value": key}
+    for key in sorted(colour.CHROMATIC_ADAPTATION_TRANSFORMS.keys())
+]
 """
 *Chromatic adaptation transform* options for a :class:`Dropdown` class
 instance.
-
-CHROMATIC_ADAPTATION_TRANSFORM_OPTIONS : list
 """
 
-ILLUMINANTS_OPTIONS = [{
-    'label': key,
-    'value': key
-} for key in sorted(colour.CCS_ILLUMINANTS[
-    'CIE 1931 2 Degree Standard Observer'].keys())]
+ILLUMINANTS_OPTIONS: List[Dict] = [
+    {"label": key, "value": key}
+    for key in sorted(
+        colour.CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"].keys()
+    )
+]
 """
 *CIE 1931 2 Degree Standard Observer* illuminant options for a
 :class:`Dropdown`class instance.
-
-ILLUMINANTS_OPTIONS : list
 """
 
-NUKE_COLORMATRIX_NODE_TEMPLATE = """
+NUKE_COLORMATRIX_NODE_TEMPLATE: str = """
 ColorMatrix {{
  inputs 0
  matrix {{
@@ -63,41 +61,41 @@
  selected true
  xpos 0
  ypos 0
-}}""" [1:]
+}}"""[
+    1:
+]
 """
 *The Foundry Nuke* *ColorMatrix* node template.
-
-NUKE_COLORMATRIX_NODE_TEMPLATE : unicode
 """
 
 
-def nuke_format_matrix(M, decimals=10):
+def nuke_format_matrix(M: ArrayLike, decimals: Integer = 10) -> str:
     """
-    Formats given matrix for usage in *The Foundry Nuke*, i.e. *TCL* code for
+    Format given matrix for usage in *The Foundry Nuke*, i.e. *TCL* code for
     a *ColorMatrix* node.
 
     Parameters
     ----------
-    M : array_like
+    M
         Matrix to format.
-    decimals : int, optional
+    decimals
         Decimals to use when formatting the matrix.
 
     Returns
     -------
-    unicode
+    :class:`str`
         *The Foundry Nuke* formatted matrix.
     """
 
-    def pretty(x):
+    def pretty(x: ArrayLike) -> str:
         """
         Prettify given number.
         """
 
-        return ' '.join(map('{{: 0.{0}f}}'.format(decimals).format, x))
+        return " ".join(map(f"{{: 0.{decimals}f}}".format, x))
 
-    tcl = '{{{0}}}\n'.format(pretty(M[0]))
-    tcl += '     {{{0}}}\n'.format(pretty(M[1]))
-    tcl += '     {{{0}}}'.format(pretty(M[2]))
+    tcl = f"{{{pretty(M[0])}}}\n"
+    tcl += f"     {{{pretty(M[1])}}}\n"
+    tcl += f"     {{{pretty(M[2])}}}"
 
     return tcl