Merge branch 'feature/v0.2.4' into develop

Author: KelSolaar

TODO.rst

@@ -4,7 +4,36 @@ Colour - Datasets - TODO
 TODO
 ----
 
+-   colour_datasets/__init__.py
 
+    -   Line 78 : # TODO: Remove legacy printing support when deemed appropriate.
+
+
+-   colour_datasets/records/zenodo.py
+
+    -   Line 451 : # TODO: Remove the following space escaping: The new Zenodo API is not quoting filenames properly thus we are temporarily escaping spaces for now. https://github.com/colour-science/colour-datasets/issues/ 36issuecomment-1773464695
+
+
+-   colour_datasets/utilities/common.py
+
+    -   Line 42 : # TODO: Use *colour* definition.
+
+
+-   colour_datasets/loaders/kuopio.py
+
+    -   Line 310 : # TODO: Implement support for *Natural Colors*: https://sandbox.zenodo.org/record/315640 http://www.uef.fi/web/spectral/natural-colors
+
+
+-   colour_datasets/loaders/xrite2016.py
+
+    -   Line 109 : # TODO: Implement support for "CGATS" file format in "Colour": https://github.com/colour-science/colour/issues/354
+
+
+-   colour_datasets/loaders/dyer2017.py
+
+    -   Line 141 : # TODO: Re-instate "manufacturer", "model", "illuminant" and "type" attributes according to outcome of https://github.com/ampas/rawtoaces/issues/114. Those attributes are currently stored in "self._kwargs".
+    -   Line 928 : # TODO: Re-instate "manufacturer", "model", "illuminant" and "type" attributes according to outcome of https://github.com/ampas/rawtoaces/issues/114.
+    -   Line 1430 : # TODO: Re-instate "manufacturer", "model", "illuminant" and "type" attributes according to outcome of https://github.com/ampas/rawtoaces/issues/114.
 
 About
 -----

colour_datasets/loaders/asano2015.py

@@ -342,3 +342,9 @@ def build_Asano2015(load: bool = True) -> DatasetLoader_Asano2015:
             _DATASET_LOADER_ASANO2015.load()
 
     return _DATASET_LOADER_ASANO2015
+
+
+if __name__ == "__main__":
+    import colour_datasets
+
+    colour_datasets.load("3252742")

colour_datasets/records/tests/test_zenodo.py

@@ -159,10 +159,10 @@ def test__str__(self):
 -----
 
 - camlist&equipment.txt : https://zenodo.org/api/records/3245883/files/\
-camlist&equipment.txt
+camlist&equipment.txt/content
 - camspec_database.txt : https://zenodo.org/api/records/3245883/files/\
-camspec_database.txt
-- urls.txt : https://zenodo.org/api/records/3245883/files/urls.txt"""
+camspec_database.txt/content
+- urls.txt : https://zenodo.org/api/records/3245883/files/urls.txt/content"""
             )[1:],
         )
 

colour_datasets/records/zenodo.py

@@ -13,6 +13,7 @@
 
 import json
 import os
+import re
 import shutil
 import stat
 import tempfile
@@ -204,8 +205,8 @@ def strip_html(text: str) -> str:
 
         files = "\n".join(
             [
-                f"- {file_data['filename']} : {file_data['links']['self']}"
-                for file_data in sorted(files, key=lambda x: x["filename"])
+                f'- {file_data["key"]} : {file_data["links"]["self"]}'
+                for file_data in sorted(files, key=lambda x: x["key"])
             ]
         )
 
@@ -388,31 +389,29 @@ def pull(self, use_urls_txt_file: bool = True, retries: int = 3):
         # given by the content of :attr:`URLS_TXT_FILE` attribute file.
         urls_txt = None
         for file_data in self.data["files"]:
-            if file_data["filename"] == self._configuration.urls_txt_file:
+            if file_data["key"] == self._configuration.urls_txt_file:
                 urls_txt = file_data
                 break
 
-        def urls_download(urls: Dict, is_content_url=False):
+        def urls_download(urls: Dict) -> None:
             """Download given urls."""
 
             for url, md5 in urls.items():
+                filename = re.sub("/content$", "", url)
                 filename = os.path.join(
                     downloads_directory,
                     urllib.parse.unquote(  # pyright: ignore
-                        url.split("/")[-1]
+                        filename.split("/")[-1]
                     ),
                 )
-                url = (  # noqa: PLW2901
-                    f"{url}/content" if is_content_url else url
-                )
                 url_download(url, filename, md5.split(":")[-1], retries)
 
         try:
             if use_urls_txt_file and urls_txt:
                 urls = {}
                 urls_txt_file = tempfile.NamedTemporaryFile(delete=False).name
                 url_download(
-                    urls_txt["links"]["download"],
+                    urls_txt["links"]["self"],
                     urls_txt_file,
                     urls_txt["checksum"].split(":")[-1],
                     retries,
@@ -445,7 +444,7 @@ def urls_download(urls: Dict, is_content_url=False):
 
             urls = {}
             for file_data in self.data["files"]:
-                if file_data["filename"] == self._configuration.urls_txt_file:
+                if file_data["key"] == self._configuration.urls_txt_file:
                     continue
 
                 # TODO: Remove the following space escaping: The new Zenodo API
@@ -457,7 +456,7 @@ def urls_download(urls: Dict, is_content_url=False):
 
                 urls[url] = file_data["checksum"].split(":")[-1]
 
-            urls_download(urls, is_content_url=True)
+            urls_download(urls)
 
         deflate_directory = os.path.join(
             self.repository, self._configuration.deflate_directory

colour_datasets/utilities/common.py

@@ -39,6 +39,7 @@
 ]
 
 
+# TODO: Use *colour* definition.
 class suppress_stdout:
     """A context manager and decorator temporarily suppressing standard output."""
 

pyproject.toml

@@ -62,7 +62,7 @@ coveralls = "*"
 flynt = "*"
 invoke = "*"
 jupyter = "*"
-pre-commit = "*"
+pre-commit = ">= 3.5"
 pyright = "*"
 pytest = "*"
 pytest-cov = "*"

utilities/export_todo.py

@@ -123,6 +123,6 @@ def export_todo_items(todo_items: dict, file_path: str):
     os.chdir(os.path.dirname(__file__))
 
     export_todo_items(
-        extract_todo_items(os.path.join("..", "colour_checker_detection")),
+        extract_todo_items(os.path.join("..", "colour_datasets")),
         os.path.join("..", "TODO.rst"),
     )