This repository was archived by the owner on Mar 5, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathimagepath.py
More file actions
572 lines (473 loc) · 19.4 KB
/
Copy pathimagepath.py
File metadata and controls
572 lines (473 loc) · 19.4 KB
1
2
3
4
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
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
#!/usr/bin/env python
# Copyright 2019 Wilfried Pollan
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# # http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
file=imagepath.py
Seperate image into parts.
Get image values
Get/Set base name
Get/Set frame
Get/Set version
"""
__version__ = '3.0.0'
__author__ = 'Wilfried Pollan'
# MODULES
import os.path
import re
class Image(object):
"""
Manipulates vfx image values
"""
IMAGE = None
IMAGE_DICT = None
def __init__(self, image=None):
"""
Init the inage class.
It sets up all basic variables for the input image.
:params image: path to an image file
:type image: str
"""
# Init internal vars
self.image_path = None
self.image_name = None
self.name = None
self.ext = None
# Assign init parm
self.IMAGE = image
# Assign internal vars
self._get_basic_parts()
# private vars
self._name_list = self._split_name()
# Assign global class vars
self.IMAGE_DICT = self.get_image_values()
# REGEX FUNCTIONS
def _regex_version(self):
"""
Create version regex string.
:return: re_major_version, re_prefix_major_version,
re_prefix_major_minor_version
:rtype: tuple(str)
"""
re_major_version = r'^([v|V])(\d+)'
re_prefix_major_version = r'([.|_|-])([v|V])(\d+)*'
re_prefix_major_minor_version = r'([.|_|-])([v|V])(\d+)([.|_|-])(\d+)'
return (re_major_version, re_prefix_major_version,
re_prefix_major_minor_version)
def _regex_frame(self):
"""
Create frame regex string
:return: re_frame, re_frame_only
:rtype: tuple(str)
"""
re_frame = r'([.|_|-])((\d+)|(%0\dd)|(#+))\Z'
re_frame_only = r'^((\d+)|(%0\dd)|(#+))\Z'
return re_frame, re_frame_only
def _re_compile_version(self):
"""
Compile re version object.
:return: re_major_version, re_prefix_major_version,
re_prefix_major_minor_version
:rtype: tuple(re object)
"""
re_major_version = re.compile(self._regex_version()[0])
re_prefix_major_version = re.compile(self._regex_version()[1])
re_prefix_major_minor_version = re.compile(self._regex_version()[2])
return (re_major_version, re_prefix_major_version,
re_prefix_major_minor_version)
def _re_compile_frame(self):
"""
Compile re frame object.
:return: re_frame, re_frame_only
:rtype: tuple(re object)
"""
re_frame = re.compile(self._regex_frame()[0])
re_frame_only = re.compile(self._regex_frame()[1])
return re_frame, re_frame_only
# HELPER FUNCTIONS
def _set_padded_number(self, number, padding):
"""
Set padded number.
:params number:
:type number: int
:params padding:
:type padding: int
:return: padded number string
:rtype: str
"""
return '%0{}d'.format(padding) % number
# FUNCTIONS
def _get_basic_parts(self):
"""
Get path, name, ext
:return: [dirname, name, ext]
:rtype: list(str)
"""
self.image_path = os.path.dirname(self.IMAGE)
self.image_name = os.path.basename(self.IMAGE)
self.name, self.ext = os.path.splitext(self.image_name)
def _split_name(self):
"""
Split image into base name, prefix & frame part
:return: [basename, frame_prefix, frame]
or if frame_parts=True:
[basename, frame_prefix, frame,
frame_digit, frame_notation, frame_hash]
:rtype: list
"""
re_frame, re_frame_only = self._re_compile_frame()
self._get_basic_parts()
name_list = []
try:
name_list = re_frame.split(self.name)
if len(name_list) == 1:
name_list = re_frame_only.split(self.name)
if len(name_list) > 1:
name_list.insert(0, None)
else:
name_list.extend([None, None])
name_list = name_list[:6]
except IndexError:
pass
name_list = [None if v is '' else v for v in name_list]
return name_list
def get_b_name(self):
"""
Get image base name.
:return: base name
:rtype: str
"""
return self._name_list[0]
def set_b_name(self, new_name):
"""
Set image base name.
:params new_name: base name to use for the rename
:type new_name: str
:return: image
:rtype: str
"""
name_list = self._name_list
name_list = ['' if v is None else v for v in name_list]
new_name = new_name + ''.join(name_list[1:3])
self.IMAGE = os.path.join(self.image_path, new_name) + self.ext
self._name_list = self._split_name()
return self.IMAGE
def get_frame(self):
"""
Get image frame values.
Option name=True adds name value pair to dict.
:return: frame_dict = {'frame_prefix': frame_prefix,
'frame': frame,
'frame_padding': padding,
'frame_digit': frame_digit,
'frame_notation':frame_notation,
'frame_hash': frame_hash
}
:rtype: dict
"""
frame_prefix, frame = None, None
frame_digit, frame_notation, frame_hash = None, None, None
if self._name_list[2]:
frame_prefix = self._name_list[1]
frame = self._name_list[2]
frame_digit = self._name_list[3]
frame_notation = self._name_list[4]
frame_hash = self._name_list[5]
# GET FRAME PADDING
padding = None
if frame_digit:
padding = len(frame)
elif frame_notation:
padding = int(frame_notation[2])
elif frame_hash:
padding = len(frame_hash)
# FRAME NOTATION, HASH
if padding:
if frame:
frame_notation = '%0' + str(padding) + 'd'
frame_hash = '#' * padding
elif frame_notation:
frame_hash = '#' * padding
elif frame_hash:
frame_notation = '%0' + str(padding) + 'd'
frame_dict = {'frame_prefix': frame_prefix,
'frame': frame,
'frame_padding': padding,
'frame_digit': frame_digit,
'frame_notation':frame_notation,
'frame_hash': frame_hash
}
return frame_dict
def set_frame(self, new_frame, prefix=None):
"""
Set image frame value. Can also set the prefix if given.
:params new_frame: new frame number
:type new_frame: str
:params prefix: character to use before the frame e.g. _
:type prefix: str
:return: image
:rtype: str
"""
new_frame = str(new_frame)
re_frame, re_frame_only = self._re_compile_frame()
name_list = self._name_list
# Check input values
parm = None
value = None
if not re_frame_only.search(new_frame):
parm = 'new_frame'
value = new_frame
error_msg = '{} \"{}\" must be given as frame hash/frame,\
notation/digit.'.format(parm, value)
raise ValueError(error_msg)
elif prefix and not isinstance(prefix, str):
parm = 'prefix'
value = str(prefix)
error_msg = '{} \"{}\" must be given as string.'.format(parm, value)
raise ValueError(error_msg)
# CONVERT NONE TO EMPTY STRING
name_list = ['' if v is None else v for v in name_list]
frame_prefix = None
if name_list[1]:
frame_prefix = name_list[1]
elif prefix:
frame_prefix = prefix
else:
frame_prefix = ''
# Assign with existing frame
self.name = name_list[0] + frame_prefix + new_frame
self.IMAGE = os.path.join(self.image_path, self.name) + self.ext
# Replace values in internal var
self._name_list = self._split_name()
self.IMAGE_DICT = self.get_image_values()
return self.IMAGE
def get_version(self, major_minor=False):
"""
Get all version strings.
:params major_minor: Set to True if the image is using two style version
convention; default to False
:type major_minor: bool
:return: version_dict = {'version_folder_level': version_folder_level,
'version_folder_prefix': version_folder_prefix,
'version_folder': version_folder,
'version_prefix': version_prefix,
'version': version,
'version_sep': version_sep
}
:rtype: dict
"""
re_version_all = self._re_compile_version()
re_version_only = re_version_all[0]
re_version = re_version_all[1]
re_major_minor_version = re_version_all[2]
version_folder_prefix = None
version_folder = None
version_prefix = None
version = None
version_sep = None
def get_version_result(value):
"""
Inside method fetching version from input value.
:param value: image base name
:type value: str
:return: version_prefix, version
:rtype: tuple(str)
"""
re_version_result = re_version.search(value)
version_prefix = ''.join(re_version_result.group(1, 2))
version = re_version_result.group(3)
return version_prefix, version
def get_version_only_result(value):
"""
Inside method fetching version from input value
if the name may only consist of the version.
:param value: image base name
:type value: str
:return: version_prefix, version
:rtype: tuple(str)
"""
re_version_result = re_version_only.search(value)
version_prefix = re_version_result.group(1)
version = re_version_result.group(2)
return version_prefix, version
# Get file version
if major_minor:
try:
re_version_result_image = re_major_minor_version.search(self.name)
version_prefix = ''.join(re_version_result_image.group(1, 2))
version = re_version_result_image.group(3, 5)
version_sep = re_version_result_image.group(4)
except AttributeError:
pass
else:
try:
version_prefix, version = get_version_result(self.name)
except AttributeError:
try:
version_prefix, version = get_version_only_result(self.name)
except AttributeError:
pass
# Get folder version
level = 1
while level < len(self.image_path.split(os.sep))-1:
image_folder = self.image_path.split(os.sep)[-level]
try:
version_folder_prefix, version_folder = get_version_result(image_folder)
except AttributeError:
try:
version_folder_prefix, version_folder = get_version_only_result(image_folder)
except AttributeError:
pass
if version_folder:
break
level += 1
if not version_folder:
level = None
version_dict = {'version_folder_level': level,
'version_folder_prefix': version_folder_prefix,
'version_folder': version_folder,
'version_prefix': version_prefix,
'version': version,
'version_sep': version_sep
}
return version_dict
def set_version(self, new_version, set_folder=True, major_minor=False,
prefix=None, sep=None):
"""
Set the given version.
:params new_version: version as a string without the prefix
:type new_version: str
:params set_folder: Set the version in the folder
:type set_folder: bool
:params major_minor: Set to True if the version is using
major, minor version style
:type major_minor: bool
:params prefix: character to use before the version
:type prefix: str
:params sep: separator to use for major, minor version style
:type sep: str
:return: image
:rtype: str
"""
# Init self.regex
re_version_all = self._re_compile_version()
re_version_only = re_version_all[0]
re_version = re_version_all[1]
re_major_minor_version = re_version_all[2]
# Get current version
version_dict = self.get_version(major_minor)
version_folder_level = version_dict['version_folder_level']
version_folder_prefix = version_dict['version_folder_prefix']
version_folder = version_dict['version_folder']
version_prefix = version_dict['version_prefix']
version = version_dict['version']
version_sep = version_dict['version_sep']
if version_folder_level > 1:
folder_split = self.image_path.split(os.sep)
image_root = os.sep.join(folder_split[:-(version_folder_level)])
image_folder = folder_split[-version_folder_level]
sub_folder = os.sep.join(folder_split[-(version_folder_level-1):])
else:
image_root = os.path.dirname(self.image_path)
image_folder = os.path.basename(self.image_path)
sub_folder = ''
# Assign input parameter
if prefix:
version_prefix = prefix
if version_folder_prefix:
version_folder_prefix = prefix
if sep:
version_sep = sep
# Set version
try:
# Set version in file
if version:
if major_minor:
if isinstance(new_version, (list, tuple)):
sub_major = version_prefix + str(new_version[0])
sub_minor = version_sep + str(new_version[1])
substition = sub_major + sub_minor
self.name = re_major_minor_version.sub(substition, self.name)
else:
substition = version_prefix + str(new_version)
self.name = re_major_minor_version.sub(substition, self.name)
else:
if re_version.search(self.name):
substition = version_prefix + str(new_version)
self.name = re_version.sub(substition, self.name)
elif re_version_only.search(self.name):
substition = version_prefix + str(new_version)
self.name = re_version_only.sub(substition, self.name)
# Set version in folder
if set_folder:
if isinstance(new_version, (list, tuple)):
new_version = new_version[0]
if version_folder:
if re_version.search(image_folder):
substition = version_folder_prefix + str(new_version)
image_folder = re_version.sub(substition, image_folder)
elif re_version_only.search(image_folder):
substition = version_folder_prefix + str(new_version)
image_folder = re_version_only.sub(substition, image_folder)
# Generate image string
self.image_path = os.path.join(image_root, image_folder, sub_folder)
self.IMAGE = os.path.join(self.image_path, self.name) + self.ext
self._name_list = self._split_name()
return self.IMAGE
except (AttributeError, TypeError) as err:
error_msg = 'Wrong input. Error: {}'.format(err)
raise ValueError(error_msg)
def get_image_values(self, major_minor=False):
"""
Get all image part values.
:params major_minor: Set to True if the version is using
major, minor version style
:type major_minor: bool
:return: image_dict = {'path': image_path,
'name': b_name,
'ext': ext,
'version_folder_level': version_folder_level,
'version_folder_prefix': version_folder_prefix,
'version_folder': version_folder,
'version_prefix': version_prefix,
'version': version,
'version_sep': version_sep,
'frame_prefix': frame_prefix,
'frame': frame,
'frame_padding': padding,
'frame_notation': frame_notation,
'frame_hash': frame_hash
}
:rtype: dict
"""
# FRAME
frame_dict = self.get_frame()
# VERSION
version_dict = self.get_version(major_minor)
# GENERATE IMAGE DICT
image_dict = {'path': self.image_path,
'name': self._name_list[0],
'ext': self.ext,
'version_folder_level': version_dict['version_folder_level'],
'version_folder_prefix': version_dict['version_folder_prefix'],
'version_folder': version_dict['version_folder'],
'version_prefix': version_dict['version_prefix'],
'version': version_dict['version'],
'version_sep': version_dict['version_sep'],
'frame_prefix': frame_dict['frame_prefix'],
'frame': frame_dict['frame'],
'frame_padding': frame_dict['frame_padding'],
'frame_notation': frame_dict['frame_notation'],
'frame_hash': frame_dict['frame_hash']
}
return image_dict