Allow disabling removal of rendered files on farm renders

With this disabled the `metadata.json` and work area renders will remain on disk after a publish even if the folder is not a persistent staging dir
This commit is contained in:
Roy Nieterau 2025-03-27 12:59:15 +01:00
parent b1fa7e5341
commit 4283d0b453
2 changed files with 26 additions and 2 deletions

View file

@ -31,6 +31,9 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin):
# Keep "filesequence" for backwards compatibility of older jobs # Keep "filesequence" for backwards compatibility of older jobs
targets = ["filesequence", "farm"] targets = ["filesequence", "farm"]
label = "Collect rendered frames" label = "Collect rendered frames"
settings_category = "core"
remove_files = True
_context = None _context = None
@ -120,7 +123,7 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin):
self._fill_staging_dir(repre_data, anatomy) self._fill_staging_dir(repre_data, anatomy)
representations.append(repre_data) representations.append(repre_data)
if not staging_dir_persistent: if self.remove_files and not staging_dir_persistent:
add_repre_files_for_cleanup(instance, repre_data) add_repre_files_for_cleanup(instance, repre_data)
instance.data["representations"] = representations instance.data["representations"] = representations
@ -170,7 +173,7 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin):
os.environ.update(session_data) os.environ.update(session_data)
staging_dir_persistent = self._process_path(data, anatomy) staging_dir_persistent = self._process_path(data, anatomy)
if not staging_dir_persistent: if self.remove_files and not staging_dir_persistent:
context.data["cleanupFullPaths"].append(path) context.data["cleanupFullPaths"].append(path)
context.data["cleanupEmptyDirs"].append( context.data["cleanupEmptyDirs"].append(
os.path.dirname(path) os.path.dirname(path)

View file

@ -925,6 +925,20 @@ class IntegrateHeroVersionModel(BaseSettingsModel):
"hero versions.") "hero versions.")
class CollectRenderedFilesModel(BaseSettingsModel):
remove_files: bool = SettingsField(
True,
title="Remove rendered files",
description=(
"Remove rendered files and metadata json on publish.\n\n"
"Note that when enabled but the render is to a configured "
"persistent staging directory the files will not be removed. "
"However with this disabled the files will **not** be removed in "
"either case."
)
)
class CleanUpModel(BaseSettingsModel): class CleanUpModel(BaseSettingsModel):
_isGroup = True _isGroup = True
paterns: list[str] = SettingsField( # codespell:ignore paterns paterns: list[str] = SettingsField( # codespell:ignore paterns
@ -1026,6 +1040,10 @@ class PublishPuginsModel(BaseSettingsModel):
default_factory=IntegrateHeroVersionModel, default_factory=IntegrateHeroVersionModel,
title="Integrate Hero Version" title="Integrate Hero Version"
) )
CollectRenderedFiles: CollectRenderedFilesModel = SettingsField(
default_factory=CollectRenderedFilesModel,
title="Clean up farm rendered files"
)
CleanUp: CleanUpModel = SettingsField( CleanUp: CleanUpModel = SettingsField(
default_factory=CleanUpModel, default_factory=CleanUpModel,
title="Clean Up" title="Clean Up"
@ -1410,6 +1428,9 @@ DEFAULT_PUBLISH_VALUES = {
], ],
"use_hardlinks": False "use_hardlinks": False
}, },
"CollectRenderedFiles": {
"remove_files": True
},
"CleanUp": { "CleanUp": {
"paterns": [], # codespell:ignore paterns "paterns": [], # codespell:ignore paterns
"remove_temp_renders": False "remove_temp_renders": False