gazu 0.10.16__tar.gz → 0.10.18__tar.gz

{gazu-0.10.16 → gazu-0.10.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazu
-Version: 0.10.16
+Version: 0.10.18
 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
@@ -28,6 +28,7 @@ License-File: LICENSE
 Requires-Dist: python-socketio[client]<6,>=5.11.0; python_version != "2.7"
 Requires-Dist: requests>=2.25.1
 Requires-Dist: Deprecated==1.2.14
+Requires-Dist: pywin32>=308; sys_platform == "win32" and python_version != "2.7"
 Provides-Extra: dev
 Requires-Dist: wheel; extra == "dev"
 Provides-Extra: test

gazu-0.10.18/gazu/__version__.py

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

{gazu-0.10.16 → gazu-0.10.18}/gazu/asset.py

@@ -166,7 +166,7 @@ def new_asset(
     project,
     asset_type,
     name,
-    description="",
+    description=None,
     extra_data={},
     episode=None,
     client=default,
@@ -189,7 +189,10 @@ def new_asset(
     asset_type = normalize_model_parameter(asset_type)
     episode = normalize_model_parameter(episode)
 
-    data = {"name": name, "description": description, "data": extra_data}
+    data = {"name": name, "data": extra_data}
+
+    if description is not None:
+        data["description"] = description
 
     if episode is not None:
         data["episode_id"] = episode["id"]
@@ -449,7 +452,7 @@ def all_asset_instances_for_asset(asset, client=default):
 
 
 def new_asset_asset_instance(
-    asset, asset_to_instantiate, description="", client=default
+    asset, asset_to_instantiate, description=None, client=default
 ):
     """
     Creates a new asset instance for given asset. The instance number is
@@ -465,10 +468,11 @@ def new_asset_asset_instance(
     """
     asset = normalize_model_parameter(asset)
     asset_to_instantiate = normalize_model_parameter(asset_to_instantiate)
-    data = {
-        "asset_to_instantiate_id": asset_to_instantiate["id"],
-        "description": description,
-    }
+    data = {"asset_to_instantiate_id": asset_to_instantiate["id"]}
+
+    if description is not None:
+        data["description"] = description
+
     return raw.post(
         "data/assets/%s/asset-asset-instances" % asset["id"],
         data,

{gazu-0.10.16 → gazu-0.10.18}/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.16 → gazu-0.10.18}/gazu/events.py

@@ -7,7 +7,25 @@ if sys.version_info[0] == 2:
 from .exception import AuthFailedException
 from .client import default_client, get_event_host
 from gazu.client import make_auth_header
+from engineio.base_client import signal_handler
 import socketio
+import os
+import inspect
+import signal
+import socketio
+
+if os.name == "nt":
+    from win32api import SetConsoleCtrlHandler
+
+    def WindowsSignalHandler(event):
+        if event == 0:
+            try:
+                signal_handler(signal.SIGINT, inspect.currentframe())
+            except:
+                # SetConsoleCtrlHandler handle cannot raise exceptions
+                pass
+
+    SetConsoleCtrlHandler(WindowsSignalHandler, 1)
 
 
 class EventsNamespace(socketio.ClientNamespace):

{gazu-0.10.16 → gazu-0.10.18}/gazu/scene.py

@@ -85,14 +85,18 @@ def update_scene(scene, client=default):
     return raw.put("data/entities/%s" % scene["id"], scene, client=client)
 
 
-def new_scene_asset_instance(scene, asset, description="", client=default):
+def new_scene_asset_instance(scene, asset, description=None, client=default):
     """
     Creates a new asset instance on given scene. The instance number is
     automatically generated (increment highest number).
     """
     scene = normalize_model_parameter(scene)
     asset = normalize_model_parameter(asset)
-    data = {"asset_id": asset["id"], "description": description}
+    data = {"asset_id": asset["id"]}
+
+    if description is not None:
+        data["description"] = description
+
     return raw.post(
         "data/scenes/%s/asset-instances" % scene["id"], data, client=client
     )

{gazu-0.10.16 → gazu-0.10.18}/gazu.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazu
-Version: 0.10.16
+Version: 0.10.18
 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
@@ -28,6 +28,7 @@ License-File: LICENSE
 Requires-Dist: python-socketio[client]<6,>=5.11.0; python_version != "2.7"
 Requires-Dist: requests>=2.25.1
 Requires-Dist: Deprecated==1.2.14
+Requires-Dist: pywin32>=308; sys_platform == "win32" and python_version != "2.7"
 Provides-Extra: dev
 Requires-Dist: wheel; extra == "dev"
 Provides-Extra: test

{gazu-0.10.16 → gazu-0.10.18}/gazu.egg-info/requires.txt

@@ -4,6 +4,9 @@ Deprecated==1.2.14
 [:python_version != "2.7"]
 python-socketio[client]<6,>=5.11.0
 
+[:sys_platform == "win32" and python_version != "2.7"]
+pywin32>=308
+
 [dev]
 wheel
 

{gazu-0.10.16 → gazu-0.10.18}/setup.cfg

@@ -33,6 +33,7 @@ install_requires =
 	python-socketio[client]>=5.11.0,<6; python_version != '2.7'
 	requests>=2.25.1
 	Deprecated==1.2.14
+	pywin32>=308; sys_platform == 'win32' and python_version != '2.7'
 
 [options.packages.find]
 include = gazu*

{gazu-0.10.16 → gazu-0.10.18}/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.16 → gazu-0.10.18}/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.16/gazu/__version__.py

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