Skip to content

collect_auto_workfile

CollectAutoWorkfile

Bases: ContextPlugin

Collect current script for publish.

Source code in client/ayon_photoshop/plugins/publish/collect_auto_workfile.py 
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class CollectAutoWorkfile(pyblish.api.ContextPlugin):
    """Collect current script for publish."""

    order = pyblish.api.CollectorOrder + 0.2
    label = "Collect Workfile"
    hosts = ["photoshop"]

    targets = ["automated"]

    def process(self, context):
        product_type = "workfile"
        file_path = context.data["currentFile"]
        _, ext = os.path.splitext(file_path)
        staging_dir = os.path.dirname(file_path)
        base_name = os.path.basename(file_path)
        workfile_representation = {
            "name": ext[1:],
            "ext": ext[1:],
            "files": base_name,
            "stagingDir": staging_dir,
        }

        for instance in context:
            if instance.data["productType"] == product_type:
                self.log.debug("Workfile instance found, won't create new")
                instance.data.update({
                    "label": base_name,
                    "name": base_name,
                    "representations": [],
                })

                # creating representation
                _, ext = os.path.splitext(file_path)
                instance.data["representations"].append(
                    workfile_representation)

                return

        stub = photoshop.stub()
        stored_items = stub.get_layers_metadata()
        for item in stored_items:
            if item.get("creator_identifier") == product_type:
                if not item.get("active"):
                    self.log.debug("Workfile instance disabled")
                    return

        project_name = context.data["projectName"]
        proj_settings = context.data["project_settings"]
        auto_creator = proj_settings.get(
            "photoshop", {}).get(
            "create", {}).get(
            "WorkfileCreator", {})

        if not auto_creator or not auto_creator["enabled"]:
            self.log.debug("Workfile creator disabled, won't create new")
            return

        # context.data["variant"] might come only from collect_batch_data
        variant = (context.data.get("variant") or
                   auto_creator["default_variant"])

        task_name = context.data["task"]
        host_name = context.data["hostName"]
        folder_entity = context.data["folderEntity"]
        task_entity = context.data["taskEntity"]
        task_name = task_type = None
        if task_entity:
            task_name = task_entity["name"]
            task_type = task_entity["taskType"]

        product_name = get_product_name(
            project_name,
            task_name,
            task_type,
            host_name,
            product_type,
            variant,
            project_settings=proj_settings
        )

        # Create instance
        instance = context.create_instance(product_name)
        instance.data.update({
            "label": base_name,
            "name": base_name,
            "productName": product_name,
            "productType": product_type,
            "family": product_type,
            "families": [product_type],
            "representations": [],
            "folderPath": folder_entity["path"]
        })

        # creating representation
        instance.data["representations"].append(workfile_representation)

        self.log.debug("auto workfile review created:{}".format(instance.data))