extract layout plugin implementation

pype/plugins/standalonepublisher/publish/extract_layout_images.py

@@ -0,0 +1,102 @@
+import os
+import copy
+import pype.api
+import pyblish.api
+
+PSDImage = None
+
+
+class ExtractImageForLayout(pype.api.Extractor):
+
+    label = "Extract Images for Layout"
+    order = pyblish.api.ExtractorOrder + 0.02
+    families = ["imageForLayout"]
+    hosts = ["standalonepublisher"]
+
+    new_instance_family = "image"
+
+    # Presetable
+    allowed_group_names = ["OL", "BG", "MG", "FG", "UL", "SKY", "Field Guide"]
+
+    def process(self, instance):
+        # Check if python module `psd_tools` is installed
+        try:
+            global PSDImage
+            from psd_tools import PSDImage
+        except Exception:
+            raise AssertionError(
+                "BUG: Python module `psd-tools` is not installed!"
+            )
+
+        repres = instance.data.get("representations")
+        if not repres:
+            self.log.info("There are no representations on instance.")
+            return
+
+        for repre in tuple(repres):
+            # Skip all non files without .psd extension
+            if repre["ext"] != ".psd":
+                continue
+
+            # TODO add check of list
+            psd_filename = repre["files"]
+            psd_folder_path = repre["stagingDir"]
+            psd_filepath = os.path.join(psd_folder_path, psd_filename)
+            self.log.debug(f"psd_filepath: \"{psd_filepath}\"")
+            psd_object = PSDImage.open(psd_filepath)
+
+            self.create_new_instances(instance, psd_object)
+
+        # Remove the instance from context
+        instance.context.remove(instance)
+
+    def create_new_instances(self, instance, psd_object):
+        for layer in psd_object:
+            if (
+                not layer.is_visible()
+                or layer.name not in self.allowed_group_names
+            ):
+                continue
+
+            layer_name = layer.name.replace(" ", "_")
+            instance_name = f"image_{layer_name}"
+            new_instance = instance.context.create_instance(instance_name)
+            for key, value in instance.data.items():
+                if key not in ("name", "label", "stagingDir"):
+                    new_instance.data[key] = copy.deepcopy(value)
+
+            new_instance.data["label"] = " ".join(
+                (new_instance.data["asset"], instance_name)
+            )
+
+            new_instance.data["subset"] = instance_name
+            new_instance.data["anatomyData"]["subset"] = instance_name
+
+            # Set `family`
+            new_instance.data["family"] = self.new_instance_family
+
+            # Copy `families` and check if `family` is not in current families
+            families = new_instance.data.get("families") or list()
+            if families:
+                families = list(set(families))
+
+            if self.new_instance_family in families:
+                families.remove(self.new_instance_family)
+            new_instance.data["families"] = families
+
+            # Prepare staging dir for new instance
+            staging_dir = self.staging_dir(new_instance)
+
+            output_filename = "{}.png".format(layer_name)
+            output_filepath = os.path.join(staging_dir, output_filename)
+            pil_object = layer.composite(viewport=psd_object.viewbox)
+            pil_object.save(output_filepath, "PNG")
+
+            new_repre = {
+                "name": "png",
+                "ext": "png",
+                "files": output_filename,
+                "stagingDir": staging_dir
+            }
+            new_instance.data["representations"] = [new_repre]
+            self.log.debug(new_instance.data["name"])