Merge branch 'feature/pyright' into develop

Author: KelSolaar

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,11 +15,11 @@ is available to guide the process: https://www.colour-science.org/contributing/.
 **Code Style and Quality**
 
 - [ ] Unit tests have been implemented and passed.
-- [ ] Mypy static checking has been run and passed.
+- [ ] Pyright static checking has been run and passed.
 - [ ] Pre-commit hooks have been run and passed.
 
 <!-- The unit tests can be invoked with `poetry run invoke tests` -->
-<!-- Mypy can be started with `dmypy run -- --show-error-codes --warn-unused-ignores --warn-redundant-casts --install-types --non-interactive -p colour-datasets` -->
+<!-- Pyright can be started with `pyright --skipunannotated` -->
 
 **Documentation**
 

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

@@ -26,4 +26,4 @@ jobs:
         pip install -r requirements.txt
     - name: Static Type Checking
       run: |
-        mypy --install-types --non-interactive --show-error-codes --warn-unused-ignores --warn-redundant-casts $CI_PACKAGE
+        pyright --skipunannotated

.gitignore

@@ -3,11 +3,9 @@
 *.pyo
 .DS_Store
 .coverage
-.dmypy.json
 .fleet
 .idea
 .ipynb_checkpoints
-.mypy_cache
 .sandbox
 .vs
 .vscode

colour_datasets/__init__.py

@@ -70,7 +70,7 @@
 except Exception:
     _version = __version__
 
-colour.utilities.ANCILLARY_COLOUR_SCIENCE_PACKAGES[
+colour.utilities.ANCILLARY_COLOUR_SCIENCE_PACKAGES[  # pyright: ignore
     "colour-datasets"
 ] = _version
 

colour_datasets/loaders/__init__.py

@@ -2,7 +2,7 @@
 
 import sys
 
-from colour.hints import Any, Boolean, Integer, Union
+from colour.hints import Any, Union
 from colour.utilities import CanonicalMapping, warning
 
 from colour_datasets.records import datasets
@@ -124,7 +124,7 @@
 
 del _module, _export
 
-_HAS_TITLE_KEYS: Boolean = False
+_HAS_TITLE_KEYS: bool = False
 """
 Whether the :attr:`colour_datasets.loaders.DATASET_LOADERS` attribute has
 been updated with dataset titles. This variable is used in the one time
@@ -133,7 +133,7 @@
 """
 
 
-def load(dataset: Union[Integer, str]) -> Any:
+def load(dataset: Union[int, str]) -> Any:
     """
     Load given dataset: The dataset is pulled locally, i.e. synced if required
     and then its data is loaded.

colour_datasets/loaders/asano2015.py

@@ -26,7 +26,7 @@
     XYZ_ColourMatchingFunctions,
     LMS_ConeFundamentals,
 )
-from colour.hints import Boolean, Dict, NDArray, Optional, Tuple
+from colour.hints import Dict, NDArrayFloat, Optional
 from colour.utilities import as_float_array, tstack
 
 from colour_datasets.loaders import AbstractDatasetLoader
@@ -82,7 +82,7 @@ def __new__(
         XYZ_10: XYZ_ColourMatchingFunctions,
         LMS_2: LMS_ConeFundamentals,
         LMS_10: LMS_ConeFundamentals,
-        parameters: NDArray,
+        parameters: NDArrayFloat,
         others: Optional[Dict] = None,
     ):
         """
@@ -217,7 +217,7 @@ def load(self) -> Dict[str, Specification_Asano2015]:
 
     @staticmethod
     def parse_workbook_Asano2015(
-        workbook: str, template: str, observers: Tuple = (1, 10)
+        workbook: str, template: str, observers: tuple = (1, 10)
     ) -> Dict[str, Dict]:
         """
         Parse given *Asano (2015)* *Observer Function Database* workbook.
@@ -317,7 +317,7 @@ def parse_workbook_Asano2015(
 """
 
 
-def build_Asano2015(load: Boolean = True) -> DatasetLoader_Asano2015:
+def build_Asano2015(load: bool = True) -> DatasetLoader_Asano2015:
     """
     Singleton factory that the builds *Asano (2015)*
     *Observer Function Database* dataset loader.

colour_datasets/loaders/brendel2020.py

@@ -21,7 +21,7 @@
 import os
 
 from colour import LinearInterpolator, SpectralShape, SpectralDistribution
-from colour.hints import Boolean, Dict, Optional
+from colour.hints import Dict, Optional
 from colour.utilities import as_int
 
 from colour_datasets.loaders import AbstractDatasetLoader
@@ -115,7 +115,7 @@ def load(self) -> Dict[str, SpectralDistribution]:
 """
 
 
-def build_Brendel2020(load: Boolean = True) -> DatasetLoader_Brendel2020:
+def build_Brendel2020(load: bool = True) -> DatasetLoader_Brendel2020:
     """
     Singleton factory that builds the *Brendel (2020)*
     *Measured Commercial LED Spectra* dataset loader.

colour_datasets/loaders/dyer2017.py

@@ -24,9 +24,7 @@
 from colour.continuous import MultiSignals, Signal
 from colour.hints import (
     Any,
-    Boolean,
     Dict,
-    Floating,
     Literal,
     Optional,
     Type,
@@ -569,8 +567,8 @@ def __init__(
         transmission_geometry: Optional[
             Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"]
         ] = None,
-        bandwidth_FWHM: Optional[Floating] = None,
-        bandwidth_corrected: Optional[Boolean] = None,
+        bandwidth_FWHM: Optional[float] = None,
+        bandwidth_corrected: Optional[bool] = None,
     ) -> None:
         super().__init__()
 
@@ -616,9 +614,9 @@ def __init__(
             Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"]
         ] = None
         self.transmission_geometry = transmission_geometry
-        self._bandwidth_FWHM: Optional[Floating] = None
+        self._bandwidth_FWHM: Optional[float] = None
         self.bandwidth_FWHM = bandwidth_FWHM
-        self._bandwidth_corrected: Optional[Boolean] = None
+        self._bandwidth_corrected: Optional[bool] = None
         self.bandwidth_corrected = bandwidth_corrected
 
     @property
@@ -847,7 +845,7 @@ def transmission_geometry(
         self._transmission_geometry = value
 
     @property
-    def bandwidth_FWHM(self) -> Optional[Floating]:
+    def bandwidth_FWHM(self) -> Optional[float]:
         """
         Getter and setter property for the full-width half-maximum bandwidth.
 
@@ -865,7 +863,7 @@ def bandwidth_FWHM(self) -> Optional[Floating]:
         return self._bandwidth_FWHM
 
     @bandwidth_FWHM.setter
-    def bandwidth_FWHM(self, value: Optional[Floating]):
+    def bandwidth_FWHM(self, value: Optional[float]):
         """Setter for the **self.bandwidth_FWHM** property."""
 
         if value is not None:
@@ -877,7 +875,7 @@ def bandwidth_FWHM(self, value: Optional[Floating]):
         self._bandwidth_FWHM = value
 
     @property
-    def bandwidth_corrected(self) -> Optional[Boolean]:
+    def bandwidth_corrected(self) -> Optional[bool]:
         """
         Getter and setter property for whether bandwidth correction has been
         applied to the measured data.
@@ -896,7 +894,7 @@ def bandwidth_corrected(self) -> Optional[Boolean]:
         return self._bandwidth_corrected
 
     @bandwidth_corrected.setter
-    def bandwidth_corrected(self, value: Optional[Boolean]):
+    def bandwidth_corrected(self, value: Optional[bool]):
         """Setter for the **self.bandwidth_corrected** property."""
 
         if value is not None:
@@ -1077,8 +1075,8 @@ def __init__(
         transmission_geometry: Optional[
             Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"]
         ] = None,
-        bandwidth_FWHM: Optional[Floating] = None,
-        bandwidth_corrected: Optional[Boolean] = None,
+        bandwidth_FWHM: Optional[float] = None,
+        bandwidth_corrected: Optional[bool] = None,
     ) -> None:
         super().__init__()
 
@@ -1124,9 +1122,9 @@ def __init__(
             Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"]
         ] = None
         self.transmission_geometry = transmission_geometry
-        self._bandwidth_FWHM: Optional[Floating] = None
+        self._bandwidth_FWHM: Optional[float] = None
         self.bandwidth_FWHM = bandwidth_FWHM
-        self._bandwidth_corrected: Optional[Boolean] = None
+        self._bandwidth_corrected: Optional[bool] = None
         self.bandwidth_corrected = bandwidth_corrected
 
     @property
@@ -1355,7 +1353,7 @@ def transmission_geometry(
         self._transmission_geometry = value
 
     @property
-    def bandwidth_FWHM(self) -> Optional[Floating]:
+    def bandwidth_FWHM(self) -> Optional[float]:
         """
         Getter and setter property for the full-width half-maximum bandwidth.
 
@@ -1373,7 +1371,7 @@ def bandwidth_FWHM(self) -> Optional[Floating]:
         return self._bandwidth_FWHM
 
     @bandwidth_FWHM.setter
-    def bandwidth_FWHM(self, value: Optional[Floating]):
+    def bandwidth_FWHM(self, value: Optional[float]):
         """Setter for the **self.bandwidth_FWHM** property."""
 
         if value is not None:
@@ -1385,7 +1383,7 @@ def bandwidth_FWHM(self, value: Optional[Floating]):
         self._bandwidth_FWHM = value
 
     @property
-    def bandwidth_corrected(self) -> Optional[Boolean]:
+    def bandwidth_corrected(self) -> Optional[bool]:
         """
         Getter and setter property for whether bandwidth correction has been
         applied to the measured data.
@@ -1404,7 +1402,7 @@ def bandwidth_corrected(self) -> Optional[Boolean]:
         return self._bandwidth_corrected
 
     @bandwidth_corrected.setter
-    def bandwidth_corrected(self, value: Optional[Boolean]):
+    def bandwidth_corrected(self, value: Optional[bool]):
         """Setter for the **self.bandwidth_corrected** property."""
 
         if value is not None:
@@ -1566,7 +1564,7 @@ def load(
 """
 
 
-def build_Dyer2017(load: Boolean = True) -> DatasetLoader_Dyer2017:
+def build_Dyer2017(load: bool = True) -> DatasetLoader_Dyer2017:
     """
     Singleton factory that builds the *Dyer et al. (2017)*
     *RAW to ACES Utility Data* dataset loader.

colour_datasets/loaders/ebner1998.py

@@ -23,7 +23,7 @@
 import os
 from collections import namedtuple
 
-from colour.hints import Boolean, Dict, Integer, NDArray, Optional
+from colour.hints import Dict, NDArrayFloat, Optional
 from colour.utilities import as_float_array
 
 from colour_datasets.loaders import AbstractDatasetLoader
@@ -98,7 +98,7 @@ def __init__(self) -> None:
 
     def load(
         self,
-    ) -> Dict[str, Dict[Integer, ConstantPerceivedHueColourMatches_Ebner1998]]:
+    ) -> Dict[str, Dict[int, ConstantPerceivedHueColourMatches_Ebner1998]]:
         """
         Sync, parse, convert and return the *Ebner and Fairchild (1998)*
         *Constant Perceived-Hue Data* dataset content.
@@ -128,7 +128,7 @@ def load(
             self.record.repository, "dataset", "Ebner_Constant_Hue_Data.txt"
         )
 
-        def _parse_float_values(data: str) -> NDArray:
+        def _parse_float_values(data: str) -> NDArrayFloat:
             """Parse float values from given data."""
 
             values = np.reshape(
@@ -173,7 +173,7 @@ def _parse_float_values(data: str) -> NDArray:
 """
 
 
-def build_Ebner1998(load: Boolean = True) -> DatasetLoader_Ebner1998:
+def build_Ebner1998(load: bool = True) -> DatasetLoader_Ebner1998:
     """
     Singleton factory that builds the *Ebner and Fairchild (1998)*
     *Constant Perceived-Hue Data* dataset loader.

colour_datasets/loaders/hung1995.py

@@ -23,7 +23,7 @@
 from collections import namedtuple
 
 from colour import CCS_ILLUMINANTS, xy_to_XYZ, xyY_to_XYZ
-from colour.hints import Boolean, Dict, Optional
+from colour.hints import Dict, Optional
 
 from colour_datasets.loaders import AbstractDatasetLoader
 from colour_datasets.records import datasets
@@ -216,7 +216,7 @@ def load(
 """
 
 
-def build_Hung1995(load: Boolean = True) -> DatasetLoader_Hung1995:
+def build_Hung1995(load: bool = True) -> DatasetLoader_Hung1995:
     """
     Singleton factory that builds the *Hung and Berns (1995)*
     *Constant Hue Loci Data* dataset loader.