gazu 0.10.14__py2.py3-none-any.whl → 0.10.16__py2.py3-none-any.whl

gazu/__version__.py

@@ -1 +1 @@
-__version__ = "0.10.14"
+__version__ = "0.10.16"

gazu/casting.py

@@ -45,6 +45,28 @@ def update_asset_casting(project, asset, casting, client=default):
     return raw.put(path, casting, client=client)
 
 
+def update_episode_casting(project, episode, casting, client=default):
+    """
+    Change casting of given episode with given casting (list of asset ids displayed
+    into the episode).
+
+    Args:
+        episode (str / dict): The episode dict or the episode ID.
+        casting (dict): The casting description.
+        Ex: `casting = [{"asset_id": "asset-1", "nb_occurences": 3}]`
+
+    Returns:
+        dict: Related episode.
+    """
+    episode = normalize_model_parameter(episode)
+    project = normalize_model_parameter(project)
+    path = "data/projects/%s/entities/%s/casting" % (
+        project["id"],
+        episode["id"],
+    )
+    return raw.put(path, casting, client=client)
+
+
 def get_asset_type_casting(project, asset_type, client=default):
     """
     Return casting for given asset_type.
@@ -117,6 +139,23 @@ def get_asset_casting(asset, client=default):
     return raw.get(path, client=client)
 
 
+def get_episode_casting(episode, client=default):
+    """
+    Return casting for given episode.
+    `[{"episode_id": "episode-1", "nb_occurences": 3}]}`
+    Args:
+        episode (dict): The episode dict
+
+    Returns:
+        dict: Casting for given episode.
+    """
+    path = "/data/projects/%s/entities/%s/casting" % (
+        episode["project_id"],
+        episode["id"],
+    )
+    return raw.get(path, client=client)
+
+
 def get_asset_cast_in(asset, client=default):
     """
     Return entity list where given asset is casted.

gazu/exception.py

@@ -75,3 +75,15 @@ class TaskMustBeADictException(Exception):
     """
     Error raised when a task should be a dict.
     """
+
+
+class FileDoesntExistException(Exception):
+    """
+    Error raised when a file should be existed when we submit a preview.
+    """
+
+
+class ProjectDoesntExistException(Exception):
+    """
+    Error raised when a project isn't available.
+    """

gazu/playlist.py

@@ -151,3 +151,105 @@ def update_playlist(playlist, client=default):
     return raw.put(
         "data/playlists/%s" % playlist["id"], playlist, client=client
     )
+
+
+def get_entity_preview_files(entity, client=default):
+    """
+    Get all preview files grouped by task type for a given entity.
+
+    Args:
+        entity (str / dict): The entity to retrieve files from or its ID.
+
+    Returns:
+        dict: A dict where keys are task type IDs and value array of revisions.
+    """
+    entity = normalize_model_parameter(entity)
+    return raw.get(
+        "data/playlists/entities/%s/preview-files" % entity["id"],
+        client=client,
+    )
+
+
+def add_entity_to_playlist(
+    playlist, entity, preview_file=None, persist=True, client=default
+):
+    """
+    Add an entity to the playlist, use the last uploaded preview as revision
+    to review.
+
+    Args:
+        playlist (dict): Playlist object to modify.
+        entity (str / dict): The entity to add or its ID.
+        preview_file (str / dict): Set it to force a give revision to review.
+        persist (bool): Set it to True to save the result to the API.
+
+    Returns:
+        dict: Updated playlist.
+    """
+    entity = normalize_model_parameter(entity)
+
+    if preview_file is None:
+        preview_files = get_entity_preview_files(entity)
+        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"]
+            ):
+                preview_file = first_file
+
+    preview_file = normalize_model_parameter(preview_file)
+    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
+):
+    """
+    Remove all occurences of a given entity from a playlist.
+
+    Args:
+        playlist (dict): Playlist object to modify
+        entity (str / dict): the entity to remove or its ID
+
+    Returns:
+        dict: Updated playlist.
+    """
+    entity = normalize_model_parameter(entity)
+    playlist["shots"] = [
+        entry
+        for entry in playlist["shots"]
+        if entry["entity_id"] != entity["id"]
+    ]
+    if persist:
+        update_playlist(playlist, client=client)
+    return playlist
+
+
+def update_entity_preview(
+    playlist, entity, preview_file, persist=True, client=default
+):
+    """
+    Remove all occurences of a given entity from a playlist.
+
+    Args:
+        playlist (dict): Playlist object to modify
+        entity (str / dict): the entity to add or its ID
+
+    Returns:
+        dict: Updated playlist.
+    """
+    entity = normalize_model_parameter(entity)
+    preview_file = normalize_model_parameter(preview_file)
+    for entry in playlist["shots"]:
+        if entry["entity_id"] == entity["id"]:
+            entry["preview_file_id"] = preview_file["id"]
+    if persist:
+        update_playlist(playlist, client=client)
+    return playlist

gazu/sync.py

@@ -56,6 +56,7 @@ def import_entities(entities, client=default):
     """
     Import entities from another instance to target instance (keep id and audit
     dates).
+
     Args:
         entities (list): Entities to import.
 
@@ -69,6 +70,7 @@ def import_tasks(tasks, client=default):
     """
     Import tasks from another instance to target instance (keep id and audit
     dates).
+
     Args:
         tasks (list): Tasks to import.
 
@@ -82,6 +84,7 @@ def import_entity_links(links, client=default):
     """
     Import enitity links from another instance to target instance (keep id and
     audit dates).
+
     Args:
         links (list): Entity links to import.
 
@@ -292,7 +295,8 @@ def get_sync_person_id_map(source_client, target_client):
 def push_assets(project_source, project_target, client_source, client_target):
     """
     Copy assets from source to target and preserve audit fields (`id`,
-    `created_at`, and `updated_at`)
+    `created_at`, and `updated_at`).
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -321,6 +325,7 @@ def push_episodes(
     """
     Copy episodes from source to target and preserve audit fields (`id`,
     `created_at`, and `updated_at`)
+
     Args:
         project_source (dict): The project to get episodes from
         project_target (dict): The project to push episodes to
@@ -344,6 +349,7 @@ def push_sequences(
     """
     Copy sequences from source to target and preserve audit fields (`id`,
     `created_at`, and `updated_at`)
+
     Args:
         project_source (dict): The project to get sequences from
         project_target (dict): The project to push sequences to
@@ -364,7 +370,8 @@ def push_sequences(
 def push_shots(project_source, project_target, client_source, client_target):
     """
     Copy shots from source to target and preserve audit fields (`id`,
-    `created_at`, and `updated_at`)
+    `created_at`, and `updated_at`).
+
     Args:
         project_source (dict): The project to get shots from
         project_target (dict): The project to push shots to
@@ -386,8 +393,9 @@ def push_entity_links(
     project_source, project_target, client_source, client_target
 ):
     """
-    Copy assets from source to target and preserve audit fields (`id`,
-    `created_at`, and `updated_at`)
+    Copy entity links (breakdown, concepts) from source to target and preserve
+    audit fields (`id`, `created_at`, and `updated_at`).
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -408,7 +416,8 @@ def push_project_entities(
 ):
     """
     Copy assets, episodes, sequences, shots and entity links from source to
-    target and preserve audit fields (`id`, `created_at`, and `updated_at`)
+    target and preserve audit fields (`id`, `created_at`, and `updated_at`).
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -445,6 +454,7 @@ def push_tasks(
     Copy tasks from source to target and preserve audit fields (`id`,
     `created_at`, and `updated_at`)
     Attachments and previews are created too.
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -479,6 +489,7 @@ def push_tasks_comments(project_source, client_source, client_target):
     Create a new comment into target api for each comment in source project
     but preserve only `created_at` field.
     Attachments and previews are created too.
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -508,6 +519,7 @@ def push_task_comments(
     Create a new comment into target api for each comment in source task
     but preserve only `created_at` field.
     Attachments and previews are created too.
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to
@@ -547,6 +559,7 @@ def push_task_comment(
     Create a new comment into target api for each comment in source task
     but preserve only `created_at` field.
     Attachments and previews are created too.
+
     Args:
         project_source (dict): The project to get assets from
         project_target (dict): The project to push assets to

gazu/task.py

@@ -257,25 +257,26 @@ def all_tasks_for_task_status(project, task_type, task_status, client=default):
 
 
 @cache
-def all_tasks_for_task_type(project, task_type, 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.
         task_type (str / dict): The task type dict or ID.
+        episode_id (str / dict): The episode dict or ID.
 
     Returns:
         list: Tasks for given project and task type.
     """
     project = normalize_model_parameter(project)
     task_type = normalize_model_parameter(task_type)
-    return raw.fetch_all(
-        "tasks",
-        {
-            "project_id": project["id"],
-            "task_type_id": task_type["id"],
-        },
-        client=client,
-    )
+    params = {
+        "project_id": project["id"],
+        "task_type_id": task_type["id"],
+    }
+    if episode is not None:
+        episode = normalize_model_parameter(episode)
+        params["episode_id"] = episode["id"]
+    return raw.fetch_all("tasks", params, client=client)
 
 
 @cache
@@ -526,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):
     """
@@ -655,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"],
@@ -1260,17 +1249,28 @@ def get_task_url(task, client=default):
     )
 
 
-def all_tasks_for_project(project, client=default):
+def all_tasks_for_project(
+    project, task_type=None, episode=None, client=default
+):
     """
     Args:
-        project (str / dict): The project
+        project (str / dict): The project (or its ID) to get tasks from.
+        task_type (str / dict): The task type (or its ID) to filter tasks.
+        episode (str / dict): The episode (or its ID) to filter tasks.
 
     Returns:
         dict: Tasks related to given project.
     """
     project = normalize_model_parameter(project)
     path = "/data/projects/%s/tasks" % project["id"]
-    return raw.get(path, client=client)
+    params = {}
+    if task_type is not None:
+        task_type = normalize_model_parameter(task_type)
+        params["task_type_id"] = task_type["id"]
+    if episode is not None:
+        episode = normalize_model_parameter(episode)
+        params["episode_id"] = episode["id"]
+    return raw.get(path, params=params, client=client)
 
 
 def update_comment(comment, client=default):

{gazu-0.10.14.dist-info → gazu-0.10.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazu
-Version: 0.10.14
+Version: 0.10.16
 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
@@ -32,8 +32,8 @@ Provides-Extra: dev
 Requires-Dist: wheel ; extra == 'dev'
 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'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: pytest-cov ; extra == 'test'

{gazu-0.10.14.dist-info → gazu-0.10.16.dist-info}/RECORD

@@ -1,8 +1,8 @@
 gazu/__init__.py,sha256=gVhtpZsvDiPuqvsEbCrgm6fKw8hluUhqspmlgGNIAvQ,3020
-gazu/__version__.py,sha256=pxrMEZK-Yqtv_P8vFxygBdkn1agAyjjzQFKamP7hRcg,24
+gazu/__version__.py,sha256=42JGoIUYC3OTcHv48Vyebrqa1zvt0Ul05GgS6njtjLQ,24
 gazu/asset.py,sha256=GWwam0yqHna_b9_5g5r0-O2zhMb7KlhfbIC17IOXKkY,14488
 gazu/cache.py,sha256=MnxrnfYN7wHNTTL7qzkEpYCYzWcolT56fqQ0_RegMbE,5879
-gazu/casting.py,sha256=5xmGMoU3MFgv1br8_5xyTx-Z7wo9r51wRisiblqcr94,3945
+gazu/casting.py,sha256=0LTdsHaCTHSKEflBWFeuraSaYNYetGkMHAIdg6Lv81U,5059
 gazu/client.py,sha256=YRIxX7u095XTe28JM0tMZ05WoTcYexJGS2jrxXSAQvs,14640
 gazu/concept.py,sha256=GcOPEmkbtZcSwlX8tnUj9Q5DTPBprSxtmXhlq7ioPwk,3727
 gazu/context.py,sha256=iUyug8EUz3kkF-kmYlH5JuLp66TUqR3uhAq7CouVd_U,4349
@@ -10,20 +10,20 @@ gazu/edit.py,sha256=sPSsnzykGr1Htl6ceKulUSVHGhoQLGLeWDni3Pul7BE,4609
 gazu/encoder.py,sha256=dj8U5mlGVy0GeaA7HIIdPSRdKswUQ8h4DzjFKLhwvR0,394
 gazu/entity.py,sha256=Pbc_sbgo8RhQV88nksP1whHyWL4hVyHR3CZ0sVplPY4,3670
 gazu/events.py,sha256=GRjWsw-jeZrcBq6U8EcxiGJ8HNTdPUuamhJa0uRHeeg,1715
-gazu/exception.py,sha256=hWa4UQe5V36td4_jYwQSMNCJM9aDHR3P7N90Nq4fPOM,1633
+gazu/exception.py,sha256=Y0kVNm6h-uXLEU1sNIbMSUep7Zxk738uYHOIVs2waM8,1880
 gazu/files.py,sha256=L82d5Bx3TkcaNczQ5t9s8DTKAcYXiqGaKUrag2cKjqI,39645
 gazu/helpers.py,sha256=Qa4JlZitiXsfYMJGGuwVaedLvHQVMbIwcqEZ099EjMw,3916
 gazu/person.py,sha256=BFh54J_R6_pIgYxAF_yAxFzjsO98hTLeBAKiZxewiK0,11098
-gazu/playlist.py,sha256=n7LwOF5ZvHDzP_fng-soYUESfb-S2ATmZJHGBh8cRLo,3739
+gazu/playlist.py,sha256=fzrhVY0fhxp5rSlvrowZPWEOqdl4rEYD4TKmnuvyKHg,6740
 gazu/project.py,sha256=fssI_Bf5UqqRd9bfM68oyfkhjxwWvjdiAcYvvUhI5LY,12649
 gazu/scene.py,sha256=bYsy7zKdQfDTfeqNAlgaqGMs2Hhxdy40NGt6TX_FBdA,5307
 gazu/shot.py,sha256=mHg-8B7xk3PXMqbPo0oCx2X7br2sGCBmuM7hEhpXRas,18942
 gazu/sorting.py,sha256=qSIO0pOHkj0Tl4gm9BJrYrcifWGGGmsW68Pl86zB_bg,266
-gazu/sync.py,sha256=OMsbQDROTdEwlukazUXPGnlC29QcaaHvsmqv3WsSexo,21582
-gazu/task.py,sha256=623td4cjNAqXQgQrD9opvxt2P8okv6rHNx-NYsGjVKg,35999
+gazu/sync.py,sha256=0ZJ5Z7Nuh5Kj4cswZCXLpXTLf8zQRcXsBLnurMw-i_E,21627
+gazu/task.py,sha256=rnOKunR-vXLQPkD5nOufPhppYLLkgAWZS9tYlutCMp0,36412
 gazu/user.py,sha256=GyJf6mrynHvLllw3Hsiv-6wjaYTHO_PBNkJzyJjJA1A,9556
-gazu-0.10.14.dist-info/LICENSE,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
-gazu-0.10.14.dist-info/METADATA,sha256=LRU9C0EJ10NXRe3C2VE3nsnaga6k9jn3NDS-z9xpZgs,5263
-gazu-0.10.14.dist-info/WHEEL,sha256=XRxW4r1PNiVhMpP4bT9oWtu3HyndxpJ84SkubFgzp_Y,109
-gazu-0.10.14.dist-info/top_level.txt,sha256=nv7fRIVpYYyIlk_66hBmMyvWcSC7UU-r-GE8uC1u1Go,5
-gazu-0.10.14.dist-info/RECORD,,
+gazu-0.10.16.dist-info/LICENSE,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+gazu-0.10.16.dist-info/METADATA,sha256=izhNmWl2_06y8RzzDu1iLROBuFhKJU3R8_HJX0Rb3-Y,5264
+gazu-0.10.16.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+gazu-0.10.16.dist-info/top_level.txt,sha256=nv7fRIVpYYyIlk_66hBmMyvWcSC7UU-r-GE8uC1u1Go,5
+gazu-0.10.16.dist-info/RECORD,,

{gazu-0.10.14.dist-info → gazu-0.10.16.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any