Skip to content

validate_naming

ValidateNaming

Bases: InstancePlugin

Validate the instance name.

Spaces in names are not allowed. Will be replace with underscores.

Source code in client/ayon_photoshop/plugins/publish/validate_naming.py 
 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
105
106
107
108
109
110
111
112
113
114
115
116
117
class ValidateNaming(pyblish.api.InstancePlugin):
    """Validate the instance name.

    Spaces in names are not allowed. Will be replace with underscores.
    """

    label = "Validate Naming"
    hosts = ["photoshop"]
    order = ValidateContentsOrder
    families = ["image"]
    actions = [ValidateNamingRepair]

    # configured by Settings
    invalid_chars = ''
    replace_char = ''

    def process(self, instance):
        help_msg = ' Use Repair button to fix it and then refresh publish.'

        layer = instance.data.get("layer")
        if layer:
            msg = "Name \"{}\" is not allowed.{}".format(
                layer.clean_name, help_msg
            )
            formatting_data = {"msg": msg}
            if re.search(self.invalid_chars, layer.clean_name):
                raise PublishXmlValidationError(
                    self, msg, formatting_data=formatting_data
                )

        product_name = instance.data["productName"]
        msg = "Product \"{}\" is not allowed.{}".format(
            product_name, help_msg
        )
        formatting_data = {"msg": msg}
        if re.search(self.invalid_chars, product_name):
            raise PublishXmlValidationError(
                self, msg, formatting_data=formatting_data
            )

    @classmethod
    def get_replace_chars(cls):
        """Pass values configured in Settings for Repair."""
        return cls.invalid_chars, cls.replace_char

get_replace_chars() classmethod

Pass values configured in Settings for Repair.

Source code in client/ayon_photoshop/plugins/publish/validate_naming.py 
114
115
116
117
@classmethod
def get_replace_chars(cls):
    """Pass values configured in Settings for Repair."""
    return cls.invalid_chars, cls.replace_char

ValidateNamingRepair

Bases: Action

Repair the instance folder.

Source code in client/ayon_photoshop/plugins/publish/validate_naming.py 
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
class ValidateNamingRepair(pyblish.api.Action):
    """Repair the instance folder."""

    label = "Repair"
    icon = "wrench"
    on = "failed"
    settings_category = "photoshop"

    def process(self, context, plugin):

        # Get the errored instances
        failed = []
        for result in context.data["results"]:
            if (
                result["error"] is not None
                and result["instance"] is not None
                and result["instance"] not in failed
            ):
                failed.append(result["instance"])

        invalid_chars, replace_char = plugin.get_replace_chars()
        self.log.debug("{} --- {}".format(invalid_chars, replace_char))

        # Apply pyblish.logic to get the instances for the plug-in
        instances = pyblish.api.instances_by_plugin(failed, plugin)
        stub = photoshop.stub()
        for instance in instances:
            self.log.debug("validate_naming instance {}".format(instance))
            current_layer_state = stub.get_layer(instance.data["layer"].id)
            self.log.debug("current_layer{}".format(current_layer_state))

            layer_meta = stub.read(current_layer_state)
            instance_id = (layer_meta.get("instance_id") or
                           layer_meta.get("uuid"))
            if not instance_id:
                self.log.warning("Unable to repair, cannot find layer")
                continue

            layer_name = re.sub(invalid_chars,
                                replace_char,
                                current_layer_state.clean_name)
            layer_name = stub.PUBLISH_ICON + layer_name

            stub.rename_layer(current_layer_state.id, layer_name)

            product_name = re.sub(invalid_chars, replace_char,
                                 instance.data["productName"])

            # format from Tool Creator
            product_name = re.sub(
                "[^{}]+".format(PRODUCT_NAME_ALLOWED_SYMBOLS),
                "",
                product_name
            )

            layer_meta["productName"] = product_name
            stub.imprint(instance_id, layer_meta)

        return True