[main][592391](UserStory) [SDK] Update Python SDK and editorial tests…

… to work with the new shots API (#101) * update linter and dev dependencies * update models to handle shots * add shot helper methods * [main][592391](UserStory) bump sdk version * [main][592391](UserStory) add constructor methods for shots
TheFoundryVisionmongers · Jan 16, 2025 · 1bc8eba · 1bc8eba
1 parent a9df1d0
commit 1bc8eba
Show file tree

Hide file tree

Showing 11 changed files with 579 additions and 235 deletions.
diff --git a/flixpy/examples/pyproject.toml b/flixpy/examples/pyproject.toml
@@ -7,5 +7,5 @@ ignore = [
     "T201", # allow print()
     "ERA001", # allow commented-out code
     "PLR2004", # allow magic values in comparisons
-    "ASYNC101", # allow blocking calls in async functions for demonstration purposes
+    "ASYNC230", # allow blocking calls in async functions for demonstration purposes
 ]
diff --git a/flixpy/flix/cli/main.py b/flixpy/flix/cli/main.py
@@ -310,8 +310,7 @@ async def _handler(event: webhooks.WebhookEvent) -> None:
     await site.start()
 
     click.echo(f"Listening for events on {address}:{port} (press CTRL+C to abort)...", err=True)
-    while True:
-        await asyncio.sleep(3600)
+    await asyncio.Event().wait()
 
 
 @flix_cli.group(help="Manage contact sheet templates.")
@@ -344,7 +343,7 @@ async def contactsheet_edit_loop(
             pdf_response = await flix_client.request(
                 "GET", "/contactsheet/preview", params={"data": b64, "format": "pdf"}
             )
-            with pathlib.Path(preview_file).open("wb") as f:  # noqa: ASYNC101
+            with pathlib.Path(preview_file).open("wb") as f:  # noqa: ASYNC230
                 f.write(await pdf_response.read())
         elif action == "save":
             return data

diff --git a/flixpy/flix/extension/types.py b/flixpy/flix/extension/types.py
@@ -20,32 +20,32 @@
 )
 
 __all__ = [
-    "SourceFile",
-    "SourceFileType",
-    "SourceFilePreviewMode",
-    "ProjectDetails",
-    "Event",
-    "ClientEvent",
-    "OpenEvent",
-    "ClientPingEvent",
     "ActionEvent",
-    "ConnectionEvent",
-    "OpenPanelData",
-    "ProjectEvent",
-    "ProjectIds",
-    "ClientEventType",
     "ActionState",
     "ActionType",
+    "ActionsInProgress",
     "AssetType",
-    "VersionEvent",
-    "OpenSourceFileEvent",
+    "ClientEvent",
+    "ClientEventType",
+    "ClientPingEvent",
+    "ConnectionEvent",
     "DownloadResponse",
-    "ActionsInProgress",
+    "Event",
+    "OpenEvent",
+    "OpenPanelData",
+    "OpenSourceFileEvent",
     "PanelBrowserStatus",
-    "StatusEvent",
+    "PanelRequestResponse",
+    "ProjectDetails",
+    "ProjectEvent",
+    "ProjectIds",
     "RevisionStatus",
+    "SourceFile",
+    "SourceFilePreviewMode",
+    "SourceFileType",
     "Status",
-    "PanelRequestResponse",
+    "StatusEvent",
+    "VersionEvent",
 ]
 
 

diff --git a/flixpy/flix/lib/client.py b/flixpy/flix/lib/client.py
@@ -23,7 +23,7 @@
 if TYPE_CHECKING:
     from types import TracebackType
 
-__all__ = ["Client", "AccessKey"]
+__all__ = ["AccessKey", "Client"]
 
 logger = logging.getLogger(__name__)
 

diff --git a/flixpy/flix/lib/forms.py b/flixpy/flix/lib/forms.py
@@ -13,15 +13,15 @@
 import asyncclick as click
 
 __all__ = [
-    "Form",
-    "Field",
-    "StringField",
-    "IntField",
-    "FloatField",
     "BoolField",
+    "Choice",
     "EnumField",
+    "Field",
+    "FloatField",
+    "Form",
+    "IntField",
     "MultichoiceField",
-    "Choice",
+    "StringField",
     "prompt_enum",
 ]
 

diff --git a/flixpy/flix/lib/models.py b/flixpy/flix/lib/models.py
@@ -4,7 +4,7 @@
 
 from typing import Any, TypedDict
 
-from typing_extensions import NotRequired
+from typing_extensions import NotRequired, Required
 
 
 class MetadataField(TypedDict, total=False):
@@ -117,7 +117,7 @@ class SequenceRevision(TypedDict, total=False):
     owner: User
     created_date: str
     metadata: list[MetadataField]
-    revisioned_panels: list[SequencePanel]
+    related_shots: list[SequenceRevisionShot]
     comment: str
     published: bool
     imported: bool
@@ -126,7 +126,6 @@ class SequenceRevision(TypedDict, total=False):
     autosave: bool
     sequence_id: int
     show_id: int
-    episode_id: int
     task_id: str
     source_files: list[Asset]
 
@@ -247,15 +246,32 @@ class PanelRevision(TypedDict, total=False):
     panel: Panel
 
 
-class SequencePanel(PanelRevision):
-    sequence_revision: NotRequired[int]
+class ShotPanelRevision(TypedDict, total=False):
+    panel_revision: PanelRevision
     duration: int
     trim_in_frame: int
     trim_out_frame: int
     hidden: bool
     dialogue: NotRequired[Dialogue]
 
 
+class Shot(TypedDict, total=False):
+    id: int
+    show_id: int
+    sequence_id: int
+    owner: User
+    created_date: str
+    transitive: bool
+    related_panel_revisions: list[ShotPanelRevision]
+    metadata: list[MetadataField]
+
+
+class SequenceRevisionShot(TypedDict, total=False):
+    sequence_revision: int
+    shot: Required[Shot]
+    name: str
+
+
 class PageSize(TypedDict):
     width: int
     height: int