Maya: Build workfile by template

[ClementHector]

Brief description

Following discussion #2013 and resumption of work from ellipsanime #2202

Templated Build Workfile

Building a workfile using a template designed by users. Helping to assert homogeneous subsets hierarchy and imports. Template stored as file easy to define, change and customize for production needs.

1. Make a template

Make your template. Add families and everything needed for your tasks. Here is an example template for the modeling task using a placeholder to import a gauge.

If needed, you can add placeholders when the template needs to load some assets. OpenPype > Template Builder > Create Placeholder

• Configure placeholders

Fill in the necessary fields (the optional fields are regex filters)

- Builder type: Wether the the placeholder should load current asset representations or linked assets representations

- Representation: Representation that will be loaded (ex: ma, abc, png, etc...)

- Family: Family of the representation to load (main, look, image, etc ...)

- Loader: Placeholder loader name that will be used to load corresponding representations

- Order: Priority for current placeholder loader (priority is lowest first, highet last)

• Save your template

2. Configure Template

• Go to Studio settings > Project > Your DCC > Templated Build Settings
• Add a profile for your task and enter path to your template

3. Build your workfile

• Open maya

• Build your workfile

[tokejepsen]

Exciting stuff!

Should we have a task name regex for the profile, so we can be flexible with tasks of the same type but different names?

[ClementHector]

Should we have a task name regex for the profile, so we can be flexible with tasks of the same type but different names?

Do we have to put a taks list like for the orignal build ?

[tokejepsen]

Should we have a task name regex for the profile, so we can be flexible with tasks of the same type but different names?

Do we have to put a taks list like for the orignal build ?

Have only skimmed this PR, so ignore my thought if it requires more work.

[ClementHector]

Don't worry, i will do it!

[iLLiCiTiT]

Can we move this to openpype.pipeline? We're in process of reducing pipeline related functions from openpype.lib to avoid cross imports.

[iLLiCiTiT]

This looks like a package of workfile template build. So maybe a folder with this file, abstract_template_loader.py and build_template_exceptions.py?

[ClementHector]

Should I put the file build_template.py, abstract_template_loader.py and build_template_exceptions.py
in openpype/lib/build_workfile or openpype/build_workfile?

[ClementHector]

@iLLiCiTiT Can you tell me which folder please.

[iLLiCiTiT]

I'm sorry for late response, just ./openpype/pipeline/workfiles. There will be moved more workfiles related code over time.

Also keep updated changes in avalon_context.py most of those functions were changed or removed over time.

[iLLiCiTiT]

This function does not need the decorator.

Suggested change

@with_pipeline_io

[m-u-r-p-h-y]

This is a big feature and a massive code change. I tested just the basic functionality

• creating templates
• modifying project settings
• the initial building of a scene

this is working good so far-

during further testing, I encountered a couple of issues

when running Update Workfile from a template (after the initial build of the scene with no asset loaded)

# Error: ValueError: file D:\REPO\OpenPype\openpype\hosts\maya\api\template_loader.py line 83: No object matches name: AVALON_CONTAINERS #

another issue is with Update Placeholder.
when you run it, it will open a window. If you close it without doing any change, it will remove custom attributes from the placeholder

[m-u-r-p-h-y]

the two small things were fixed and it seems quite stable now.
we should let it go to production for a real-world test :)

thanks!

[iLLiCiTiT]

Please move "context specific" functionality from openpype.lib to openpype.pipeline. Function collect_last_version_repres changed code over time so please update the code from latest develop. And get_loaders_by_name should be moved into openpype.pipeline.load.utils.py.

We will fix this on our end in an intermediate branch.