OP-3908 - remove SubsetManager rout

Functionality already in Publisher.
Moved list_instances and remove_instances directly into PhotoshopHost (needed for Creators).

openpype/hosts/photoshop/api/__init__.py

@@ -7,28 +7,15 @@ Anything that isn't defined here is INTERNAL and unreliable for external use.
 from .launch_logic import stub
 
 from .pipeline import (
+    PhotoshopHost,
     ls,
-    list_instances,
-    remove_instance,
-    install,
-    uninstall,
-    containerise,
-    get_context_data,
-    update_context_data,
-    get_context_title
+    containerise
 )
 from .plugin import (
     PhotoshopLoader,
     get_unique_layer_name
 )
-from .workio import (
-    file_extensions,
-    has_unsaved_changes,
-    save_file,
-    open_file,
-    current_file,
-    work_root,
-)
+
 
 from .lib import (
     maintained_selection,
@@ -40,28 +27,14 @@ __all__ = [
     "stub",
 
     # pipeline
+    "PhotoshopHost",
     "ls",
-    "list_instances",
-    "remove_instance",
-    "install",
-    "uninstall",
     "containerise",
-    "get_context_data",
-    "update_context_data",
-    "get_context_title",
 
     # Plugin
     "PhotoshopLoader",
     "get_unique_layer_name",
 
-    # workfiles
-    "file_extensions",
-    "has_unsaved_changes",
-    "save_file",
-    "open_file",
-    "current_file",
-    "work_root",
-
     # lib
     "maintained_selection",
     "maintained_visibility",

openpype/hosts/photoshop/api/launch_logic.py

@@ -346,9 +346,6 @@ class PhotoshopRoute(WebSocketRoute):
     async def sceneinventory_route(self):
         self._tool_route("sceneinventory")
 
-    async def subsetmanager_route(self):
-        self._tool_route("subsetmanager")
-
     async def experimental_tools_route(self):
         self._tool_route("experimental_tools")
 

openpype/hosts/photoshop/api/pipeline.py

@@ -12,6 +12,13 @@ from openpype.pipeline import (
     deregister_creator_plugin_path,
     AVALON_CONTAINER_ID,
 )
+
+from openpype.host import (
+    HostBase,
+    IWorkfileHost,
+    ILoadHost,
+)
+
 from openpype.pipeline.load import any_outdated_containers
 from openpype.hosts.photoshop import PHOTOSHOP_HOST_DIR
 
@@ -26,6 +33,147 @@ CREATE_PATH = os.path.join(PLUGINS_DIR, "create")
 INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory")
 
 
+class PhotoshopHost(HostBase, IWorkfileHost, ILoadHost):
+    name = "photoshop"
+
+    def __init__(self):
+        super(PhotoshopHost, self).__init__()
+
+    def install(self):
+        """Install Photoshop-specific functionality of avalon-core.
+
+        This function is called automatically on calling `api.install(photoshop)`.
+        """
+        log.info("Installing OpenPype Photoshop...")
+        pyblish.api.register_host("photoshop")
+
+        pyblish.api.register_plugin_path(PUBLISH_PATH)
+        register_loader_plugin_path(LOAD_PATH)
+        register_creator_plugin_path(CREATE_PATH)
+        log.info(PUBLISH_PATH)
+
+        pyblish.api.register_callback(
+            "instanceToggled", on_pyblish_instance_toggled
+        )
+
+        register_event_callback("application.launched", on_application_launch)
+
+    def current_file(self):
+        try:
+            full_name = lib.stub().get_active_document_full_name()
+            if full_name and full_name != "null":
+                return os.path.normpath(full_name).replace("\\", "/")
+        except Exception:
+            pass
+
+        return None
+
+    def work_root(self, session):
+        return os.path.normpath(session["AVALON_WORKDIR"]).replace("\\", "/")
+
+    def open_workfile(self, filepath):
+        lib.stub().open(filepath)
+
+        return True
+
+    def save_workfile(self, filepath=None):
+        _, ext = os.path.splitext(filepath)
+        lib.stub().saveAs(filepath, ext[1:], True)
+
+    def get_current_workfile(self):
+        return self.current_file()
+
+    def workfile_has_unsaved_changes(self):
+        if self.current_file():
+            return not lib.stub().is_saved()
+
+        return False
+
+    def get_workfile_extensions(self):
+        return [".psd", ".psb"]
+
+    def get_containers(self):
+        return ls()
+
+    def get_context_data(self):
+        """Get stored values for context (validation enable/disable etc)"""
+        meta = _get_stub().get_layers_metadata()
+        for item in meta:
+            if item.get("id") == "publish_context":
+                item.pop("id")
+                return item
+
+        return {}
+
+    def update_context_data(self, data, changes):
+        """Store value needed for context"""
+        item = data
+        item["id"] = "publish_context"
+        _get_stub().imprint(item["id"], item)
+
+    def get_context_title(self):
+        """Returns title for Creator window"""
+
+        project_name = legacy_io.Session["AVALON_PROJECT"]
+        asset_name = legacy_io.Session["AVALON_ASSET"]
+        task_name = legacy_io.Session["AVALON_TASK"]
+        return "{}/{}/{}".format(project_name, asset_name, task_name)
+
+    def list_instances(self):
+        """List all created instances to publish from current workfile.
+
+        Pulls from File > File Info
+
+        Returns:
+            (list) of dictionaries matching instances format
+        """
+        stub = _get_stub()
+
+        if not stub:
+            return []
+
+        instances = []
+        layers_meta = stub.get_layers_metadata()
+        if layers_meta:
+            for instance in layers_meta:
+                if instance.get("id") == "pyblish.avalon.instance":
+                    instances.append(instance)
+
+        return instances
+
+    def remove_instance(self, instance):
+        """Remove instance from current workfile metadata.
+
+        Updates metadata of current file in File > File Info and removes
+        icon highlight on group layer.
+
+        Args:
+            instance (dict): instance representation from subsetmanager model
+        """
+        stub = _get_stub()
+
+        if not stub:
+            return
+
+        inst_id = instance.get("instance_id") or instance.get("uuid")  # legacy
+        if not inst_id:
+            log.warning("No instance identifier for {}".format(instance))
+            return
+
+        stub.remove_instance(inst_id)
+
+        if instance.get("members"):
+            item = stub.get_layer(instance["members"][0])
+            if item:
+                stub.rename_layer(item.id,
+                                  item.name.replace(stub.PUBLISH_ICON, ''))
+
+    def uninstall(self):
+        pyblish.api.deregister_plugin_path(PUBLISH_PATH)
+        deregister_loader_plugin_path(LOAD_PATH)
+        deregister_creator_plugin_path(CREATE_PATH)
+
+
 def check_inventory():
     if not any_outdated_containers():
         return
@@ -52,32 +200,6 @@ def on_pyblish_instance_toggled(instance, old_value, new_value):
     instance[0].Visible = new_value
 
 
-def install():
-    """Install Photoshop-specific functionality of avalon-core.
-
-    This function is called automatically on calling `api.install(photoshop)`.
-    """
-    log.info("Installing OpenPype Photoshop...")
-    pyblish.api.register_host("photoshop")
-
-    pyblish.api.register_plugin_path(PUBLISH_PATH)
-    register_loader_plugin_path(LOAD_PATH)
-    register_creator_plugin_path(CREATE_PATH)
-    log.info(PUBLISH_PATH)
-
-    pyblish.api.register_callback(
-        "instanceToggled", on_pyblish_instance_toggled
-    )
-
-    register_event_callback("application.launched", on_application_launch)
-
-
-def uninstall():
-    pyblish.api.deregister_plugin_path(PUBLISH_PATH)
-    deregister_loader_plugin_path(LOAD_PATH)
-    deregister_creator_plugin_path(CREATE_PATH)
-
-
 def ls():
     """Yields containers from active Photoshop document
 
@@ -117,61 +239,6 @@ def ls():
         yield data
 
 
-def list_instances():
-    """List all created instances to publish from current workfile.
-
-    Pulls from File > File Info
-
-    For SubsetManager
-
-    Returns:
-        (list) of dictionaries matching instances format
-    """
-    stub = _get_stub()
-
-    if not stub:
-        return []
-
-    instances = []
-    layers_meta = stub.get_layers_metadata()
-    if layers_meta:
-        for instance in layers_meta:
-            if instance.get("id") == "pyblish.avalon.instance":
-                instances.append(instance)
-
-    return instances
-
-
-def remove_instance(instance):
-    """Remove instance from current workfile metadata.
-
-    Updates metadata of current file in File > File Info and removes
-    icon highlight on group layer.
-
-    For SubsetManager
-
-    Args:
-        instance (dict): instance representation from subsetmanager model
-    """
-    stub = _get_stub()
-
-    if not stub:
-        return
-
-    inst_id = instance.get("instance_id") or instance.get("uuid")  # legacy
-    if not inst_id:
-        log.warning("No instance identifier for {}".format(instance))
-        return
-
-    stub.remove_instance(inst_id)
-
-    if instance.get("members"):
-        item = stub.get_layer(instance["members"][0])
-        if item:
-            stub.rename_layer(item.id,
-                              item.name.replace(stub.PUBLISH_ICON, ''))
-
-
 def _get_stub():
     """Handle pulling stub from PS to run operations on host
 
@@ -224,30 +291,3 @@ def containerise(
     stub.imprint(layer.id, data)
 
     return layer
-
-
-def get_context_data():
-    """Get stored values for context (validation enable/disable etc)"""
-    meta = _get_stub().get_layers_metadata()
-    for item in meta:
-        if item.get("id") == "publish_context":
-            item.pop("id")
-            return item
-
-    return {}
-
-
-def update_context_data(data, changes):
-    """Store value needed for context"""
-    item = data
-    item["id"] = "publish_context"
-    _get_stub().imprint(item["id"], item)
-
-
-def get_context_title():
-    """Returns title for Creator window"""
-
-    project_name = legacy_io.Session["AVALON_PROJECT"]
-    asset_name = legacy_io.Session["AVALON_ASSET"]
-    task_name = legacy_io.Session["AVALON_TASK"]
-    return "{}/{}/{}".format(project_name, asset_name, task_name)

openpype/hosts/photoshop/plugins/create/create_image.py

@@ -9,6 +9,7 @@ from openpype.pipeline import (
 )
 from openpype.lib import prepare_template_data
 from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS
+from openpype.hosts.photoshop.api import PhotoshopHost
 
 
 class ImageCreator(Creator):
@@ -19,7 +20,7 @@ class ImageCreator(Creator):
     description = "Image creator"
 
     def collect_instances(self):
-        for instance_data in api.list_instances():
+        for instance_data in PhotoshopHost().list_instances():
             # legacy instances have family=='image'
             creator_id = (instance_data.get("creator_identifier") or
                           instance_data.get("family"))
@@ -121,7 +122,7 @@ class ImageCreator(Creator):
 
     def remove_instances(self, instances):
         for instance in instances:
-            api.remove_instance(instance)
+            PhotoshopHost().remove_instance(instance)
             self._remove_instance_from_context(instance)
 
     def get_default_variants(self):

openpype/hosts/photoshop/plugins/create/workfile_creator.py

@@ -5,6 +5,7 @@ from openpype.pipeline import (
     CreatedInstance,
     legacy_io
 )
+from openpype.hosts.photoshop.api import PhotoshopHost
 
 
 class PSWorkfileCreator(AutoCreator):
@@ -17,7 +18,7 @@ class PSWorkfileCreator(AutoCreator):
         return []
 
     def collect_instances(self):
-        for instance_data in api.list_instances():
+        for instance_data in PhotoshopHost().list_instances():
             creator_id = instance_data.get("creator_identifier")
             if creator_id == self.identifier:
                 subset_name = instance_data["subset"]

openpype/hosts/photoshop/plugins/publish/collect_instances.py

@@ -82,7 +82,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
 
         if len(instance_names) != len(set(instance_names)):
             self.log.warning("Duplicate instances found. " +
-                             "Remove unwanted via SubsetManager")
+                             "Remove unwanted via Publisher")
 
         if len(instance_names) == 0 and self.flatten_subset_template:
             project_name = context.data["projectEntity"]["name"]

openpype/hosts/photoshop/plugins/publish/validate_unique_subsets.py

@@ -29,7 +29,7 @@ class ValidateSubsetUniqueness(pyblish.api.ContextPlugin):
              for item, count in collections.Counter(subset_names).items()
              if count > 1]
         msg = ("Instance subset names {} are not unique. ".format(non_unique) +
-               "Remove duplicates via SubsetManager.")
+               "Remove duplicates via Publisher.")
         formatting_data = {
             "non_unique": ",".join(non_unique)
         }