Chore: Add 'parents' to folder template data #778

iLLiCiTiT · 2024-07-15T13:56:30Z

Changelog Description

Add "parents" subkey to folder template data.

Additional info

This does allow to use indexing of parent names in templates. I'm not sure if this is correct approach, but it is the best I could think of. This change does not consider that someone would like to use e.g. labels instead of names in future, hopefully that won't happen.

There is no safeguard for using the list, so if the parent index is not available it will just crash. That might cause issues in specific logic which is filling template paths and does not count on this.

Testing notes:

You can use e.g. {folder[parents[0]]} in templates.
Test it with an optional template key <{folder[parents[0]}> works from a ROOT folder (does not have any parent folders).

Resolves #867

ynbot · 2024-07-15T13:56:34Z

Task linked: AY-6086 [general 0016] adding (parents[#]) to template keys

BigRoy · 2024-07-15T14:15:21Z

This does allow to use indexing of parent names in templates. I'm not sure if this is correct approach, but it is the best I could think of. This change does not consider that someone would like to use e.g. labels instead of names in future, hopefully that won't happen.

There is no safeguard for using the list, so if the parent index is not available it will just crash. That might cause issues in specific logic which is filling template paths and does not count on this.

Hmm - yeah, hmm.. this is bound to give issues. If anyone would use e.g. parents[-1] in a template and they are working in an asset that has no parents the template formatting would already fail. This seems very prone to production issues.

Can we re-iterate why parents is needed as a key and what the admin/user is expected to do with it?

jakubjezek001 · 2024-07-16T08:57:49Z

asset that has no parents the template formatting would already fail. This seems very prone to production issues.

I wonder if we could use for that reason optional decoration ...}</{folder[parents[-1]]}>/...

jakubjezek001 · 2024-07-16T09:00:41Z

BTW this seems to be very good case for unittesting.

jakubjezek001 · 2024-07-16T09:05:07Z

client/ayon_core/plugins/publish/collect_anatomy_instance_data.py

@@ -407,8 +407,10 @@ def _fill_folder_data(self, instance, project_entity, anatomy_data):
            anatomy_data["hierarchy"] = hierarchy

            parent_name = project_entity["name"]
+            parents = []


It seems valid to always have parents filled with at least project, right? Since we are converting parent_name from project name in case there is no parent at all it would be fair to also add it. In this case {folder[parent[-1]]} would always work.

I really don't think project should be there. But the use-case is that they would like to be able to use {folder[parents][0]} and {folder[parents][1]} not really -1. For -1 you can use {parent}.

I don't think project name should be there too - the reason why is that you should be explicit enough if you want to have project name there (and you can access it with another key).

So if you have asset folder directly under project, {folder[parents][0]} will not work if I am not mistaken.

So if you have asset folder directly under project, {folder[parents][0]} will not work if I am not mistaken.

Yes, it won't.

BigRoy · 2024-07-16T09:37:04Z

asset that has no parents the template formatting would already fail. This seems very prone to production issues.

I wonder if we could use for that reason optional decoration ...}</{folder[parents[-1]]}>/...

Ah - if that works I must admit that's fine then I suppose.

…plate-keys

BigRoy · 2024-07-29T09:47:45Z

So we should add to the testing notes:

Test it with an optional template key <{folder[parents[0]}> and make sure it works from a ROOT folder (no parent folders)?

LiborBatek

I have tried to incorporate it into template for render products as this:

but constantly getting errors when publish job on DL takes place after succesful render job....

see DL publish job log below:

Job_2024-07-31_15-02-09_66aa35d12c5b90b0d2104221.txt

…plate-keys

iLLiCiTiT · 2024-07-31T16:59:18Z

Something I didn't think of is output of used values which right now in StringTemplates always outputs dictionary, that has to be changed to support list.

Another issue might be negative index {folder[parents][-1]} would not work either as python formatting resolves -1 as string instead of number.

…plate-keys

iLLiCiTiT · 2024-11-21T17:45:04Z

Now it does work as expected. It is possible to use lists in values.

But negative indexes on list can cause issues when the tempalte is used out of StringTemplate so the missing piece is to change the template in result to use modified template in output {parents[-1]} should be in result template as {parents[0]} (or different index based on used values).

Or not? Not sure, at the end if anyone is willing to use the template afterwards he still have to use StringTemplate because of optional keys.

…plate-keys # Conflicts: # client/ayon_core/plugins/publish/collect_anatomy_instance_data.py

…plate-keys

antirotor · 2024-12-04T13:59:40Z

Or not? Not sure, at the end if anyone is willing to use the template afterwards he still have to use StringTemplate because of optional keys.

I don't actually think we state anywhere that templates are compatible with python formatting. So if we say that -1 isn't possible, then all is fine by me.

Auto-converting it to proper index is ofc the way too.

If I would have to choose, I'd say -> If we have interactive validator for templates in the Settings, then not supporting -1 is perfectly fine (because you'll know right away). But since we don't, conversion is better?

…plate-keys

add 'parents' to folder template data

640c24d

ynbot added size/XS type: enhancement Improvement of existing functionality or minor addition labels Jul 15, 2024

simplify split

c08d0ba

iLLiCiTiT added the sponsored This is directly sponsored by a client or community member label Jul 15, 2024

iLLiCiTiT requested review from m-u-r-p-h-y, antirotor, jakubjezek001 and LiborBatek July 15, 2024 13:58

jakubjezek001 reviewed Jul 16, 2024

View reviewed changes

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

0685cc6

…plate-keys

LiborBatek reviewed Jul 31, 2024

View reviewed changes

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

4cdd98d

…plate-keys

dee-ynput assigned iLLiCiTiT Aug 14, 2024

iLLiCiTiT marked this pull request as draft August 14, 2024 16:42

iLLiCiTiT added 4 commits November 21, 2024 18:28

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

f661808

…plate-keys

simplified parsing of template

26251bb

fill FormattingPart init

e4875cc

support list in StringTemplate

d15148f

iLLiCiTiT marked this pull request as ready for review November 21, 2024 17:39

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

7d00144

…plate-keys # Conflicts: # client/ayon_core/plugins/publish/collect_anatomy_instance_data.py

iLLiCiTiT requested a review from kalisp December 2, 2024 09:49

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

1094310

…plate-keys

antirotor and others added 4 commits December 4, 2024 15:40

Merge branch 'develop' into enhancement/AY-6086_adding-parents-to-tem…

39090ab

…plate-keys

fix 'realy' typo to 'really'

9bcc9b4

added basic typehints

a80bbfb

remove unused import

04daa93

antirotor approved these changes Dec 4, 2024

View reviewed changes

iLLiCiTiT merged commit 8580820 into develop Dec 5, 2024
3 checks passed

iLLiCiTiT deleted the enhancement/AY-6086_adding-parents-to-template-keys branch December 5, 2024 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: Add 'parents' to folder template data #778

Chore: Add 'parents' to folder template data #778

iLLiCiTiT commented Jul 15, 2024 •

edited

Loading

ynbot commented Jul 15, 2024

BigRoy commented Jul 15, 2024

jakubjezek001 commented Jul 16, 2024

jakubjezek001 commented Jul 16, 2024

jakubjezek001 Jul 16, 2024 •

edited

Loading

iLLiCiTiT Jul 16, 2024 •

edited

Loading

antirotor Jul 16, 2024

iLLiCiTiT Jul 16, 2024

BigRoy commented Jul 16, 2024

BigRoy commented Jul 29, 2024

LiborBatek left a comment

iLLiCiTiT commented Jul 31, 2024

iLLiCiTiT commented Nov 21, 2024 •

edited

Loading

antirotor commented Dec 4, 2024

Chore: Add 'parents' to folder template data #778

Chore: Add 'parents' to folder template data #778

Conversation

iLLiCiTiT commented Jul 15, 2024 • edited Loading

Changelog Description

Additional info

Testing notes:

ynbot commented Jul 15, 2024

BigRoy commented Jul 15, 2024

jakubjezek001 commented Jul 16, 2024

jakubjezek001 commented Jul 16, 2024

jakubjezek001 Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

iLLiCiTiT Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

antirotor Jul 16, 2024

Choose a reason for hiding this comment

iLLiCiTiT Jul 16, 2024

Choose a reason for hiding this comment

BigRoy commented Jul 16, 2024

BigRoy commented Jul 29, 2024

LiborBatek left a comment

Choose a reason for hiding this comment

iLLiCiTiT commented Jul 31, 2024

iLLiCiTiT commented Nov 21, 2024 • edited Loading

antirotor commented Dec 4, 2024

iLLiCiTiT commented Jul 15, 2024 •

edited

Loading

jakubjezek001 Jul 16, 2024 •

edited

Loading

iLLiCiTiT Jul 16, 2024 •

edited

Loading

iLLiCiTiT commented Nov 21, 2024 •

edited

Loading