Flamenco: Reporting BAT Pack process on the UI

blender_cloud/flamenco/bat_interface.py

@@ -3,18 +3,79 @@
 import asyncio
 import logging
 import typing
-from pathlib import Path
+import pathlib
 
 from blender_asset_tracer import pack
+from blender_asset_tracer.pack import progress
+
 from blender_asset_tracer.pack.transfer import FileTransferError
 
+import bpy
+
 log = logging.getLogger(__name__)
 
 
-async def bat_copy(base_blendfile: Path,
-                   project: Path,
-                   target: Path,
-                   exclusion_filter: str) -> typing.Tuple[Path, typing.Set[Path]]:
+class BatProgress(progress.Callback):
+    """Report progress of BAT Packing to the UI.
+
+    Uses asyncio.run_coroutine_threadsafe() to ensure the UI is only updated
+    from the main thread. This is required since we run the BAT Pack in a
+    background thread.
+    """
+
+    def __init__(self, context) -> None:
+        super().__init__()
+        self.wm = context.window_manager
+        self.loop = asyncio.get_event_loop()
+
+    def txt(self, msg: str):
+        """Set a text in a thread-safe way."""
+        async def set_text():
+            self.wm.flamenco_status_txt = msg
+        asyncio.run_coroutine_threadsafe(set_text(), loop=self.loop)
+
+    def pack_start(self) -> None:
+        self.txt('Starting BAT Pack operation')
+
+    def pack_done(self,
+                  output_blendfile: pathlib.Path,
+                  missing_files: typing.Set[pathlib.Path]) -> None:
+        if missing_files:
+            self.txt('There were %d missing files' % len(missing_files))
+        else:
+            self.txt('Pack of %s done' % output_blendfile.name)
+
+    def trace_blendfile(self, filename: pathlib.Path) -> None:
+        """Called for every blendfile opened when tracing dependencies."""
+        self.txt('Inspecting %s' % filename.name)
+
+    def trace_asset(self, filename: pathlib.Path) -> None:
+        if filename.stem == '.blend':
+            return
+        self.txt('Found asset %s' % filename.name)
+
+    def rewrite_blendfile(self, orig_filename: pathlib.Path) -> None:
+        self.txt('Rewriting %s' % orig_filename.name)
+
+    def transfer_file(self, src: pathlib.Path, dst: pathlib.Path) -> None:
+        self.txt('Transferring %s' % src.name)
+
+    def transfer_file_skipped(self, src: pathlib.Path, dst: pathlib.Path) -> None:
+        self.txt('Skipped %s' % src.name)
+
+    def transfer_progress(self, total_bytes: int, transferred_bytes: int) -> None:
+        self.wm.flamenco_progress = 100 * transferred_bytes / total_bytes
+
+    def missing_file(self, filename: pathlib.Path) -> None:
+        # TODO(Sybren): report missing files in a nice way
+        pass
+
+
+async def bat_copy(context,
+                   base_blendfile: pathlib.Path,
+                   project: pathlib.Path,
+                   target: pathlib.Path,
+                   exclusion_filter: str) -> typing.Tuple[pathlib.Path, typing.Set[pathlib.Path]]:
     """Use BAT🦇 to copy the given file and dependencies to the target location.
 
     :raises: FileTransferError if a file couldn't be transferred.
@@ -23,13 +84,23 @@ async def bat_copy(base_blendfile: Path,
 
     loop = asyncio.get_event_loop()
 
+    wm = bpy.context.window_manager
+
     with pack.Packer(base_blendfile, project, target) as packer:
         if exclusion_filter:
             packer.exclude(*exclusion_filter.split())
+
+        packer.progress_cb = BatProgress(context)
+
         log.debug('awaiting strategise')
+        wm.flamenco_status = 'INVESTIGATING'
         await loop.run_in_executor(None, packer.strategise)
+
         log.debug('awaiting execute')
+        wm.flamenco_status = 'TRANSFERRING'
         await loop.run_in_executor(None, packer.execute)
+
         log.debug('done')
+        wm.flamenco_status = 'DONE'
 
     return packer.output_path, packer.missing_files