Merge branch 'feature/v0.4.4' into develop

colour-science · Sep 14, 2023 · 878ae03 · 878ae03
2 parents 1fdf3b3 + e3152a3
commit 878ae03
Show file tree

Hide file tree

Showing 16 changed files with 42 additions and 40 deletions.
diff --git a/README.rst b/README.rst
@@ -28,13 +28,13 @@
 .. end-badges
 
 `Colour <https://github.com/colour-science/colour>`__ is an open-source
-`Python <https://www.python.org/>`__ package providing a comprehensive number
+`Python <https://www.python.org>`__ package providing a comprehensive number
 of algorithms and datasets for colour science.
 
 It is freely available under the
 `BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
 
-**Colour** is an affiliated project of `NumFOCUS <https://numfocus.org/>`__, a
+**Colour** is an affiliated project of `NumFOCUS <https://numfocus.org>`__, a
 501(c)(3) nonprofit in the United States.
 
 .. contents:: **Table of Contents**
@@ -1688,18 +1688,18 @@ Installation
 ~~~~~~~~~~~~
 
 **Colour** and its primary dependencies can be easily installed from the
-`Python Package Index <https://pypi.org/project/colour-science/>`__
+`Python Package Index <https://pypi.org/project/colour-science>`__
 by issuing this command in a shell:
 
 .. code-block:: bash
 
     $ pip install --user colour-science
 
 The detailed installation procedure for the secondary dependencies is
-described in the `Installation Guide <https://www.colour-science.org/installation-guide/>`__.
+described in the `Installation Guide <https://www.colour-science.org/installation-guide>`__.
 
 **Colour** is also available for `Anaconda <https://www.continuum.io/downloads>`__
-from *Continuum Analytics* via `conda-forge <https://conda-forge.org/>`__:
+from *Continuum Analytics* via `conda-forge <https://conda-forge.org>`__:
 
 .. code-block:: bash
 
@@ -1723,7 +1723,7 @@ Contributing
 ~~~~~~~~~~~~
 
 If you would like to contribute to **Colour**, please refer to the following
-`Contributing <https://www.colour-science.org/contributing/>`__ guide.
+`Contributing <https://www.colour-science.org/contributing>`__ guide.
 
 Changes
 ~~~~~~~
@@ -1733,7 +1733,7 @@ The changes are viewable on the `Releases <https://github.com/colour-science/col
 Bibliography
 ~~~~~~~~~~~~
 
-The bibliography is available on the `Bibliography <https://www.colour-science.org/bibliography/>`__ page.
+The bibliography is available on the `Bibliography <https://www.colour-science.org/bibliography>`__ page.
 
 It is also viewable directly from the repository in
 `BibTeX <https://github.com/colour-science/colour/blob/develop/BIBLIOGRAPHY.bib>`__
@@ -1756,12 +1756,12 @@ Software
 **Python**
 
 - `ColorPy <http://markkness.net/colorpy/ColorPy.html>`__ by Kness, M.
-- `Colorspacious <https://colorspacious.readthedocs.io/>`__ by Smith, N. J., et al.
-- `python-colormath <https://python-colormath.readthedocs.io/>`__ by Taylor, G., et al.
+- `Colorspacious <https://colorspacious.readthedocs.io>`__ by Smith, N. J., et al.
+- `python-colormath <https://python-colormath.readthedocs.io>`__ by Taylor, G., et al.
 
 **Go**
 
-- `go-colorful <https://github.com/lucasb-eyer/go-colorful/>`__  by Beyer, L., et al.
+- `go-colorful <https://github.com/lucasb-eyer/go-colorful>`__  by Beyer, L., et al.
 
 **.NET**
 
@@ -1774,14 +1774,14 @@ Software
 **Matlab & Octave**
 
 - `COLORLAB <https://www.uv.es/vista/vistavalencia/software/colorlab.html>`__ by Malo, J., et al.
-- `Psychtoolbox <http://psychtoolbox.org/>`__ by Brainard, D., et al.
+- `Psychtoolbox <http://psychtoolbox.org>`__ by Brainard, D., et al.
 - `The Munsell and Kubelka-Munk Toolbox <http://www.munsellcolourscienceforpainters.com/MunsellAndKubelkaMunkToolbox/MunsellAndKubelkaMunkToolbox.html>`__ by Centore, P.
 
 Code of Conduct
 ---------------
 
 The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
-is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct/>`__ page.
+is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.
 
 .. begin-trim-long-description
 

diff --git a/SPONSORS.rst b/SPONSORS.rst
@@ -4,7 +4,7 @@
 
 `Colour <https://github.com/colour-science/colour>`__ is an independent
 `BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ Open Source
-affiliated project of `NumFOCUS <https://numfocus.org/>`__, a 501(c)(3)
+affiliated project of `NumFOCUS <https://numfocus.org>`__, a 501(c)(3)
 nonprofit in the United States.
 
 We are grateful 💖 for the support of our

diff --git a/colour/__init__.py b/colour/__init__.py
@@ -3,14 +3,14 @@
 ======
 
 `Colour <https://github.com/colour-science/colour>`__ is an open-source
-`Python <https://www.python.org/>`__ package providing a comprehensive number
+`Python <https://www.python.org>`__ package providing a comprehensive number
 of algorithms and datasets for colour science.
 
 It is freely available under the
 `BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
 
 `Colour <https://github.com/colour-science/colour>`__ is an affiliated project
-of `NumFOCUS <https://numfocus.org/>`__, a 501(c)(3) nonprofit in the United
+of `NumFOCUS <https://numfocus.org>`__, a 501(c)(3) nonprofit in the United
 States.
 
 Sub-packages

diff --git a/colour/characterisation/aces_it.py b/colour/characterisation/aces_it.py
@@ -1104,7 +1104,7 @@ def matrix_idt(
     array([ 2.3414154...,  1.        ,  1.5163375...])
 
     The *RAW to ACES* v1 matrix for the same camera and optimized by
-    `Ceres Solver <http://ceres-solver.org/>`__ is as follows::
+    `Ceres Solver <http://ceres-solver.org>`__ is as follows::
 
         0.864994 -0.026302 0.161308
         0.056527 1.122997 -0.179524

diff --git a/colour/characterisation/tests/test_aces_it.py b/colour/characterisation/tests/test_aces_it.py
@@ -988,7 +988,7 @@ def test_matrix_idt(self):
         """
 
         # The *RAW to ACES* v1 matrix for the same camera and optimized by
-        # `Ceres Solver <http://ceres-solver.org/>`__ is as follows:
+        # `Ceres Solver <http://ceres-solver.org>`__ is as follows:
         #
         # 0.864994 -0.026302 0.161308
         # 0.056527 1.122997 -0.179524
@@ -1007,7 +1007,7 @@ def test_matrix_idt(self):
         )
 
         # The *RAW to ACES* v1 matrix for the same camera and optimized by
-        # `Ceres Solver <http://ceres-solver.org/>`__ is as follows:
+        # `Ceres Solver <http://ceres-solver.org>`__ is as follows:
         #
         # 0.888492 -0.077505 0.189014
         # 0.021805 1.066614 -0.088418

diff --git a/colour/graph/conversion.py b/colour/graph/conversion.py
@@ -1220,7 +1220,7 @@ def convert(a: Any, source: str, target: str, **kwargs: Any) -> Any:
     colour representation using the automatic colour conversion graph.
 
     The conversion is performed by finding the shortest path in a
-    `NetworkX <https://networkx.github.io/>`__ :class:`DiGraph` class instance.
+    `NetworkX <https://networkx.github.io>`__ :class:`DiGraph` class instance.
 
     The conversion path adopts the **'1'** domain-range scale and the object
     :math:`a` is expected to be *soft* normalised accordingly. For example,

diff --git a/colour/hints/__init__.py b/colour/hints/__init__.py
@@ -16,6 +16,7 @@
 from typing import (  # noqa: UP035
     Any,
     Callable,
+    ClassVar,
     Dict,
     List,
     Literal,
@@ -50,6 +51,7 @@
     "ModuleType",
     "Any",
     "Callable",
+    "ClassVar",
     "Dict",
     "Generator",
     "Iterable",

diff --git a/colour/plotting/graph.py b/colour/plotting/graph.py
@@ -39,7 +39,7 @@ def plot_automatic_colour_conversion_graph(
 ) -> AGraph:  # pyright: ignore  # noqa: F821
     """
     Plot *Colour* automatic colour conversion graph using
-    `Graphviz <https://www.graphviz.org/>`__ and
+    `Graphviz <https://www.graphviz.org>`__ and
     `pyraphviz <https://pygraphviz.github.io>`__.
 
     Parameters

diff --git a/docs/advanced.rst b/docs/advanced.rst
@@ -60,13 +60,13 @@ Using Colour without Scipy
 --------------------------
 
 With the release of `Colour 0.3.8 <https://github.com/colour-science/colour/releases/tag/v0.3.8>`__,
-`SciPy <http://www.scipy.org/>`__ became a requirement.
+`SciPy <http://www.scipy.org>`__ became a requirement.
 
 **Scipy** is notoriously hard to compile, especially
-`on Windows <https://colour-science.slack.com/messages/C02KH93GT/>`__.
+`on Windows <https://colour-science.slack.com/messages/C02KH93GT>`__.
 Some Digital Content Creation (DCC) applications are shipping Python interpreters
 compiled with versions of
-`Visual Studio <https://visualstudio.microsoft.com/>`__ such as 2011 or 2015.
+`Visual Studio <https://visualstudio.microsoft.com>`__ such as 2011 or 2015.
 Those are incompatible with the Python Wheels commonly built with
 `Visual Studio 2008 (Python 2.7) or Visual Studio 2017 (Python 3.6) <https://devguide.python.org/setup/?highlight=windows#windows>`__.
 

diff --git a/docs/basics.rst b/docs/basics.rst
@@ -10,7 +10,7 @@ Object Name Categorisation
 The API tries to bundle the objects by categories by naming them with common
 prefixes which makes introspection and auto-completion easier.
 
-For example, in `IPython <https://ipython.org/>`__ or `Jupyter Notebook <https://jupyter.org/>`__,
+For example, in `IPython <https://ipython.org>`__ or `Jupyter Notebook <https://jupyter.org>`__,
 most of the definitions pertaining to the spectral distribution handling can
 be found as follows:
 
@@ -47,7 +47,7 @@ Similarly, all the RGB colourspaces can be individually accessed from the
 Abbreviations
 -------------
 
-The following abbreviations are in use in `Colour <https://github.com/colour-science/Colour/>`__:
+The following abbreviations are in use in `Colour <https://github.com/colour-science/Colour>`__:
 
 - **CAM** : Colour Appearance Model
 - **CCS** : Chromaticity Coordinates
@@ -69,7 +69,7 @@ N-Dimensional Array Support
 ---------------------------
 
 Most of **Colour** definitions are fully vectorised and support n-dimensional
-array by leveraging `Numpy <http://www.numpy.org/>`__.
+array by leveraging `Numpy <http://www.numpy.org>`__.
 
 While it is recommended to use
 `ndarray <https://docs.scipy.org/doc/numpy-1.13.0/reference/arrays.ndarray.html>`__
@@ -171,7 +171,7 @@ to support floating point wavelengths. Wavelengths should not have to be
 defined as integer values and it is effectively common to get data from
 instruments whose domain is returned as floating point values.
 
-For example, the data from an `Ocean Insight (Optics) STS-VIS <https://www.oceaninsight.com/products/spectrometers/microspectrometer/sts-series/sts-vis/>`__
+For example, the data from an `Ocean Insight (Optics) STS-VIS <https://www.oceaninsight.com/products/spectrometers/microspectrometer/sts-series/sts-vis>`__
 spectrometer is typically saved with 3 digits decimal precision:
 
 .. code-block:: text

diff --git a/docs/colour.hints.rst b/docs/colour.hints.rst
@@ -13,6 +13,7 @@ Annotation Type Hints
     ModuleType
     Any
     Callable
+    ClassVar
     Dict
     Generator
     Iterable

diff --git a/docs/conf.py b/docs/conf.py
@@ -6,9 +6,9 @@
 import os
 import re
 import setuptools.archive_util
+import sys
 import urllib.parse
 import urllib.request
-import sys
 from pathlib import Path
 
 sys.path.append(str(Path(__file__).parent.parent))

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,13 @@
 |
 
 `Colour <https://github.com/colour-science/colour>`__ is an open-source
-`Python <https://www.python.org/>`__ package providing a comprehensive number
+`Python <https://www.python.org>`__ package providing a comprehensive number
 of algorithms and datasets for colour science.
 
 It is freely available under the
 `BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
 
-**Colour** is an affiliated project of `NumFOCUS <https://numfocus.org/>`__, a
+**Colour** is an affiliated project of `NumFOCUS <https://numfocus.org>`__, a
 501(c)(3) nonprofit in the United States.
 
 .. sectnum::
@@ -1487,12 +1487,12 @@ Software
 **Python**
 
 - `ColorPy <http://markkness.net/colorpy/ColorPy.html>`__ by Kness, M.
-- `Colorspacious <https://colorspacious.readthedocs.io/>`__ by Smith, N. J., et al.
-- `python-colormath <https://python-colormath.readthedocs.io/>`__ by Taylor, G., et al.
+- `Colorspacious <https://colorspacious.readthedocs.io>`__ by Smith, N. J., et al.
+- `python-colormath <https://python-colormath.readthedocs.io>`__ by Taylor, G., et al.
 
 **Go**
 
-- `go-colorful <https://github.com/lucasb-eyer/go-colorful/>`__  by Beyer, L., et al.
+- `go-colorful <https://github.com/lucasb-eyer/go-colorful>`__  by Beyer, L., et al.
 
 **.NET**
 
@@ -1505,14 +1505,14 @@ Software
 **Matlab & Octave**
 
 - `COLORLAB <https://www.uv.es/vista/vistavalencia/software/colorlab.html>`__ by Malo, J., et al.
-- `Psychtoolbox <http://psychtoolbox.org/>`__ by Brainard, D., et al.
+- `Psychtoolbox <http://psychtoolbox.org>`__ by Brainard, D., et al.
 - `The Munsell and Kubelka-Munk Toolbox <http://www.munsellcolourscienceforpainters.com/MunsellAndKubelkaMunkToolbox/MunsellAndKubelkaMunkToolbox.html>`__ by Centore, P.
 
 Code of Conduct
 ---------------
 
 The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
-is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct/>`__ page.
+is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.
 
 Contact & Social
 ----------------

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -6,7 +6,7 @@ Tutorial
     An interactive version of the tutorial is available via
     `Google Colab <https://colab.research.google.com/notebook#fileId=1Im9J7or9qyClQCv5sPHmKdyiQbG4898K&offline=true&sandboxMode=true>`__.
 
-`Colour <https://github.com/colour-science/Colour/>`__ spreads over
+`Colour <https://github.com/colour-science/Colour>`__ spreads over
 various domains of Colour Science, from colour models to optical
 phenomena, this tutorial does not give a complete overview of the
 API but is a good introduction to the main concepts.

diff --git a/pyproject.toml b/pyproject.toml
@@ -218,7 +218,6 @@ convention = "numpy"
 [tool.ruff.per-file-ignores]
 "colour/examples/*" = ["INP", "T201", "T203"]
 "docs/*" = ["INP"]
-"setup.py" = ["INP"]
 "tasks.py" = ["INP"]
 "utilities/*" = ["EXE001", "INP"]
 "utilities/unicode_to_ascii.py" = ["RUF001"]

diff --git a/tasks.py b/tasks.py
@@ -334,15 +334,15 @@ def requirements(ctx: Context):
     ctx.run(
         "poetry export -f requirements.txt "
         "--without-hashes "
-        "--with dev,optional,graphviz,meshing,docs "
+        "--with dev,docs,graphviz,meshing,optional "
         "--output requirements.txt"
     )
 
     message_box('Exporting "docs/requirements.txt" file...')
     ctx.run(
         "poetry export -f requirements.txt "
         "--without-hashes "
-        "--with optional,graphviz,meshing,docs "
+        "--with docs,graphviz,meshing,optional "
         "--output docs/requirements.txt"
     )
 
@@ -437,7 +437,7 @@ def tag(ctx: Context):
     message_box("Tagging...")
     result = ctx.run("git rev-parse --abbrev-ref HEAD", hide="both")
 
-    if result.stdout.strip() == "develop":  # pyright: ignore
+    if result.stdout.strip() != "develop":  # pyright: ignore
         raise RuntimeError("Are you still on a feature or master branch?")
 
     with open(os.path.join(PYTHON_PACKAGE_NAME, "__init__.py")) as file_handle: