Skip to content

collect_sequences_from_job

Collect sequences from Royal Render Job.

CollectSequencesFromJob

Bases: ContextPlugin

Gather file sequences from job directory.

When "AYON_PUBLISH_DATA" environment variable is set these paths (folders or .json files) are parsed for image sequences. Otherwise, the current working directory is searched for file sequences.

Source code in client/ayon_royalrender/plugins/publish/collect_sequences_from_job.py
 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
class CollectSequencesFromJob(pyblish.api.ContextPlugin):
    """Gather file sequences from job directory.

    When "AYON_PUBLISH_DATA" environment variable is set these paths
    (folders or .json files) are parsed for image sequences. Otherwise, the
    current working directory is searched for file sequences.

    """

    order = pyblish.api.CollectorOrder
    targets = ["rr_control"]
    label = "Collect Rendered Frames"
    settings_category = "royalrender"
    review = True

    def process(self, context):
        self.review = context.data["project_settings"]["royalrender"][
            "publish"
        ]["CollectSequencesFromJob"]["review"]

        self.review = (
            context.data
            ["project_settings"]
            ["royalrender"]
            ["publish"]
            ["CollectSequencesFromJob"]
            ["review"]
        )

        publish_data_paths = os.environ.get("AYON_PUBLISH_DATA")

        if publish_data_paths:
            self.log.debug(publish_data_paths)
            paths = publish_data_paths.split(os.pathsep)
            self.log.info("Collecting paths: {}".format(paths))
        else:
            cwd = context.get("workspaceDir", os.getcwd())
            paths = [cwd]

        for path in paths:

            self.log.info("Loading: {}".format(path))

            if path.endswith(".json"):
                # Search using .json configuration
                with open(path, "r") as f:
                    try:
                        data = json.load(f)
                    except Exception as exc:
                        self.log.error("Error loading json: "
                                       "{} - Exception: {}".format(path, exc))
                        raise

                cwd = os.path.dirname(path)
                root_override = data.get("root")
                if root_override:
                    if os.path.isabs(root_override):
                        root = root_override
                    else:
                        root = os.path.join(cwd, root_override)
                else:
                    root = cwd

                metadata = data.get("metadata")
                if metadata:
                    session = metadata.get("session")
                    if session:
                        self.log.info("setting session using metadata")
                        os.environ.update(session)

            else:
                # Search in directory
                data = {}
                root = path

            self.log.info("Collecting: {}".format(root))
            regex = data.get("regex")
            if regex:
                self.log.info("Using regex: {}".format(regex))

            collections = collect(root=root,
                                  regex=regex,
                                  exclude_regex=data.get("exclude_regex"),
                                  frame_start=data.get("frameStart"),
                                  frame_end=data.get("frameEnd"))

            self.log.info("Found collections: {}".format(collections))

            if data.get("productName") and len(collections) > 1:
                self.log.error("Forced produce can only work with a single "
                               "found sequence")
                raise RuntimeError("Invalid sequence")

            fps = data.get("fps", 25)

            # Get family from the data
            families = data.get("families", ["render"])
            if "render" not in families:
                families.append("render")
            if "ftrack" not in families:
                families.append("ftrack")
            if "review" not in families and self.review:
                self.log.info("attaching review")
                families.append("review")

            for collection in collections:
                instance = context.create_instance(str(collection))
                self.log.info("Collection: %s" % list(collection))

                # Ensure each instance gets a unique reference to the data
                data = copy.deepcopy(data)

                # If no product provided, get it from collection's head
                product_name = (
                    data.get("productName", collection.head.rstrip("_. "))
                )

                # If no start or end frame provided, get it from collection
                indices = list(collection.indexes)
                start = data.get("frameStart", indices[0])
                end = data.get("frameEnd", indices[-1])

                ext = list(collection)[0].split('.')[-1]

                instance.data.update({
                    "name": str(collection),
                    "productType": families[0],
                    "family": families[0],
                    "families": list(families),
                    "productName": product_name,
                    "folderPath": data.get(
                        "folderPath", context.data["folderPath"]
                    ),
                    "stagingDir": root,
                    "frameStart": start,
                    "frameEnd": end,
                    "fps": fps,
                    "source": data.get('source', '')
                })
                instance.append(collection)
                instance.context.data['fps'] = fps

                if "representations" not in instance.data:
                    instance.data["representations"] = []

                representation = {
                    'name': ext,
                    'ext': '{}'.format(ext),
                    'files': list(collection),
                    "frameStart": start,
                    "frameEnd": end,
                    "stagingDir": root,
                    "anatomy_template": "render",
                    "fps": fps,
                    "tags": ['review']
                }
                instance.data["representations"].append(representation)

                if data.get('user'):
                    context.data["user"] = data['user']

                self.log.debug("Collected instance:\n"
                               "{}".format(pformat(instance.data)))

collect(root, regex=None, exclude_regex=None, frame_start=None, frame_end=None)

Collect sequence collections in root

Source code in client/ayon_royalrender/plugins/publish/collect_sequences_from_job.py
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
def collect(root,
            regex=None,
            exclude_regex=None,
            frame_start=None,
            frame_end=None):
    """Collect sequence collections in root"""

    import clique

    files = []
    for filename in os.listdir(root):

        # Must have extension
        ext = os.path.splitext(filename)[1]
        if not ext:
            continue

        # Only files
        if not os.path.isfile(os.path.join(root, filename)):
            continue

        # Include and exclude regex
        if regex and not re.search(regex, filename):
            continue
        if exclude_regex and re.search(exclude_regex, filename):
            continue

        files.append(filename)

    # Match collections
    # Support filenames like: projectX_shot01_0010.tiff with this regex
    pattern = r"(?P<index>(?P<padding>0*)\d+)\.\D+\d?$"
    collections, remainder = clique.assemble(files,
                                             patterns=[pattern],
                                             minimum_items=1)

    # Ignore any remainders
    if remainder:
        print("Skipping remainder {}".format(remainder))

    # Exclude any frames outside start and end frame.
    for collection in collections:
        for index in list(collection.indexes):
            if frame_start is not None and index < frame_start:
                collection.indexes.discard(index)
                continue
            if frame_end is not None and index > frame_end:
                collection.indexes.discard(index)
                continue

    # Keep only collections that have at least a single frame
    collections = [c for c in collections if c.indexes]

    return collections