From 67d5422c94584a100a1d3818137c4e16e06465ab Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sat, 8 Nov 2025 22:45:42 +0100 Subject: [PATCH 1/6] If folder name starts with a digit we now prefix it with `_` to avoid invalid USD data to be authored. --- client/ayon_core/pipeline/usdlib.py | 17 +++++++++++++++++ .../publish/extract_usd_layer_contributions.py | 5 +++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/usdlib.py b/client/ayon_core/pipeline/usdlib.py index 2ff98c5e45..095f6fdc57 100644 --- a/client/ayon_core/pipeline/usdlib.py +++ b/client/ayon_core/pipeline/usdlib.py @@ -684,3 +684,20 @@ def get_sdf_format_args(path): """Return SDF_FORMAT_ARGS parsed to `dict`""" _raw_path, data = Sdf.Layer.SplitIdentifier(path) return data + + +def get_standard_default_prim_name(folder_path: str) -> str: + """Return the AYON-specified default prim name for a folder path. + + This is used e.g. for the default prim in AYON USD Contribution workflows. + """ + folder_name: str = folder_path.rsplit("/", 1)[-1] + + # Prim names are not allowed to start with a digit in USD. Authoring them + # would mean generating essentially garbage data and may result in + # unexpected behavior in certain USD or DCC versions, like failure to + # refresh in usdview or crashes in Houdini 21. + if folder_name and folder_name[0].isdigit(): + folder_name = f"_{folder_name}" + + return folder_name diff --git a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py index 9db8c49a02..c73d1aa447 100644 --- a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py +++ b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py @@ -25,7 +25,8 @@ try: variant_nested_prim_path, setup_asset_layer, add_ordered_sublayer, - set_layer_defaults + set_layer_defaults, + get_standard_default_prim_name ) except ImportError: pass @@ -652,7 +653,7 @@ class ExtractUSDLayerContribution(publish.Extractor): sdf_layer = Sdf.Layer.OpenAsAnonymous(path) default_prim = sdf_layer.defaultPrim else: - default_prim = folder_path.rsplit("/", 1)[-1] # use folder name + default_prim = get_standard_default_prim_name(folder_path) sdf_layer = Sdf.Layer.CreateAnonymous() set_layer_defaults(sdf_layer, default_prim=default_prim) From 113d01ce9952762a7dafca4960f80d899bdbc395 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sat, 8 Nov 2025 22:54:24 +0100 Subject: [PATCH 2/6] Add setting to always enforce the default prim value --- .../extract_usd_layer_contributions.py | 10 +++++++++ server/settings/publish_plugins.py | 22 ++++++++++++++++--- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py index c73d1aa447..ff1c4fec8a 100644 --- a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py +++ b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py @@ -641,6 +641,7 @@ class ExtractUSDLayerContribution(publish.Extractor): settings_category = "core" use_ayon_entity_uri = False + enforce_default_prim = False def process(self, instance): @@ -651,6 +652,15 @@ class ExtractUSDLayerContribution(publish.Extractor): path = get_last_publish(instance) if path and BUILD_INTO_LAST_VERSIONS: sdf_layer = Sdf.Layer.OpenAsAnonymous(path) + + # If enabled in settings, ignore any default prim specified on + # older publish versions and always publish with the AYON + # standard default prim + if self.enforce_default_prim: + sdf_layer.defaultPrim = get_standard_default_prim_name( + folder_path + ) + default_prim = sdf_layer.defaultPrim else: default_prim = get_standard_default_prim_name(folder_path) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index ee422a0acf..60bd933344 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -251,6 +251,19 @@ class AyonEntityURIModel(BaseSettingsModel): ) +class ExtractUSDLayerContributionModel(AyonEntityURIModel): + enforce_default_prim: bool = SettingsField( + title="Always set default prim to folder name.", + description=( + "When enabled ignore any default prim specified on older " + "published versions of a layer and always override it to the " + "AYON standard default prim. When disabled, preserve default prim " + "on the layer and then only the initial version would be setting " + "the AYON standard default prim." + ) + ) + + class PluginStateByHostModelProfile(BaseSettingsModel): _layout = "expanded" # Filtering @@ -1134,9 +1147,11 @@ class PublishPuginsModel(BaseSettingsModel): default_factory=AyonEntityURIModel, title="Extract USD Asset Contribution", ) - ExtractUSDLayerContribution: AyonEntityURIModel = SettingsField( - default_factory=AyonEntityURIModel, - title="Extract USD Layer Contribution", + ExtractUSDLayerContribution: ExtractUSDLayerContributionModel = ( + SettingsField( + default_factory=ExtractUSDLayerContributionModel, + title="Extract USD Layer Contribution", + ) ) PreIntegrateThumbnails: PreIntegrateThumbnailsModel = SettingsField( default_factory=PreIntegrateThumbnailsModel, @@ -1526,6 +1541,7 @@ DEFAULT_PUBLISH_VALUES = { }, "ExtractUSDLayerContribution": { "use_ayon_entity_uri": False, + "enforce_default_prim": False, }, "PreIntegrateThumbnails": { "enabled": True, From e7896c66f3b513ae1f024259943ad4cf3f60fb09 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sun, 9 Nov 2025 11:33:33 +0100 Subject: [PATCH 3/6] Update server/settings/publish_plugins.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- server/settings/publish_plugins.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index 60bd933344..e939a6518b 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -256,7 +256,7 @@ class ExtractUSDLayerContributionModel(AyonEntityURIModel): title="Always set default prim to folder name.", description=( "When enabled ignore any default prim specified on older " - "published versions of a layer and always override it to the " + "published versions of a layer and always override it to the " "AYON standard default prim. When disabled, preserve default prim " "on the layer and then only the initial version would be setting " "the AYON standard default prim." From aea231d64e6a07258ee106ec7043967630e4e21c Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sun, 16 Nov 2025 22:20:57 +0100 Subject: [PATCH 4/6] Also prefix folder name with `_` for initializing the asset layer --- .../plugins/publish/extract_usd_layer_contributions.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py index ff1c4fec8a..4d8a8005f2 100644 --- a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py +++ b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py @@ -821,7 +821,7 @@ class ExtractUSDAssetContribution(publish.Extractor): folder_path = instance.data["folderPath"] product_name = instance.data["productName"] self.log.debug(f"Building asset: {folder_path} > {product_name}") - folder_name = folder_path.rsplit("/", 1)[-1] + asset_name = get_standard_default_prim_name(folder_path) # Contribute layers to asset # Use existing asset and add to it, or initialize a new asset layer @@ -840,7 +840,7 @@ class ExtractUSDAssetContribution(publish.Extractor): # the layer as either a default asset or shot structure. init_type = instance.data["contribution_target_product_init"] asset_layer, payload_layer = self.init_layer( - asset_name=folder_name, init_type=init_type + asset_name=asset_name, init_type=init_type ) # Author timeCodesPerSecond and framesPerSecond if the asset layer From 73dfff9191e4ba5d159d2d495c71950d60389236 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sat, 22 Nov 2025 13:28:08 +0100 Subject: [PATCH 5/6] Fix call to `get_representation_path_by_names` --- .../plugins/publish/extract_usd_layer_contributions.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py index 4d8a8005f2..ec6b2b9792 100644 --- a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py +++ b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py @@ -177,7 +177,10 @@ def get_instance_uri_path( # If for whatever reason we were unable to retrieve from the context # then get the path from an existing database entry - path = get_representation_path_by_names(**query) + path = get_representation_path_by_names( + anatomy=context.data["anatomy"], + **names + ) # Ensure `None` for now is also a string path = str(path) From 70bf746c7acac36d8cf3670843b862cf08d82537 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Sat, 22 Nov 2025 13:29:49 +0100 Subject: [PATCH 6/6] Fail clearly if the path can't be resolved instead of setting path to "None" --- .../plugins/publish/extract_usd_layer_contributions.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py index ec6b2b9792..d5c5aca0f2 100644 --- a/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py +++ b/client/ayon_core/plugins/publish/extract_usd_layer_contributions.py @@ -181,6 +181,8 @@ def get_instance_uri_path( anatomy=context.data["anatomy"], **names ) + if not path: + raise RuntimeError(f"Unable to resolve publish path for: {names}") # Ensure `None` for now is also a string path = str(path)