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 | class CleanUp(pyblish.api.InstancePlugin):
"""Cleans up the staging directory after a successful publish.
This will also clean published renders and delete their parent directories.
"""
order = pyblish.api.IntegratorOrder + 10
label = "Clean Up"
hosts = [
"aftereffects",
"blender",
"celaction",
"flame",
"fusion",
"harmony",
"hiero",
"houdini",
"maya",
"nuke",
"photoshop",
"resolve",
"tvpaint",
"unreal",
"webpublisher",
"shell"
]
settings_category = "core"
exclude_families = ["clip"]
optional = True
active = True
# Presets
patterns = None # list of regex patterns
remove_temp_renders = True
def process(self, instance):
"""Plugin entry point."""
if is_in_tests():
# let automatic test process clean up temporary data
return
# If instance has errors, do not clean up
for result in instance.context.data["results"]:
if result["error"] is not None and result["instance"] is instance:
raise PublishError(
"Result of '{}' instance were not success".format(
instance.data["name"]
)
)
_skip_cleanup_filepaths = instance.context.data.get(
"skipCleanupFilepaths"
) or []
skip_cleanup_filepaths = set()
for path in _skip_cleanup_filepaths:
skip_cleanup_filepaths.add(os.path.normpath(path))
if self.remove_temp_renders:
self.log.debug("Cleaning renders new...")
self.clean_renders(instance, skip_cleanup_filepaths)
# TODO: Figure out whether this could be refactored to just a
# product_type in self.exclude_families check.
product_type = instance.data["productType"]
if any(
product_type in exclude_family
for exclude_family in self.exclude_families
):
self.log.debug(
"Skipping cleanup for instance because product "
f"type is excluded from cleanup: {product_type}")
return
temp_root = tempfile.gettempdir()
staging_dir = instance.data.get("stagingDir", None)
if not staging_dir:
self.log.debug("Skipping cleanup. Staging dir not set "
"on instance: {}.".format(instance))
return
if not os.path.normpath(staging_dir).startswith(temp_root):
self.log.debug("Skipping cleanup. Staging directory is not in the "
"temp folder: %s" % staging_dir)
return
if not os.path.exists(staging_dir):
self.log.debug("No staging directory found at: %s" % staging_dir)
return
if instance.data.get("stagingDir_persistent"):
self.log.debug(
"Staging dir {} should be persistent".format(staging_dir)
)
return
self.log.debug("Removing staging directory {}".format(staging_dir))
shutil.rmtree(staging_dir)
def clean_renders(self, instance, skip_cleanup_filepaths):
transfers = instance.data.get("transfers", list())
instance_families = instance.data.get("families", list())
instance_product_type = instance.data.get("productType")
dirnames = []
transfers_dirs = []
for src, dest in transfers:
# fix path inconsistency
src = os.path.normpath(src)
dest = os.path.normpath(dest)
# add src dir into clearing dir paths (regex patterns)
transfers_dirs.append(os.path.dirname(src))
# add dest dir into clearing dir paths (regex patterns)
transfers_dirs.append(os.path.dirname(dest))
if src in skip_cleanup_filepaths:
self.log.debug((
"Source file is marked to be skipped in cleanup. {}"
).format(src))
continue
if os.path.normpath(src) == os.path.normpath(dest):
continue
if (
instance_product_type == "render"
or "render" in instance_families
):
self.log.info("Removing src: `{}`...".format(src))
try:
os.remove(src)
except PermissionError:
self.log.warning(
"Insufficient permission to delete {}".format(src)
)
continue
# add dir for cleanup
dirnames.append(os.path.dirname(src))
# clean by regex patterns
# make unique set
transfers_dirs = set(transfers_dirs)
self.log.debug("__ transfers_dirs: `{}`".format(transfers_dirs))
self.log.debug("__ self.patterns: `{}`".format(self.patterns))
if self.patterns:
files = list()
# get list of all available content of dirs
for _dir in transfers_dirs:
if not os.path.exists(_dir):
continue
files.extend([
os.path.join(_dir, f)
for f in os.listdir(_dir)])
self.log.debug("__ files: `{}`".format(files))
# remove all files which match regex pattern
for f in files:
if os.path.normpath(f) in skip_cleanup_filepaths:
continue
for p in self.patterns:
pattern = re.compile(p)
if not pattern.findall(f):
continue
if not os.path.exists(f):
continue
self.log.info("Removing file by regex: `{}`".format(f))
os.remove(f)
# add dir for cleanup
dirnames.append(os.path.dirname(f))
# make unique set
cleanup_dirs = set(dirnames)
# clean dirs which are empty
for dir in cleanup_dirs:
try:
os.rmdir(dir)
except OSError:
# directory is not empty, skipping
continue
|