Skip to content

validate_missing_layer_names

ValidateMissingLayers

Bases: InstancePlugin

Validate existence of renderPass layers.

Source code in client/ayon_tvpaint/plugins/publish/validate_missing_layer_names.py
 5
 6
 7
 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
class ValidateMissingLayers(pyblish.api.InstancePlugin):
    """Validate existence of renderPass layers."""

    label = "Validate Missing Layers Names"
    order = pyblish.api.ValidatorOrder
    families = ["renderPass"]

    settings_category = "tvpaint"

    def process(self, instance):
        # Prepare layers
        layers_by_name = instance.context.data["layersByName"]

        # Layers ids of an instance
        layer_names = instance.data["layer_names"]

        # Check if all layers from render pass are in right group
        missing_layer_names = []
        for layer_name in layer_names:
            layers = layers_by_name.get(layer_name)
            if not layers:
                missing_layer_names.append(layer_name)

        # Everything is OK and skip exception
        if not missing_layer_names:
            return

        layers_msg = ", ".join([
            "\"{}\"".format(layer_name)
            for layer_name in missing_layer_names
        ])
        instance_label = (
            instance.data.get("label") or instance.data["name"]
        )
        description_layer_names = "<br/>".join([
            "- {}".format(layer_name)
            for layer_name in missing_layer_names
        ])

        # Raise an error
        raise PublishXmlValidationError(
            self,
            (
                "Layers were not found by name for instance \"{}\"."
                # Description what's wrong
                " Layer names marked for publishing are not available"
                " in layers list. Missing layer names: {}"
            ).format(instance.data["label"], layers_msg),
            formatting_data={
                "instance_name": instance_label,
                "layer_names": description_layer_names
            }
        )