Merge pull request #1390 from ynput/bugfix/apply-core-plugin-settings

Chore: Define settings category on core publish plugins

client/ayon_core/pipeline/publish/lib.py

@@ -361,12 +361,18 @@ def get_plugin_settings(plugin, project_settings, log, category=None):
     # Use project settings based on a category name
     if category:
         try:
-            return (
+            output = (
                 project_settings
                 [category]
                 ["publish"]
                 [plugin.__name__]
             )
+            warnings.warn(
+                "Please fill 'settings_category'"
+                f" for plugin '{plugin.__name__}'.",
+                DeprecationWarning
+            )
+            return output
         except KeyError:
             pass
 
@@ -391,12 +397,18 @@ def get_plugin_settings(plugin, project_settings, log, category=None):
         category_from_file = "core"
 
     try:
-        return (
+        output = (
             project_settings
             [category_from_file]
             [plugin_kind]
             [plugin.__name__]
         )
+        warnings.warn(
+            "Please fill 'settings_category'"
+            f" for plugin '{plugin.__name__}'.",
+            DeprecationWarning
+        )
+        return output
     except KeyError:
         pass
     return {}

client/ayon_core/plugins/publish/cleanup.py

@@ -38,6 +38,8 @@ class CleanUp(pyblish.api.InstancePlugin):
         "webpublisher",
         "shell"
     ]
+    settings_category = "core"
+
     exclude_families = ["clip"]
     optional = True
     active = True

client/ayon_core/plugins/publish/cleanup_farm.py

@@ -13,6 +13,8 @@ class CleanUpFarm(pyblish.api.ContextPlugin):
 
     order = pyblish.api.IntegratorOrder + 11
     label = "Clean Up Farm"
+
+    settings_category = "core"
     enabled = True
 
     # Keep "filesequence" for backwards compatibility of older jobs

client/ayon_core/plugins/publish/collect_anatomy_instance_data.py

@@ -46,6 +46,8 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
     order = pyblish.api.CollectorOrder + 0.49
     label = "Collect Anatomy Instance data"
 
+    settings_category = "core"
+
     follow_workfile_version = False
 
     def process(self, context):

client/ayon_core/plugins/publish/collect_audio.py

@@ -41,6 +41,7 @@ class CollectAudio(pyblish.api.ContextPlugin):
         "max",
         "circuit",
     ]
+    settings_category = "core"
 
     audio_product_name = "audioMain"
 

client/ayon_core/plugins/publish/collect_frames_fix.py

@@ -23,6 +23,7 @@ class CollectFramesFixDef(
     targets = ["local"]
     hosts = ["nuke"]
     families = ["render", "prerender"]
+    settings_category = "core"
 
     rewrite_version_enable = False
 

client/ayon_core/plugins/publish/collect_scene_version.py

@@ -12,9 +12,10 @@ class CollectSceneVersion(pyblish.api.ContextPlugin):
     """
 
     order = pyblish.api.CollectorOrder
-    label = 'Collect Scene Version'
+    label = "Collect Scene Version"
     # configurable in Settings
     hosts = ["*"]
+    settings_category = "core"
 
     # in some cases of headless publishing (for example webpublisher using PS)
     # you want to ignore version from name and let integrate use next version

client/ayon_core/plugins/publish/extract_burnin.py

@@ -57,6 +57,7 @@ class ExtractBurnin(publish.Extractor):
         "unreal",
         "circuit",
     ]
+    settings_category = "core"
 
     optional = True
 

client/ayon_core/plugins/publish/extract_color_transcode.py

@@ -55,6 +55,8 @@ class ExtractOIIOTranscode(publish.Extractor):
     label = "Transcode color spaces"
     order = pyblish.api.ExtractorOrder + 0.019
 
+    settings_category = "core"
+
     optional = True
 
     # Supported extensions

client/ayon_core/plugins/publish/extract_review.py

@@ -165,6 +165,7 @@ class ExtractReview(pyblish.api.InstancePlugin):
         "photoshop"
     ]
 
+    settings_category = "core"
     # Supported extensions
     image_exts = {"exr", "jpg", "jpeg", "png", "dpx", "tga", "tiff", "tif"}
     video_exts = {"mov", "mp4"}

client/ayon_core/plugins/publish/extract_thumbnail.py

@@ -43,6 +43,7 @@ class ExtractThumbnail(pyblish.api.InstancePlugin):
         "houdini",
         "circuit",
     ]
+    settings_category = "core"
     enabled = False
 
     integrate_thumbnail = False

client/ayon_core/plugins/publish/extract_usd_layer_contributions.py

@@ -256,6 +256,7 @@ class CollectUSDLayerContributions(pyblish.api.InstancePlugin,
     label = "Collect USD Layer Contributions (Asset/Shot)"
     families = ["usd"]
     enabled = True
+    settings_category = "core"
 
     # A contribution defines a contribution into a (department) layer which
     # will get layered into the target product, usually the asset or shot.
@@ -633,6 +634,8 @@ class ExtractUSDLayerContribution(publish.Extractor):
     label = "Extract USD Layer Contributions (Asset/Shot)"
     order = pyblish.api.ExtractorOrder + 0.45
 
+    settings_category = "core"
+
     use_ayon_entity_uri = False
 
     def process(self, instance):
@@ -795,6 +798,8 @@ class ExtractUSDAssetContribution(publish.Extractor):
     label = "Extract USD Asset/Shot Contributions"
     order = ExtractUSDLayerContribution.order + 0.01
 
+    settings_category = "core"
+
     use_ayon_entity_uri = False
 
     def process(self, instance):

client/ayon_core/plugins/publish/integrate_hero_version.py

@@ -61,6 +61,8 @@ class IntegrateHeroVersion(
     # Must happen after IntegrateNew
     order = pyblish.api.IntegratorOrder + 0.1
 
+    settings_category = "core"
+
     optional = True
     active = True
 

client/ayon_core/plugins/publish/integrate_product_group.py

@@ -24,6 +24,8 @@ class IntegrateProductGroup(pyblish.api.InstancePlugin):
     order = pyblish.api.IntegratorOrder - 0.1
     label = "Product Group"
 
+    settings_category = "core"
+
     # Attributes set by settings
     product_grouping_profiles = None
 

client/ayon_core/plugins/publish/preintegrate_thumbnail_representation.py

@@ -22,6 +22,8 @@ class PreIntegrateThumbnails(pyblish.api.InstancePlugin):
     label = "Override Integrate Thumbnail Representations"
     order = pyblish.api.IntegratorOrder - 0.1
 
+    settings_category = "core"
+
     integrate_profiles = []
 
     def process(self, instance):

client/ayon_core/plugins/publish/validate_containers.py

@@ -31,6 +31,7 @@ class ValidateOutdatedContainers(
 
     label = "Validate Outdated Containers"
     order = pyblish.api.ValidatorOrder
+    settings_category = "core"
 
     optional = True
     actions = [ShowInventory]

client/ayon_core/plugins/publish/validate_intent.py

@@ -14,6 +14,8 @@ class ValidateIntent(pyblish.api.ContextPlugin):
     order = pyblish.api.ValidatorOrder
 
     label = "Validate Intent"
+    settings_category = "core"
+
     enabled = False
 
     # Can be modified by settings

client/ayon_core/plugins/publish/validate_version.py

@@ -17,6 +17,7 @@ class ValidateVersion(pyblish.api.InstancePlugin, OptionalPyblishPluginMixin):
     order = pyblish.api.ValidatorOrder
 
     label = "Validate Version"
+    settings_category = "core"
 
     optional = False
     active = True