Merge branch 'feature/v0.2.1' into develop

Author: KelSolaar

.github/workflows/continuous-integration-documentation.yml

@@ -7,8 +7,8 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [ubuntu-20.04]
-        python-version: [3.8]
+        os: [ubuntu-22.04]
+        python-version: [3.11]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -31,8 +31,7 @@ jobs:
         sudo apt-get --yes install latexmk texlive-full
     - name: Install Poetry
       run: |
-        curl -L https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py -o get-poetry.py
-        python get-poetry.py
+        curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
         echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       shell: bash
     - name: Install Package Dependencies

.github/workflows/continuous-integration-quality-unit-tests.yml

@@ -7,11 +7,8 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
     strategy:
       matrix:
-        os: [macOS-latest, ubuntu-20.04, windows-latest]
-        python-version: [3.8, 3.9, '3.10']
-        exclude:
-          - os: windows-latest
-            python-version: 3.8
+        os: [macOS-latest, ubuntu-22.04, windows-latest]
+        python-version: [3.9, '3.10', 3.11]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -26,6 +23,10 @@ jobs:
         echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
         echo "MPLBACKEND=AGG" >> $GITHUB_ENV
       shell: bash
+    - name: Set up Python 3.9 for Pre-Commit
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
@@ -37,28 +38,27 @@ jobs:
         brew install --cask adobe-dng-converter
       shell: bash
     - name: Install Dependencies (Ubuntu)
-      if: matrix.os == 'ubuntu-20.04'
+      if: matrix.os == 'ubuntu-22.04'
       run: |
         sudo apt-get update
         sudo apt-get --yes install dcraw exiftool
       shell: bash
     - name: Install Dependencies (Windows)
       if: matrix.os == 'windows-latest'
       run: |
-        curl -L https://exiftool.org/exiftool-12.40.zip -o exiftool-12.40.zip
-        unzip -d exiftool exiftool-12.40.zip
+        curl -L https://exiftool.org/exiftool-12.51.zip -o exiftool-12.51.zip
+        unzip -d exiftool exiftool-12.51.zip
         cp exiftool/exiftool\(-k\).exe exiftool/exiftool.exe
-        echo "$PWD/exiftool" >> $GITHUB_PATH
+        echo "$PWD/exiftool" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
         curl -L https://cdn.fastpictureviewer.com/bin/dcraw.zip?v=201605100 -o dcraw.zip
         unzip -d dcraw dcraw.zip
-        echo "$PWD/dcraw" >> $GITHUB_PATH
+        echo "$PWD/dcraw" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
       shell: bash
     - name: Install Adobe DNG Converter (Windows)
       if: matrix.os == 'windows-latest'
       run: |
         curl -L https://download.adobe.com/pub/adobe/dng/win/DNGConverter_11_4.exe -o DNGConverter_11_4.exe
         DNGConverter_11_4.exe /S
-        echo "C:\Program Files\Adobe\Adobe DNG Converter" >> $GITHUB_PATH
       shell: cmd
     - name: Add Adobe DNG Converter to %PATH% (Windows)
       if: matrix.os == 'windows-latest'
@@ -67,8 +67,7 @@ jobs:
       shell: bash
     - name: Install Poetry
       run: |
-        curl -L https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py -o get-poetry.py
-        python get-poetry.py --version 1.1.12
+        curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
         echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       shell: bash
     - name: Install Package Dependencies

.github/workflows/continuous-integration-static-type-checking.yml

@@ -8,20 +8,22 @@ jobs:
     strategy:
       matrix:
         os: [macOS-latest]
-        python-version: [3.9]
+        python-version: [3.11]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v1
     - name: Environment Variables
       run: |
-        echo "CI_PACKAGE=colour" >> $GITHUB_ENV
+        echo "CI_PACKAGE=colour_hdri" >> $GITHUB_ENV
       shell: bash
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Static Type Checking
+    - name: Install Package Dependencies
       run: |
         pip install -r requirements.txt
-        mypy --install-types --non-interactive --show-error-codes --warn-unused-ignores --warn-redundant-casts -p $CI_PACKAGE
+    - name: Static Type Checking
+      run: |
+        mypy --install-types --non-interactive --show-error-codes --warn-unused-ignores --warn-redundant-casts $CI_PACKAGE

.gitignore

@@ -1,12 +1,16 @@
+*.egg-info
 *.pyc
+*.pyo
 .DS_Store
 .coverage
 .dmypy.json
+.fleet
 .idea
-.ipynb_checkpoints/
+.ipynb_checkpoints
 .mypy_cache
-.vscode
 .sandbox
+.vs
+.vscode
 
 __pycache__
 

.pre-commit-config.yaml

@@ -1,20 +1,25 @@
 repos:
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.37.3
+    rev: v3.2.2
     hooks:
     -   id: pyupgrade
-        args: [--py38-plus]
+        args: [--py39-plus]
 -   repo: https://github.com/ikamensh/flynt/
-    rev: '0.76'
+    rev: '0.77'
     hooks:
     -   id: flynt
 -   repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.10.0
     hooks:
     - id: black
-      language_version: python3.8
+      language_version: python3.9
+-   repo: https://github.com/keewis/blackdoc
+    rev: v0.3.8
+    hooks:
+    - id: blackdoc
+      language_version: python3.9
 -   repo: https://github.com/PyCQA/flake8
-    rev: 5.0.3
+    rev: 6.0.0
     hooks:
     -   id: flake8
 -   repo: https://github.com/pycqa/pydocstyle

.readthedocs.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "3.11"
 
 sphinx:
    configuration: docs/conf.py

CONTRIBUTORS.rst

@@ -4,7 +4,7 @@ Contributors
 Development & Technical Support
 -------------------------------
 
--   **Thomas Mansencal**, *Lead Pipeline Developer @ WetaFX*
+-   **Thomas Mansencal**, *Technology Supervisor @ Wētā FX*
 
     Project coordination, overall development.
 

TODO.rst

@@ -6,17 +6,17 @@ TODO
 
 -   colour_hdri/__init__.py
 
-    -   Line 243 : # TODO: Remove legacy printing support when deemed appropriate.
+    -   Line 265 : # TODO: Remove legacy printing support when deemed appropriate.
 
 
 -   colour_hdri/tonemapping/global_operators/operators.py
 
-    -   Line 518 : # TODO: Implement automatic *p* and *non-uniform* computations support.
+    -   Line 593 : # TODO: Implement automatic *p* and *non-uniform* computations support.
 
 
 -   colour_hdri/utilities/exif.py
 
-    -   Line 314 : # TODO: Find a better name.
+    -   Line 319 : # TODO: Find a better name.
 
 
 -   colour_hdri/utilities/image.py

colour_hdri/__init__.py

@@ -228,19 +228,19 @@
     "tonemapping_operator_Tumblin1999",
 ]
 
-RESOURCES_DIRECTORY = os.path.join(os.path.dirname(__file__), "resources")
-EXAMPLES_RESOURCES_DIRECTORY = os.path.join(
-    RESOURCES_DIRECTORY, "colour-hdri-examples-datasets"
+ROOT_RESOURCES = os.path.join(os.path.dirname(__file__), "resources")
+ROOT_RESOURCES_EXAMPLES = os.path.join(
+    ROOT_RESOURCES, "colour-hdri-examples-datasets"
 )
-TESTS_RESOURCES_DIRECTORY = os.path.join(
-    RESOURCES_DIRECTORY, "colour-hdri-tests-datasets"
+ROOT_RESOURCES_TESTS = os.path.join(
+    ROOT_RESOURCES, "colour-hdri-tests-datasets"
 )
 
 __application_name__ = "Colour - HDRI"
 
 __major_version__ = "0"
 __minor_version__ = "2"
-__change_version__ = "0"
+__change_version__ = "1"
 __version__ = ".".join(
     (__major_version__, __minor_version__, __change_version__)
 )

colour_hdri/calibration/absolute_luminance.py

@@ -113,7 +113,8 @@ def upper_hemisphere_illuminance_weights_Lagarde2016(
     Examples
     --------
     >>> upper_hemisphere_illuminance_weights_Lagarde2016(  # doctest: +ELLIPSIS
-    ...    16, 1)
+    ...     16, 1
+    ... )
     array([[ 0...        ],
            [ 4.0143297...],
            [ 7.3345454...],
@@ -174,7 +175,8 @@ def absolute_luminance_calibration_Lagarde2016(
     --------
     >>> RGB = np.ones((4, 8, 3))
     >>> absolute_luminance_calibration_Lagarde2016(  # doctest: +ELLIPSIS
-    ...     RGB, 500)
+    ...     RGB, 500
+    ... )
     array([[[ 233.9912506...,  233.9912506...,  233.9912506...],
             [ 233.9912506...,  233.9912506...,  233.9912506...],
             [ 233.9912506...,  233.9912506...,  233.9912506...],