Skip to content

collect_karma_rop

CollectKarmaROPRenderProducts

Bases: HoudiniInstancePlugin

Collect Karma Render Products

Collects the instance.data["files"] for the multipart render product.

Provides

instance -> files

Source code in client/ayon_houdini/plugins/publish/collect_karma_rop.py
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
class CollectKarmaROPRenderProducts(plugin.HoudiniInstancePlugin):
    """Collect Karma Render Products

    Collects the instance.data["files"] for the multipart render product.

    Provides:
        instance    -> files

    """

    label = "Karma ROP Render Products"
    # This specific order value is used so that
    # this plugin runs after CollectFrames
    order = pyblish.api.CollectorOrder + 0.11
    families = ["karma_rop"]

    def process(self, instance):

        rop = hou.node(instance.data.get("instance_node"))

        default_prefix = evalParmNoFrame(rop, "picture")
        render_products = []

        # Default beauty AOV
        beauty_product = self.get_render_product_name(
            prefix=default_prefix, suffix=None
        )
        render_products.append(beauty_product)

        files_by_aov = {
            "beauty": self.generate_expected_files(instance,
                                                   beauty_product)
        }

        # Review Logic expects this key to exist and be True
        # if render is a multipart Exr.
        # As long as we have one AOV then multipartExr should be True.
        # By default karma render is a multipart Exr.
        instance.data["multipartExr"] = True

        filenames = list(render_products)
        instance.data["files"] = filenames

        for product in render_products:
            self.log.debug("Found render product: %s" % product)

        if "expectedFiles" not in instance.data:
            instance.data["expectedFiles"] = list()
        instance.data["expectedFiles"].append(files_by_aov)

    def get_render_product_name(self, prefix, suffix):
        product_name = prefix
        if suffix:
            # Add ".{suffix}" before the extension
            prefix_base, ext = os.path.splitext(prefix)
            product_name = "{}.{}{}".format(prefix_base, suffix, ext)

        return product_name

    def generate_expected_files(self, instance, path):
        """Create expected files in instance data"""

        dir = os.path.dirname(path)
        file = os.path.basename(path)

        if "#" in file:
            def replace(match):
                return "%0{}d".format(len(match.group()))

            file = re.sub("#+", replace, file)

        if "%" not in file:
            return path

        expected_files = []
        start = instance.data["frameStartHandle"]
        end = instance.data["frameEndHandle"]

        for i in range(int(start), (int(end) + 1)):
            expected_files.append(
                os.path.join(dir, (file % i)).replace("\\", "/"))

        return expected_files

generate_expected_files(instance, path)

Create expected files in instance data

Source code in client/ayon_houdini/plugins/publish/collect_karma_rop.py
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def generate_expected_files(self, instance, path):
    """Create expected files in instance data"""

    dir = os.path.dirname(path)
    file = os.path.basename(path)

    if "#" in file:
        def replace(match):
            return "%0{}d".format(len(match.group()))

        file = re.sub("#+", replace, file)

    if "%" not in file:
        return path

    expected_files = []
    start = instance.data["frameStartHandle"]
    end = instance.data["frameEndHandle"]

    for i in range(int(start), (int(end) + 1)):
        expected_files.append(
            os.path.join(dir, (file % i)).replace("\\", "/"))

    return expected_files