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
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282 | class TextureCreator(TrayPublishCreator):
"""Creates texture instances from files, supporting UDIM sequences."""
identifier = "io.ayon.creators.traypublisher.texture"
label = "Texture"
product_type = "texture"
icon = "fa.file"
description = "Texture files or UDIM sequences"
extensions = [".mov", ".mp4", ".mxf", ".m4v", ".mpg", ".exr",
".dpx", ".tif", ".png", ".jpg"]
def get_detail_description(self):
return inspect.cleandoc("""# Textures
This will create a publish instances for textures, that is
either a single image, a sequence of UDIM tiles or multiple sets of
textures (each either UDIMs or single image) - like
diffuse+normal+roughness maps combined.
This can be used to quickly create publish instances for a set of files
where the filenames then define the variant names. For example, using
a texture set:
- asset_diffuse.1001-1004.exr
- asset_specular.1001-1004.exr
Which then creates `diffuse` and `specular` variant textures as a
result.
""")
def create(self, product_name, instance_data, pre_create_data):
# TODO: Allow processing single sequence without complex logic?
folder_path: str = instance_data["folderPath"]
task_name: Optional[str] = instance_data.get("task")
folder_entity = self.create_context.get_folder_entity(folder_path)
task_entity = self.create_context.get_task_entity(folder_path,
task_name)
# Gather inputs
file_paths = pre_create_data.get("representation_files", [])
strip_common_prefix: bool = pre_create_data.pop(
"strip_common_prefix", False)
strip_common_suffix: bool = pre_create_data.pop(
"strip_common_suffix", False)
prefix = pre_create_data.pop("prefix", "")
suffix = pre_create_data.pop("suffix", "")
variant_name_method: str = pre_create_data.pop("variant_name",
"filename")
# All files
files = []
for file_info in file_paths:
files.extend(file_info["filenames"])
# Find common prefix and suffix in input filenames
common_prefix = ""
common_suffix = ""
if len(file_paths) > 1:
# Only consider stripping start/end if there are multiple
# files to compare
if strip_common_prefix:
common_prefix = os.path.commonprefix(files)
self.log.debug("Found common prefix: %s", common_prefix)
if strip_common_suffix:
common_suffix = os.path.commonprefix(
[fname[::-1] for fname in files]
)[::-1] # find reversed common prefix
self.log.debug("Found common suffix: %s", common_suffix)
# Process the filepaths to individual instances
for file_info in file_paths:
filenames = file_info["filenames"]
# clique.PATTERNS["frames"] but also allow `_` before digits
pattern = r"[._](?P<index>(?P<padding>0*)\d+)\.\D+\d?$"
collections, remainder = clique.assemble(
filenames,
minimum_items=1,
assume_padded_when_ambiguous=True,
patterns=[pattern],
)
if collections:
if len(collections) != 1:
raise CreatorError(
"Expected exactly one collection, "
f"but found {len(collections)}."
)
basename = collections[0].head.rstrip("._")
else:
if len(remainder) != 1:
raise CreatorError(
"Expected exactly one remaining file, "
f"but found {len(remainder)}."
)
basename = os.path.splitext(remainder[0])[0]
if strip_common_prefix:
# Remove common prefix from the variant name
basename = basename.removeprefix(common_prefix)
if strip_common_suffix:
# Remove common suffix from the variant name
basename = basename.removesuffix(common_suffix)
if variant_name_method == "filename":
# Use the filename as the variant name
variant = basename
elif variant_name_method == "variant":
variant = instance_data["variant"]
elif variant_name_method == "filename_rsplit_underscore":
# Use the filename after the last underscore as the
# variant name. (Note that we stripped any underscore before
# the UDIM tile/sequence number already).
variant = basename.rsplit("_", 1)[-1]
else:
raise ValueError(
f"Unknown variant name method: {variant_name_method}"
)
# Apply variant prefix/suffix if specified
variant = f"{prefix}{variant}{suffix}"
# Create instance
product_name = self.get_product_name(
self.project_name,
folder_entity,
task_entity,
variant,
host_name=self.host_name,
)
_pre_create_data = copy.deepcopy(pre_create_data)
_pre_create_data["representation_files"] = file_info
_instance_data = copy.deepcopy(instance_data)
_instance_data["variant"] = variant
self._create_instance(
product_name=product_name,
instance_data=_instance_data,
pre_create_data=_pre_create_data
)
def _create_instance(self, product_name, instance_data, pre_create_data):
repr_file = pre_create_data.get("representation_files")
if not repr_file:
raise CreatorError("No files specified")
# Pass pre-create attributes to instance creator attributes
instance_data["creator_attributes"] = pre_create_data
# Trigger the dedicated `texture_creator` collector plug-in
instance_data.setdefault("families", []).append("texture_creator")
# Create new instance
new_instance = CreatedInstance(self.product_type, product_name,
instance_data, self)
self._store_new_instance(new_instance)
def _get_udim_attr_def(self) -> BoolDef:
return BoolDef(
"is_udim",
default=True,
label="UDIM",
tooltip=(
"Define whether the input files are a UDIM sequence "
"instead of frame range sequence.\n"
"This is only relevant if the input files is a sequence "
"of files."
)
)
def _get_review_attr_def(self) -> BoolDef:
return BoolDef(
"add_review_family",
default=True,
label="Review"
)
def get_instance_attr_defs(self):
return [
FileDef(
"representation_files",
folders=False,
extensions=self.extensions,
allow_sequences=True,
single_item=True,
label="Representation",
),
self._get_review_attr_def(),
self._get_udim_attr_def(),
]
def get_pre_create_attr_defs(self):
return [
FileDef(
"representation_files",
folders=False,
extensions=self.extensions,
allow_sequences=True,
single_item=False,
label="Representations",
),
self._get_review_attr_def(),
self._get_udim_attr_def(),
UISeparatorDef("_additionals"),
UILabelDef("<b>Variant Name Options</b>"),
EnumDef(
"variant_name",
items=[
{"value": "variant", "label": "Use variant name"},
{"value": "filename", "label": "Use filename"},
{"value": "filename_rsplit_underscore", "label": "Use filename (after last underscore)"},
],
default="filename",
label="Variant Naming",
tooltip=(
"Because this Creator supports multiple textures sets at "
"once to be created into separate instances, we will "
"parse the filenames to determine the variant names."
)
),
BoolDef(
"strip_common_prefix",
default=False,
label="Strip Common Prefix",
tooltip=(
"Remove common prefix from the variant name.\n\n"
"This is useful when publishing a batch of textures "
"for an asset that all start with the asset name.\n"
"By stripping the common prefix, the variant name will "
"then exclude the asset name."
)
),
BoolDef(
"strip_common_suffix",
default=False,
label="Strip Common Suffix",
tooltip=(
"Remove common suffix from the variant name.\n\n"
"This is useful when publishing a batch of files "
"that all end with a similar suffix.\n"
"By stripping the common suffix, the variant name will "
"then exclude that part."
)
),
TextDef(
"prefix",
default="",
label="Add prefix",
tooltip=(
"Add a common prefix to all variant names."
)
),
TextDef(
"suffix",
default="",
label="Add suffix",
tooltip=(
"Add a common suffix to all variant names."
)
),
]
|