Use product name for render templates

[antirotor]

Changelog Description

This is fixing the issue where product names for render products were hardcoded. Old behavior is enabled by default, but deprecation warning is issued. New behavior (where product name templates are used) is controlled by option in the settings:

ayon+settings://core/tools/creator/product_name_profiles/use_legacy_for_renders

Note

This is continuation and refactor of #447 - look there for previous discussions.

Additional info

Old behavior was bypassing any template set in ayon+settings://core/tools/creator/product_name_profiles. With this change, one can set template like this:

{product[type]}<{Renderlayer}><_{Aov}>

resulting in:

renderMainlayer_normal

It is up to TD to set correctly such template to make sure, product name will be stable enough. As a side-effect, optional keys can be used now in product name templates adding flexibility (and perhaps some danger of misuse).

Warning

To make use of this feature, renderlayer need to be set on the instance along with aov and is then collected to anatomy data. This is not in the scope of this PR (apart of the collection) and it must be implemented if following PRs to individual host addons.

It can be used in template formatting so you can use template for renders like:

{root[work]}/{project[name]}/{hierarchy}/{asset}/publish/{family}/{subset}/{@version}/<{renderlayer}/>

Note

Already collected anatomy data (when available) could be passed to get_product_name() to allow even more keys to be used, but is there any real use case for it?

Also, as a point for discussion - there is variant that is now ignored in this case. It could be reasonable to use it exactly for this and move templating to "variant templates" but maybe it is breaking settings to even smaller unmanagable bits.

Testing notes:

1. Set product name template to use renderlayer or aov keys (can be optional using<{key}> syntax)
2. Publish renders from DCC supporting setting of these keys (like Maya and Houdini)
3. Use {renderlayer} or {aov} in anatomy templates

Testing notes:

Main points:

a) It should behave as before without any changes.
b) When option is set in the settings, new behavior should kick-in and renders should start to use product name templates.

Testing steps:

• To test a) simply publish any render to farm. Product names of the result should stay the same as before.
• To test b), you'll need yet non-existent PRs in host addons. Stay tuned! :) - correction: with Maya it should already work.

[antirotor]

This needs to solve group_name still

[antirotor]

So I've tested it in Houdini and it works. There is one specific question about the product group names - strings that are used to group related publishes together in the UI.

So far the product group names were hardcoded - basically original hardcoded product name. This didn't include AOV names as they are added when render job is published so it correctly grouped together all renderpass AOVs. But with this PR, you can define product names with templates and so the group name itself cannot be that static. In this PR, I've made decision to explicitly "drop' aov name from the template data. So if you have product name template like so:

{product[type]}{Task[name]}<{Renderlayer}><_{Aov}>

and you have render layer called Main with beauty, diffuse and z AOVs, your resulting product names wil basically follow the previous behaviour (when you work on the task Lighting):

renderLightingMain_beauty
renderLightingMain_diffuse
renderLightingMain_z

and all of them will be grouped under renderLightingMain (because aov is not in template data and in template it is set as optional token).

But at the end, we should probably have something more robust, like templates for the group name itself. This is topic for another potential PR.

[LiborBatek]

I have tested both the legacy workflow and the templated workflow within maya and arnold renderer.

All seems working fine...my rendered files and folders follows the template and also using tokens renderlayer and aov and also for product name.

Here is my output with using those tokens within folderpath:

[antirotor]

@LiborBatek could you please test it quickly for one last time? Thanks

[LiborBatek]

All good. Tested in both legacy mode and with publishing profiles.

Here is my output folder with published renders following my publish template and also from the legacy mode.

Product names also follow these, so all good!

[BigRoy]

This description seems a bit awkward. First it states "use product naming templates for renders." but if this is enabled, it does not do that, but it does the opposite...

So the description is actually "Ignore product naming templates for renders but use a hardcoded template. This is for backwards compatibility..." etc. ?

[BigRoy]

It would be epic if somehow we can make this a hyperlink in the UI that actually links to the AYON web frontend at those settings? @dee-ynput ?

[BigRoy]

Admittedly as a user I wouldn't know 'what to do' at those settings to ensure the resolved uniqueness. Nothing critical - but if anyone gets this invalidation message I have a feeling we might start getting questions about this. Let's see what comes up.