Skip to content

validate_instance_in_context

Validate if instance context is the same as publish context.

ValidateInstanceInContextFusion

Bases: InstancePlugin, OptionalPyblishPluginMixin

Validator to check if instance context matches context of publish.

When working in per-shot style you always publish data in context of current asset (shot). This validator checks if this is so. It is optional so it can be disabled when needed.

Source code in client/ayon_fusion/plugins/publish/validate_instance_in_context.py
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
class ValidateInstanceInContextFusion(pyblish.api.InstancePlugin,
                                      OptionalPyblishPluginMixin):
    """Validator to check if instance context matches context of publish.

    When working in per-shot style you always publish data in context of
    current asset (shot). This validator checks if this is so. It is optional
    so it can be disabled when needed.
    """
    # Similar to maya and houdini-equivalent `ValidateInstanceInContext`

    order = ValidateContentsOrder
    label = "Instance in same Context"
    optional = True
    hosts = ["fusion"]
    actions = [SelectToolAction, RepairAction]

    def process(self, instance):
        if not self.is_active(instance.data):
            return

        instance_context = self.get_context(instance.data)
        context = self.get_context(instance.context.data)
        if instance_context != context:
            context_label = "{} > {}".format(*context)
            instance_label = "{} > {}".format(*instance_context)

            raise PublishValidationError(
                message=(
                    "Instance '{}' publishes to different asset than current "
                    "context: {}. Current context: {}".format(
                        instance.name, instance_label, context_label
                    )
                ),
                description=(
                    "## Publishing to a different asset\n"
                    "There are publish instances present which are publishing "
                    "into a different asset than your current context.\n\n"
                    "Usually this is not what you want but there can be cases "
                    "where you might want to publish into another asset or "
                    "shot. If that's the case you can disable the validation "
                    "on the instance to ignore it."
                )
            )

    @classmethod
    def repair(cls, instance):

        create_context = instance.context.data["create_context"]
        instance_id = instance.data.get("instance_id")
        created_instance = create_context.get_instance_by_id(
            instance_id
        )
        if created_instance is None:
            raise RuntimeError(
                f"No CreatedInstances found with id '{instance_id} "
                f"in {create_context.instances_by_id}"
            )

        context_asset, context_task = cls.get_context(instance.context.data)
        created_instance["folderPath"] = context_asset
        created_instance["task"] = context_task
        create_context.save_changes()

    @staticmethod
    def get_context(data):
        """Return asset, task from publishing context data"""
        return data["folderPath"], data["task"]

get_context(data) staticmethod

Return asset, task from publishing context data

Source code in client/ayon_fusion/plugins/publish/validate_instance_in_context.py
77
78
79
80
@staticmethod
def get_context(data):
    """Return asset, task from publishing context data"""
    return data["folderPath"], data["task"]