Merge branch 'develop' into chore/19--Collect-Instances-earlier

Author: BigRoy

client/ayon_photoshop/plugins/publish/extract_image.py

@@ -1,14 +1,18 @@
 import os
+from typing import TYPE_CHECKING
 
 import pyblish.api
 from ayon_core.pipeline import publish
 from ayon_core.pipeline.colorspace import get_remapped_colorspace_from_native
 from ayon_photoshop import api as photoshop
+if TYPE_CHECKING:
+    from ayon_core.pipeline import CreateContext, CreatedInstance
 
 
 class ExtractImage(
     pyblish.api.ContextPlugin,
-    publish.ColormanagedPyblishPluginMixin
+    publish.ColormanagedPyblishPluginMixin,
+    publish.OptionalPyblishPluginMixin
 ):
     """Extract all layers (groups) marked for publish.
 
@@ -23,20 +27,21 @@ class ExtractImage(
     order = publish.Extractor.order - 0.48
     label = "Extract Image"
     hosts = ["photoshop"]
-
-    families = ["image", "background"]
+    families = ["image"]
     formats = ["png", "jpg", "tga", "exr"]
     settings_category = "photoshop"
+    optional = False
 
     def process(self, context):
         # Filter instances
         filtered_instances = []
         for instance in context:
-            product_base_type = instance.data.get("productBaseType")
-            if not product_base_type:
-                product_base_type = instance.data["productType"]
-            if product_base_type in self.families:
-                filtered_instances.append(instance)
+            if (
+                instance.data["productBaseType"] != "image"
+                or not self.is_active(instance.data)
+            ):
+                continue
+            filtered_instances.append(instance)
 
         if not filtered_instances:
             return
@@ -55,25 +60,30 @@ def process(self, context):
                 staging_dir = self.staging_dir(instance)
                 self.log.info(f"Outputting image to {staging_dir}")
 
-                # Get instance layer ID
-                members = instance.data("members")
-                if not members:
+                ids = set()
+
+                # real layers and groups
+                members = instance.data.get("members")
+                if members:
+                    ids.update(int(member) for member in members)
+
+                # virtual groups collected by color coding or auto_image
+                add_ids = instance.data.pop("ids", None)
+                if add_ids:
+                    ids.update(set(add_ids))
+
+                if not ids:
+                    self.log.debug(
+                        f"Instance {instance} has no publishable layers, "
+                        f"skipping."
+                    )
                     continue
-                instance_id = int(members[0])
 
                 # Context manager handles all visibility: show instance path,
                 # hide siblings, restore original state on exit
-                with photoshop.isolated_layers_visibility(stub, instance_id, all_layers):
+                with photoshop.isolated_layers_visibility(stub, ids, all_layers):
                     # Perform extraction
                     files = {}
-                    ids = set()
-                    # real layers and groups
-                    if members:
-                        ids.update(int(member) for member in members)
-                    # virtual groups collected by color coding or auto_image
-                    add_ids = instance.data.pop("ids", None)
-                    if add_ids:
-                        ids.update(set(add_ids))
 
                     file_basename, workfile_extension = os.path.splitext(
                         stub.get_active_document_name()
@@ -127,3 +137,15 @@ def staging_dir(self, instance):
         from ayon_core.pipeline.publish import get_instance_staging_dir
 
         return get_instance_staging_dir(instance)
+
+    @classmethod
+    def get_attr_defs_for_context(cls, create_context: "CreateContext"):
+        return []
+
+    @classmethod
+    def get_attr_defs_for_instance(
+        cls, create_context: "CreateContext", instance: "CreatedInstance"
+    ):
+        if instance.product_base_type != "image":
+            return []
+        return cls.get_attribute_defs()

client/ayon_photoshop/plugins/publish/extract_layers.py

@@ -1,14 +1,20 @@
+import os
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 from ayon_core.pipeline import publish
 from ayon_core.pipeline.colorspace import get_remapped_colorspace_from_native
 from ayon_core.pipeline.publish import get_instance_staging_dir
 from ayon_photoshop import api as photoshop
 
+if TYPE_CHECKING:
+    from ayon_core.pipeline import CreateContext, CreatedInstance
+
 
 class ExtractLayers(
     publish.Extractor,
-    publish.ColormanagedPyblishPluginMixin
+    publish.ColormanagedPyblishPluginMixin,
+    publish.OptionalPyblishPluginMixin
 ):
     """Export layers within the instance layerset to a PSD file.
 
@@ -19,9 +25,17 @@ class ExtractLayers(
     order = publish.Extractor.order  # Must be after ExtractImage
     hosts = ["photoshop"]
     families = ["image"]
+    optional = False
     merge_layersets = False
+    extension = "psd"
 
     def process(self, instance):
+        if (
+            instance.data.get("productBaseType") != "image"
+            or instance.data.get("creatorIdentifier") == "auto_image"
+            or not self.is_active(instance.data)
+        ):
+            return
         ps_stub = photoshop.stub()
         native_colorspace = ps_stub.get_color_profile_name()
         self.log.info(f"Document colorspace profile: {native_colorspace}")
@@ -35,16 +49,20 @@ def process(self, instance):
         )
         self.log.debug(f"ayon_colorspace: {ayon_colorspace}")
         # Duplicate the document to the staging directory
+        filename = ps_stub.get_active_document_name()
+        basename = os.path.splitext(filename)[0]
+        filename = f"{basename}.{self.extension}"
         filepath = Path(
             get_instance_staging_dir(instance),
-            ps_stub.get_active_document_name()
+            filename
         )
         self.log.info(f"Duplicating document to staging directory: {filepath}")
-        with ps_stub.duplicate_document(
-            filepath
-        ):
+        with ps_stub.duplicate_document(filepath):
             # Delete all layers except the instance layerset
             layer = instance.data.get("layer")
+            if not hasattr(layer, "id"):
+                self.log.warning("Instance layer does not have an id, skipping.")
+                return
             ps_stub.delete_all_layers(
                 exclude_layers=[layer],
                 exclude_recursive=True
@@ -64,8 +82,8 @@ def process(self, instance):
         instance.data["stagingDir"] = filepath.parent
         representations = instance.data.setdefault("representations", [])
         representation = {
-            "name": "psd",
-            "ext": "psd",
+            "name": self.extension,
+            "ext": self.extension,
             "files": filepath.name,
             "stagingDir": filepath.parent,
         }
@@ -74,5 +92,16 @@ def process(self, instance):
             representation, instance.context,
             colorspace=ayon_colorspace
         )
-        self.log.debug(f"Rrepresentation: {representation}")
+        self.log.debug(f"Representation: {representation}")
         representations.append(representation)
+
+    @classmethod
+    def get_attr_defs_for_instance(
+        cls, create_context: "CreateContext", instance: "CreatedInstance"
+    ):
+        if (
+            instance.product_base_type != "image"
+            or instance.creator_identifier == "auto_image"
+        ):
+            return []
+        return cls.get_attribute_defs()

docs/index.md

@@ -1 +1,3 @@
---8<-- "README.md"
+# AYON Photoshop Addon API Reference
+
+--8<-- "README.md:3"

server/settings/publish_plugins.py

@@ -25,6 +25,11 @@
     {"value": "exr", "label": "exr"},
 ]
 
+extract_layer_ext_enum = [
+    {"value": "psd", "label": "psd"},
+    {"value": "psb", "label": "psb"},
+]
+
 color_mode_enum = [
     {"value": "RGB", "label": "RGB"},
     {"value": "CMYK", "label": "CMYK"},
@@ -122,7 +127,8 @@ class ValidateNamingPlugin(BaseSettingsModel):
 
 class ExtractImagePlugin(BaseSettingsModel):
     """Extracts image products and representations per published instance"""
-
+    enabled: bool = SettingsField(True, title="Enabled")
+    optional: bool = SettingsField(False, title="Optional")
     formats: list[str] = SettingsField(
         title="Extract Formats",
         default_factory=list,
@@ -140,11 +146,17 @@ class ExtractSourceReviewPlugin(BaseSettingsModel):
 class ExtractLayersPlugin(BaseSettingsModel):
     """Export layers within the instance layerset to a PSD file."""
     enabled: bool = SettingsField(False, title="Enabled")
+    optional: bool = SettingsField(False, title="Optional")
     merge_layersets: bool = SettingsField(
         False,
         title="Merge Layersets",
         description="Merge all layersets within the instance set.",
     )
+    extension: str = SettingsField(
+        "psd",
+        title="Export extension",
+        enum_resolver=lambda: extract_layer_ext_enum,
+    )
 
 
 class ValidateDocumentSettingsPlugin(BaseSettingsModel):
@@ -225,6 +237,8 @@ class PhotoshopPublishPlugins(BaseSettingsModel):
         "replace_char": "_"
     },
     "ExtractImage": {
+        "enabled": True,
+        "optional": False,
         "formats": [
             "png",
             "jpg",
@@ -235,7 +249,9 @@ class PhotoshopPublishPlugins(BaseSettingsModel):
     },
     "ExtractLayers": {
         "enabled": False,
-        "merge_layersets": False
+        "optional": False,
+        "merge_layersets": False,
+        "extension": "psd",
     },
     "ValidateDocumentSettings": {
         "enabled": False,