Bases: HoudiniInstancePlugin, AYONPyblishPluginMixin
Collect Files For Cleaning Up.
This collector collects output files and adds them to file remove list.
CAUTION
This collector registers exported files and the parent folder for deletion in ExplicitCleanUp plug-in. please refer to ExplicitCleanUp's docstring for further info.
Notes
Artists are free to change the file path in the ROP node.
Farm instances will be processed on farm by other dedicated plugins that live in core addon e.g. CollectRenderedFiles plugin. These dedicated plugins don't support tracking and removing intermediate render files.
Local Render instances don't track intermediate render files, Therefore, this plugin doesn't support removing intermediate render files.
HDA is not added to this plugin's options in server settings. Cleaning up HDA products will break the scene as Houdini will no longer be able to find the HDA file. In addition,HDA plugins always save HDAs to external files. Therefore, Cleaning up HDA products will break the ability to go back to the workfile and continue on the HDA.
Source code in client/ayon_houdini/plugins/publish/collect_files_for_cleaning_up.py
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 | class CollectFilesForCleaningUp(plugin.HoudiniInstancePlugin,
AYONPyblishPluginMixin):
"""Collect Files For Cleaning Up.
This collector collects output files and adds them to file remove list.
CAUTION:
This collector registers exported files and
the parent folder for deletion in `ExplicitCleanUp` plug-in.
please refer to `ExplicitCleanUp`'s docstring for further info.
Notes:
Artists are free to change the file path in the ROP node.
Farm instances will be processed on farm by other dedicated plugins
that live in core addon e.g. `CollectRenderedFiles` plugin.
These dedicated plugins don't support tracking and removing
intermediate render files.
Local Render instances don't track intermediate render files,
Therefore, this plugin doesn't support removing
intermediate render files.
HDA is not added to this plugin's options in server settings.
Cleaning up HDA products will break the scene as Houdini will no longer
be able to find the HDA file.
In addition,HDA plugins always save HDAs to external files.
Therefore, Cleaning up HDA products will break the ability to go back
to the workfile and continue on the HDA.
"""
# It should run after CollectFrames and Collect Render plugins,
# and before CollectLocalRenderInstances.
order = pyblish.api.CollectorOrder + 0.115
hosts = ["houdini"]
families = ["*"]
label = "Collect Files For Cleaning Up"
def process(self, instance):
if instance.data.get("farm"):
self.log.debug("Should be processed on farm, skipping.")
return
files: List[str] = []
staging_dirs: List[str] = []
expected_files = instance.data.get("expectedFiles", [])
# Prefer 'expectedFiles' over 'frames' because it usually contains more
# output files than just a single file or single sequence of files.
if expected_files:
# Products with expected files
# This can be Render products or submitted cache to farm.
for expected in expected_files:
# expected.values() is a list of lists
for output_files in expected.values():
staging_dir, _ = os.path.split(output_files[0])
if staging_dir not in staging_dirs:
staging_dirs.append(staging_dir)
files.extend(output_files)
else:
# Products with frames or single file.
frames = instance.data.get("frames")
if frames is None:
self.log.warning(
f"No frames data found on instance {instance}"
". Skipping collection for caching on farm..."
)
return
staging_dir = instance.data.get("stagingDir")
staging_dirs.append(staging_dir)
if isinstance(frames, str):
# single file.
files.append(f"{staging_dir}/{frames}")
else:
# list of frame.
files.extend(
[f"{staging_dir}/{frame}" for frame in frames]
)
self.log.debug(
f"Add directories to 'cleanupEmptyDir': {staging_dirs}")
instance.context.data["cleanupEmptyDirs"].extend(staging_dirs)
self.log.debug("Add files to 'cleanupFullPaths': {}".format(files))
instance.context.data["cleanupFullPaths"].extend(files)
|