Skip to content

YN-0620 - Batch creator/publisher/loader + Improve batch_utils module#124

Open
rdelillo wants to merge 14 commits into
bugfix/YN-0022_fix_clip_loadersfrom
enhancement/YN-0620_batchgroup_loader_publisher
Open

YN-0620 - Batch creator/publisher/loader + Improve batch_utils module#124
rdelillo wants to merge 14 commits into
bugfix/YN-0022_fix_clip_loadersfrom
enhancement/YN-0620_batchgroup_loader_publisher

Conversation

@rdelillo
Copy link
Copy Markdown
Contributor

@rdelillo rdelillo commented Apr 23, 2026

Changelog Description

fixes 119 #118
Changes:

  • Add Flame batch serializer/deserializer as consolidated json file
  • Add Batch creator + publisher (workfile product type)
  • Add Batch loader leveraging the Flame batch iteration

Tests

Tested on Flame 2026 macOs

Testing notes:

  1. In Flame. go in batch tab
  2. Creator -> Batch -> Publish
  3. Do some changes, publish again
  4. Ensure you can load the resulting batch from the loader with all of its iterations

@rdelillo rdelillo changed the title Improve batch_utils module YN-0620 Improve batch_utils module Apr 23, 2026
@rdelillo rdelillo requested a review from Copilot April 29, 2026 12:27
@rdelillo rdelillo self-assigned this Apr 29, 2026
@rdelillo rdelillo added type: enhancement Improvement of existing functionality or minor addition sponsored This is directly sponsored by a client or community member labels Apr 29, 2026
@rdelillo rdelillo changed the title YN-0620 Improve batch_utils module YN-0620 - Batch creator/publisher/loader + Improve batch_utils module Apr 29, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands Flame Batch workflow support by introducing batch-specific menus and adding publish/load tooling to serialize a Flame batch group into a consolidated JSON “workfile” representation and reload versions as native Flame batch iterations.

Changes:

  • Add a dedicated Batch menu context (FlameMenuBatch) and wire it into Flame startup hooks.
  • Introduce batch workfile creator/extractor/loader plugins (publish consolidated JSON; load all versions as batch iterations).
  • Refactor/extend batch_utils with batch create/update, reel management, batch content editing, and consolidated JSON save/load.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
client/ayon_flame/startup/AYON_in_flame.py Registers the new Batch menu app and routes Batch hook menus to it.
client/ayon_flame/api/menu.py Adds FlameMenuBatch with Create/Publish/Load/Library actions in Batch context.
client/ayon_flame/api/init.py Exposes new menu + batch utils API surface; removes deprecated batch lookup export.
client/ayon_flame/api/lib.py Removes get_batch_group_from_desktop helper.
client/ayon_flame/api/batch_utils.py Adds batch CRUD helpers and consolidated JSON (de)serialization utilities.
client/ayon_flame/plugins/create/create_batch.py Adds a Batch “workfile” creator storing instance metadata in a Note node.
client/ayon_flame/plugins/publish/extract_batch_workfile.py Adds extractor to export current batch group into consolidated JSON representation.
client/ayon_flame/plugins/load/load_batch.py Adds loader that loads all published versions as Flame batch iterations.
client/ayon_flame/plugins/publish/integrate_batch_group.py Updates integration flow to use the new batch utils APIs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread client/ayon_flame/plugins/publish/integrate_batch_group.py Outdated
Comment thread client/ayon_flame/api/batch_utils.py
Comment thread client/ayon_flame/api/batch_utils.py
Comment thread client/ayon_flame/api/batch_utils.py Outdated
Comment thread client/ayon_flame/plugins/load/load_batch.py Outdated
rdelillo and others added 2 commits April 29, 2026 08:43
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment on lines +284 to +287
menu['actions'].append({
"name": "4 - Library...",
"execute": lambda x: self.tools_helper.show_library_loader()
})
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd get rid of library, it is the same thing as loader.

Suggested change
menu['actions'].append({
"name": "4 - Library...",
"execute": lambda x: self.tools_helper.show_library_loader()
})


instance = CreatedInstance(
product_base_type=self.product_base_type,
product_type=self.product_type,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
product_type=self.product_type,
product_type=self.product_base_type,


instance = CreatedInstance(
product_base_type=self.product_base_type,
product_type=self.product_type,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
product_type=self.product_type,
product_type=self.product_base_type,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sponsored This is directly sponsored by a client or community member type: enhancement Improvement of existing functionality or minor addition

Projects

None yet

4 participants