fix: Premature link success message (#220)

Author: github-actions[bot]

proxima/__init__.py

@@ -1 +1,8 @@
 __version__ = "0.0.1"
+from .app.utils import core
+from .app import broker
+from .app import checks
+from .app import exceptions
+from .queuer import resolve
+from .queuer.link import ProxyLinker
+from .queuer import handlers

proxima/app/broker.py

@@ -15,7 +15,7 @@
 from rich.live import Live
 from cryptohash import sha1
 
-from proxima.settings.manager import SettingsManager
+from proxima.settings import SettingsManager
 
 
 class RedisConnection:

proxima/app/checks.py

@@ -3,16 +3,13 @@
 import time
 from typing import Union
 
-from rich import print
+from proxima import core
+from proxima.app.utils import pkg_info
+from proxima.settings import SettingsManager
+from proxima.worker import celery_app
 from rich.prompt import Confirm
 from yaspin import yaspin
 
-from .utils import pkg_info
-
-from ..app.utils import core
-from ..settings.manager import SettingsManager
-from ..worker.celery import app as celery_app
-
 settings = SettingsManager()
 
 core.install_rich_tracebacks()

proxima/app/cli.py

@@ -12,7 +12,7 @@
 from rich.console import Console
 from rich.rule import Rule
 
-from .utils import pkg_info
+from proxima.app.utils import pkg_info
 
 # Init classes
 cli_app = typer.Typer()
@@ -72,8 +72,8 @@ def draw_banner():
 def run_checks():
     """Run before CLI App load."""
 
-    from ..app import checks
-    from ..settings.manager import SettingsManager
+    from proxima import checks
+    from proxima.settings import SettingsManager
 
     settings = SettingsManager()
 
@@ -103,13 +103,13 @@ def queue():
     """
 
     # Init
-    from ..app import checks
-    from ..settings.manager import SettingsManager
-    from .utils.core import setup_rich_logging
+    from proxima import checks
+    from proxima.settings import SettingsManager
+    from proxima import core
 
     settings = SettingsManager()
 
-    setup_rich_logging()
+    core.setup_rich_logging()
     logger = logging.getLogger(__name__)
     logger.setLevel(settings["app"]["loglevel"])
     # End init
@@ -123,38 +123,11 @@ def queue():
     )
     print("\n")
 
-    from ..queuer import queue
+    from proxima.queuer import queue
 
     queue.main()
 
 
-@cli_app.command()
-def link():
-    """
-    Manually link proxies from directory to
-    source media in open DaVinci Resolve project
-    """
-
-    # Init
-    from ..settings.manager import SettingsManager
-    from .utils.core import setup_rich_logging
-
-    settings = SettingsManager()
-
-    setup_rich_logging()
-    logger = logging.getLogger(__name__)
-    logger.setLevel(settings["app"]["loglevel"])
-    # End init
-
-    from ..queuer import link
-
-    print("\n")
-    console.rule(f"[green bold]Link proxies[/] :link:", align="left")
-    print("\n")
-
-    link.main()
-
-
 @cli_app.command()
 def work(
     hide_banner: bool = hide_banner,
@@ -181,7 +154,7 @@ def work(
 
     print("\n")
 
-    from ..worker import launch_workers
+    from proxima.worker import launch_workers
 
     launch_workers.main(workers_to_launch)
 
@@ -239,7 +212,7 @@ def celery(
 def config():
     """Open user settings configuration file for editing"""
 
-    from ..settings.manager import SettingsManager
+    from proxima.settings import SettingsManager
 
     settings = SettingsManager()
 
@@ -249,6 +222,8 @@ def config():
     )
     print("\n")
 
+    # TODO: Cross platform alternative to this hack?
+    # labels: enhancement
     webbrowser.open_new(settings.user_file)
 
 

proxima/app/exceptions.py

@@ -0,0 +1,132 @@
+class ResolveUnsupportedPlatform(Exception):
+    """
+    Exception raised when Resolve's API does not support the current system.
+
+    This will occur when using any OS other than Windows, MacOS or Linux.
+    """
+
+    def __init__(self, message: str = "Platform is not 'Windows', 'MacOS' or 'Linux'"):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ResolveAPIConnectionError(Exception):
+    """
+    Exception raised when Resolve API is unreachable.
+
+    This can occur when Resolve is not open or the API server has crashed.
+    """
+
+    def __init__(
+        self,
+        message: str = "Resolve Python API is not accessible. Is DaVinci Resolve running?",
+    ):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ResolveNoCurrentProjectError(Exception):
+    """
+    Exception raised when the current project is unknown.
+
+    This can occur when Resolve is running but no project has been opened.
+    """
+
+    def __init__(
+        self,
+        message: str = "Couldn't get the current project. Is a project open in Resolve?",
+    ):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ResolveNoCurrentTimelineError(Exception):
+    """
+    Exception raised when the current timeline is unknown.
+
+    This can occur when Resolve is running and a project is open
+    but no timeline has been opened.
+    """
+
+    def __init__(
+        self,
+        message: str = "Couldn't get the current timeline. Is a timeline open in Resolve?",
+    ):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ResolveNoMediaPoolError(Exception):
+    """
+    Exception raised when the Media Pool object is not accessible.
+
+    This shouldn't occur under normal circumstances.
+    """
+
+    def __init__(self, message: str = "Resolve's Media Pool is inacessible."):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ResolveLinkMismatchError(Exception):
+    """
+    Exception raised when Resolve's `LinkProxyMedia` API method rejects a provided proxy.
+
+    The API method returns a bool with no additional error context.
+    Common reasons for a mismatch include incorrect proxy settings (framerate, timecode)
+    or a corrupt/unfinished proxy file.
+    """
+
+    def __init__(self, proxy_file: str, message: str = ""):
+
+        self.proxy_file = proxy_file
+
+        if message != "":
+            self.message = message
+        else:
+            self.message = f"Couldn't link source media to proxy '{self.proxy_file}'\n"
+            f"The proxy file may be corrupt, incomplete or encoding settings may be incorrect (framerate, timecode, etc)"
+
+        super().__init__(self.message)
+
+
+class ResolveLostMPIReferenceError(Exception):
+    """
+    Exception raised when media pool items passed to Resolve's `LinkProxyMedia` no longer reference in memory objects.
+
+    This occurs when any amount of project switching occurs between queuing and linking.
+    MPI references exist per session and will be lost on project changes.
+    """
+
+    def __init__(self, media_pool_item, message: str = ""):
+
+        self.media_pool_item = media_pool_item
+
+        if message != "":
+            self.message = message
+        else:
+            self.message = f"Lost reference to original media pool items, has the project been changed?\n"
+            f"Post-encode linking after a project change is not possible without re-iterating media pool items."
+
+        super().__init__(self.message)
+
+
+class NoneLinkableError(Exception):
+    """
+    Exception raised when no jobs passed to `ProxyLinker` are in the `linkable_types` list
+
+    This shouldn't occur under normal circumstances, but may occur if the `linkable_types`
+    list is changed in a way that no queued proxies will match the list.
+    """
+
+    def __init__(self, message: str = ""):
+
+        if message != "":
+            self.message = message
+        else:
+            self.message = (
+                f"No jobs passed to ProxyLinker are in the 'linkable_types' list.\n"
+            )
+            "This shouldn't happen under normal circumstances. Probably the list has been misconfigured."
+
+        super().__init__(self.message)

proxima/queuer/handlers.py

@@ -3,7 +3,7 @@
 import os
 import pathlib
 import shutil
-from typing import Union
+from typing import Union, Tuple
 
 from rich import print as pprint
 from rich.prompt import Confirm, Prompt
@@ -174,7 +174,7 @@ def handle_orphaned_proxies(media_list: list) -> list:
 
 
 def handle_already_linked(
-    media_list: list, unlinked_types: list = ["Offline", "None"]
+    media_list: list, unlinked_types: Tuple[str, ...] = ("Offline", "None")
 ) -> list:
     """Remove items from media-list that are already linked to a proxy.
     
@@ -205,7 +205,7 @@ def handle_already_linked(
 
 
 def handle_existing_unlinked(
-    media_list: list, unlinked_types: list = ["Offline", "None"]
+    media_list: list, unlinked_types: Tuple[str, ...] = ("Offline", "None")
 ) -> list:
 
     """Prompts user to either link or re-render unlinked proxy media that exists in the expected location.
@@ -320,12 +320,16 @@ def get_newest_proxy_file(media, expected_proxy_path: str) -> Union[str, None]:
                     linkable_now.append(x)
                     media_list.remove(x)
 
-            remaining = link.link_proxies_with_mpi(
-                linkable_now,
-                linkable_types=["Offline", "None"],
-                prompt_rerender=True,
-            )
-            media_list.extend(remaining)
+            proxy_linker = link.ProxyLinker(linkable_now)
+            proxy_linker.link()
+
+            # Prompt to requeue if any failures
+            if proxy_linker.mismatch_fail:
+                if Confirm.ask(
+                    f"[yellow]{len(proxy_linker.mismatch_fail)} files failed to link."
+                    "They may be corrupt or incomplete. Re-render them?"
+                ):
+                    media_list.extend(proxy_linker.mismatch_fail)
 
         else: