gazu 0.10.15__tar.gz → 0.10.17__tar.gz

{gazu-0.10.15 → gazu-0.10.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazu
-Version: 0.10.15
+Version: 0.10.17
 Summary: Gazu is a client for Zou, the API to store the data of your CG production.
 Home-page: https://gazu.cg-wire.com/
 Author: CG Wire
@@ -36,8 +36,8 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: requests_mock; extra == "test"
 Provides-Extra: lint
 Requires-Dist: autoflake==2.3.1; python_version >= "3.8" and extra == "lint"
-Requires-Dist: black==24.8.0; python_version >= "3.8" and extra == "lint"
-Requires-Dist: pre-commit==3.8.0; python_version >= "3.9" and extra == "lint"
+Requires-Dist: black==24.10.0; python_version >= "3.9" and extra == "lint"
+Requires-Dist: pre-commit==4.0.1; python_version >= "3.9" and extra == "lint"
 
 .. figure:: https://zou.cg-wire.com/kitsu.png
    :alt: Kitsu Logo

gazu-0.10.17/gazu/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.10.17"

{gazu-0.10.15 → gazu-0.10.17}/gazu/casting.py

@@ -60,7 +60,10 @@ def update_episode_casting(project, episode, casting, client=default):
     """
     episode = normalize_model_parameter(episode)
     project = normalize_model_parameter(project)
-    path = "data/projects/%s/entities/%s/casting" % (project["id"], episode["id"])
+    path = "data/projects/%s/entities/%s/casting" % (
+        project["id"],
+        episode["id"],
+    )
     return raw.put(path, casting, client=client)
 
 

{gazu-0.10.15 → gazu-0.10.17}/gazu/client.py

@@ -303,6 +303,32 @@ def delete(path, params=None, client=default_client):
     return response.text
 
 
+def get_message_from_response(
+    response, default_message="No additional information"
+):
+    """
+    A utility function that handles Zou's inconsistent message keys.
+    For a given request, checks if any error messages or regular messages were given and returns their value.
+    If no messages are found, returns a default message.
+
+    Args:
+        response: requests.Request - A response to check.
+        default_message: str - An optional default value to revert to if no message is detected.
+
+    Returns:
+        The message of a given response, or a default message - if any.
+    """
+    message = default_message
+    message_json = response.json()
+
+    for key in ["error", "message"]:
+        if message_json.get(key):
+            message = message_json[key]
+            break
+
+    return message
+
+
 def check_status(request, path, client=None):
     """
     Raise an exception related to status code, if the status code does not
@@ -329,8 +355,7 @@ def check_status(request, path, client=None):
     elif status_code == 403:
         raise NotAllowedException(path)
     elif status_code == 400:
-        text = request.json().get("message", "No additional information")
-        raise ParameterException(path, text)
+        raise ParameterException(path, get_message_from_response(request))
     elif status_code == 405:
         raise MethodNotAllowedException(path)
     elif status_code == 413:
@@ -359,14 +384,15 @@ def check_status(request, path, client=None):
             raise
     elif status_code in [500, 502]:
         try:
+            print("A server error occured!\n")
             stacktrace = request.json().get(
                 "stacktrace", "No stacktrace sent by the server"
             )
-            message = request.json().get(
-                "message", "No message sent by the server"
-            )
-            print("A server error occured!\n")
             print("Server stacktrace:\n%s" % stacktrace)
+            message = get_message_from_response(
+                response=request,
+                default_message="No message sent by the server",
+            )
             print("Error message:\n%s\n" % message)
         except Exception:
             print(request.text)
@@ -474,8 +500,11 @@ def upload(path, file_path, data={}, extra_files=[], client=default_client):
     except JSONDecodeError:
         print(response.text)
         raise
-    if "message" in result:
-        raise UploadFailedException(result["message"])
+
+    result_message = get_message_from_response(response, default_message="")
+    if result_message:
+        raise UploadFailedException(result_message)
+
     return result
 
 

{gazu-0.10.15 → gazu-0.10.17}/gazu/playlist.py

@@ -166,16 +166,12 @@ def get_entity_preview_files(entity, client=default):
     entity = normalize_model_parameter(entity)
     return raw.get(
         "data/playlists/entities/%s/preview-files" % entity["id"],
-        client=client
+        client=client,
     )
 
 
 def add_entity_to_playlist(
-    playlist,
-    entity,
-    preview_file=None,
-    persist=True,
-    client=default
+    playlist, entity, preview_file=None, persist=True, client=default
 ):
     """
     Add an entity to the playlist, use the last uploaded preview as revision
@@ -197,25 +193,23 @@ def add_entity_to_playlist(
         for task_type_id in preview_files.keys():
             task_type_files = preview_files[task_type_id]
             first_file = task_type_files[0]
-            if preview_file is None or \
-               preview_file["created_at"] < first_file["created_at"]:
+            if (
+                preview_file is None
+                or preview_file["created_at"] < first_file["created_at"]
+            ):
                 preview_file = first_file
 
     preview_file = normalize_model_parameter(preview_file)
-    playlist["shots"].append({
-        "entity_id": entity["id"],
-        "preview_file_id": preview_file["id"]
-    })
+    playlist["shots"].append(
+        {"entity_id": entity["id"], "preview_file_id": preview_file["id"]}
+    )
     if persist:
         update_playlist(playlist, client=client)
     return playlist
 
 
 def remove_entity_from_playlist(
-    playlist,
-    entity,
-    persist=True,
-    client=default
+    playlist, entity, persist=True, client=default
 ):
     """
     Remove all occurences of a given entity from a playlist.
@@ -239,11 +233,7 @@ def remove_entity_from_playlist(
 
 
 def update_entity_preview(
-    playlist,
-    entity,
-    preview_file,
-    persist=True,
-    client=default
+    playlist, entity, preview_file, persist=True, client=default
 ):
     """
     Remove all occurences of a given entity from a playlist.

{gazu-0.10.15 → gazu-0.10.17}/gazu/task.py

@@ -257,12 +257,7 @@ def all_tasks_for_task_status(project, task_type, task_status, client=default):
 
 
 @cache
-def all_tasks_for_task_type(
-    project,
-    task_type,
-    episode=None,
-    client=default
-):
+def all_tasks_for_task_type(project, task_type, episode=None, client=default):
     """
     Args:
         project (str / dict): The project dict or the project ID.
@@ -532,18 +527,6 @@ def get_task_status_by_name(name, client=default):
     return raw.fetch_first("task-status", {"name": name}, client=client)
 
 
-@cache
-def get_default_task_status(client=default):
-    """
-    Args:
-        name (str / dict): The name of claimed task status.
-
-    Returns:
-        dict: Task status matching given name.
-    """
-    return raw.fetch_first("task-status", {"is_default": True}, client=client)
-
-
 @cache
 def get_task_status_by_short_name(task_status_short_name, client=default):
     """
@@ -661,7 +644,7 @@ def new_task(
     entity = normalize_model_parameter(entity)
     task_type = normalize_model_parameter(task_type)
     if task_status is None:
-        task_status = get_default_task_status()
+        task_status = get_default_task_status(client=client)
 
     data = {
         "project_id": entity["project_id"],
@@ -1267,10 +1250,7 @@ def get_task_url(task, client=default):
 
 
 def all_tasks_for_project(
-    project,
-    task_type=None,
-    episode=None,
-    client=default
+    project, task_type=None, episode=None, client=default
 ):
     """
     Args:

{gazu-0.10.15 → gazu-0.10.17}/gazu.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazu
-Version: 0.10.15
+Version: 0.10.17
 Summary: Gazu is a client for Zou, the API to store the data of your CG production.
 Home-page: https://gazu.cg-wire.com/
 Author: CG Wire
@@ -36,8 +36,8 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: requests_mock; extra == "test"
 Provides-Extra: lint
 Requires-Dist: autoflake==2.3.1; python_version >= "3.8" and extra == "lint"
-Requires-Dist: black==24.8.0; python_version >= "3.8" and extra == "lint"
-Requires-Dist: pre-commit==3.8.0; python_version >= "3.9" and extra == "lint"
+Requires-Dist: black==24.10.0; python_version >= "3.9" and extra == "lint"
+Requires-Dist: pre-commit==4.0.1; python_version >= "3.9" and extra == "lint"
 
 .. figure:: https://zou.cg-wire.com/kitsu.png
    :alt: Kitsu Logo

{gazu-0.10.15 → gazu-0.10.17}/gazu.egg-info/requires.txt

@@ -11,10 +11,10 @@ wheel
 
 [lint:python_version >= "3.8"]
 autoflake==2.3.1
-black==24.8.0
 
 [lint:python_version >= "3.9"]
-pre-commit==3.8.0
+black==24.10.0
+pre-commit==4.0.1
 
 [test]
 pytest

{gazu-0.10.15 → gazu-0.10.17}/setup.cfg

@@ -46,8 +46,8 @@ test =
 	requests_mock
 lint = 
 	autoflake==2.3.1; python_version >= '3.8'
-	black==24.8.0; python_version >= '3.8'
-	pre-commit==3.8.0; python_version >= '3.9'
+	black==24.10.0; python_version >= '3.9'
+	pre-commit==4.0.1; python_version >= '3.9'
 
 [bdist_wheel]
 universal = 1

{gazu-0.10.15 → gazu-0.10.17}/tests/test_casting.py

@@ -47,7 +47,9 @@ class CastingTestCase(unittest.TestCase):
             mock.put(gazu.client.get_full_url(path), text=json.dumps(casting))
             episode = {"id": fakeid("episode-01")}
             project = {"id": fakeid("project-01")}
-            casting = gazu.casting.update_episode_casting(project, episode, casting)
+            casting = gazu.casting.update_episode_casting(
+                project, episode, casting
+            )
             self.assertEqual(casting[0]["asset_id"], fakeid("asset-1"))
 
     def test_get_asset_type_casting(self):

{gazu-0.10.15 → gazu-0.10.17}/tests/test_client.py

@@ -1,5 +1,7 @@
 import datetime
 import json
+import random
+import string
 
 import unittest
 import requests_mock
@@ -281,20 +283,36 @@ class BaseFuncTestCase(ClientTestCase):
                     "./tests/fixtures/v1.png",
                     data={"test": True},
                 )
+
+            error_value = "".join(
+                [
+                    random.choice(
+                        string.ascii_uppercase + string.ascii_lowercase
+                    )
+                    for _ in range(10)
+                ]
+            )
+
             with requests_mock.Mocker() as mock:
-                mock_route(
-                    mock,
-                    "POST",
-                    "data/new-file",
-                    text={"message": "Error"},
-                )
-                with self.assertRaises(gazu.client.UploadFailedException):
-                    raw.upload(
+                for field in ["message", "error"]:
+                    mock_route(
+                        mock,
+                        "POST",
                         "data/new-file",
-                        "./tests/fixtures/v1.png",
-                        data={"test": True},
+                        text={field: error_value},
                     )
 
+                    with self.assertRaises(
+                        gazu.client.UploadFailedException
+                    ) as context:
+                        raw.upload(
+                            "data/new-file",
+                            "./tests/fixtures/v1.png",
+                            data={"test": True},
+                        )
+
+                    self.assertTrue(str(context.exception) == error_value)
+
     def test_upload_multiple_files(self):
         with open("./tests/fixtures/v1.png", "rb") as test_file:
             with requests_mock.Mocker() as mock:

{gazu-0.10.15 → gazu-0.10.17}/tests/test_files.py

@@ -39,6 +39,26 @@ class FilesTestCase(unittest.TestCase):
             )
             self.assertEqual(working_file["id"], 1)
 
+            mock.post(
+                gazu.client.get_full_url(path),
+                text=json.dumps(
+                    {"error": "The given working file already exists."}
+                ),
+                status_code=400,
+            )
+
+            with self.assertRaises(gazu.client.ParameterException) as context:
+                gazu.files.new_working_file(
+                    task,
+                    person={"id": "person-01"},
+                    software={"id": "software-1"},
+                )
+
+                self.assertTrue(
+                    str(context.exception)
+                    == "The given working file already exists."
+                )
+
     def test_new_entity_output_file(self):
         entity = {"id": "asset-01"}
         output_type = {"id": "output-type-01"}

{gazu-0.10.15 → gazu-0.10.17}/tests/test_playlist.py

@@ -179,7 +179,8 @@ class TaskTestCase(unittest.TestCase):
             )
             mock.get(
                 gazu.client.get_full_url(
-                    "data/playlists/entities/%s/preview-files" % fakeid("shot-1")
+                    "data/playlists/entities/%s/preview-files"
+                    % fakeid("shot-1")
                 ),
                 text=json.dumps(
                     {fakeid("task-type-1"): [{"id": fakeid("preview-1")}]}
@@ -188,26 +189,33 @@ class TaskTestCase(unittest.TestCase):
             playlist = {
                 "id": fakeid("playlist-1"),
                 "name": "name_changed",
-                "shots": []
-            }
-            shot = {
-                "id": fakeid("shot-1"),
-                "name": "SH01"
+                "shots": [],
             }
+            shot = {"id": fakeid("shot-1"), "name": "SH01"}
             playlist = gazu.playlist.add_entity_to_playlist(playlist, shot)
             self.assertEqual(playlist["id"], fakeid("playlist-1"))
-            self.assertEqual(playlist["shots"], [{
-                "entity_id": fakeid("shot-1"),
-                "preview_file_id": fakeid("preview-1")
-            }])
+            self.assertEqual(
+                playlist["shots"],
+                [
+                    {
+                        "entity_id": fakeid("shot-1"),
+                        "preview_file_id": fakeid("preview-1"),
+                    }
+                ],
+            )
             playlist = gazu.playlist.update_entity_preview(
-                playlist,
-                shot,
-                fakeid("preview-2")
-            )
-            self.assertEqual(playlist["shots"], [{
-                "entity_id": fakeid("shot-1"),
-                "preview_file_id": fakeid("preview-2")
-            }])
-            playlist = gazu.playlist.remove_entity_from_playlist(playlist, shot)
+                playlist, shot, fakeid("preview-2")
+            )
+            self.assertEqual(
+                playlist["shots"],
+                [
+                    {
+                        "entity_id": fakeid("shot-1"),
+                        "preview_file_id": fakeid("preview-2"),
+                    }
+                ],
+            )
+            playlist = gazu.playlist.remove_entity_from_playlist(
+                playlist, shot
+            )
             self.assertEqual(playlist["shots"], [])

gazu-0.10.15/gazu/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.10.15"