Convert Flame creators to new publisher

[robin-ynput]

Changelog Description

resolve #10
Make flame creators use the Creator API and new widget. Publishable products are now listed as individual instances following a similar logic than Hiero and Resolve.

Done:

• Convert existing creators to new Creator
• Redirect widget to new Creator widget
• Rework collectors to work with instances and sub-instances
• Adjust colorspace data following Update metadata keys and add colorspace data ayon-hiero#23
• Finalize workfile instance data serialization
• report review adjustements Publishing reviewable attributes enhancements ayon-hiero#24

Testing notes:

In Flame:

• Create a timeline with clips associated to movie and img-sequence media
• From AYON Menu (right click)
• Create and publish product(s) of type shot, audio, plate and review from there

Tested locally on Flame 2024.2

[iLLiCiTiT]

Suggested change

	attr_defs = instance.creator_attributes.attr_defs
	if "review" not in changes:
	continue
	review_value = changes["review"]
	reviewable_source = next(
	attr_def
	for attr_def in attr_defs
	if "review" not in changes:
	continue
	attr_defs = instance.creator_attributes.attr_defs
	review_value = changes["review"]
	reviewable_source = next(
	attr_def
	for attr_def in attr_defs

[iLLiCiTiT]

Suggested change

	disabled=not current_review,
	enabled=current_review,

[iLLiCiTiT]

Suggested change

	reviewable_source.disabled = not review_value
	reviewable_source.enabled = review_value

[iLLiCiTiT]

Suggested change

	def create(self, subset_name, instance_data, pre_create_data):
	super(CreateShotClip, self).create(subset_name,
	instance_data,
	pre_create_data)
	def create(self, product_name, instance_data, pre_create_data):
	super().create(
	product_name,
	instance_data,
	pre_create_data)

[iLLiCiTiT]

Suggested change

	audio_clips = []
	for audio_track in self.sequence.audio_tracks:
	audio_clips.append(audio_track.segments)
	audio_clips = [
	audio_track.segments
	for audio_track in self.sequence.audio_tracks
	]

[iLLiCiTiT]

Already defined below

Suggested change

	sorted_selected_segments = list()
	unsorted_selected_segments = list()

[iLLiCiTiT]

.copy() on dictionary is the same as dict(instance_data) which does not create copy of value objects (e.g. lists or nested dictionaries)

Suggested change

	segment_instance_data = instance_data.copy()
	segment_instance_data = copy.deepcopy(instance_data)

[iLLiCiTiT]

Suggested change

	prev_instances = [
	inst for inst_id, inst
	in self.create_context.instances_by_id.items()
	if inst_id == inst_data["instance_id"]
	]
	creator.remove_instances(prev_instances)
	prev_instance = self.create_context.instances_by_id.get(
	inst_data["instance_id"]
	)
	if prev_instance is not None:
	creator.remove_instances([prev_instance])

[iLLiCiTiT]

Suggested change

	"label": (
	f"{shot_folder_path} shot"
	),
	"label": f"{shot_folder_path} shot",

[iLLiCiTiT]

Suggested change

	if instance_data["audio"]:
	sub_creators = (
	"io.ayon.creators.flame.plate",
	"io.ayon.creators.flame.audio"
	)
	else:
	sub_creators = ("io.ayon.creators.flame.plate",)
	sub_creators = ["io.ayon.creators.flame.plate"]
	if instance_data["audio"]:
	sub_creators.append(
	"io.ayon.creators.flame.audio"
	)

[iLLiCiTiT]

Suggested change

	sub_instance_data = instance_data.copy()
	sub_instance_data = copy.deepcopy(instance_data)

[iLLiCiTiT]

Suggested change

	if _CONTENT_ID in marker_data:
	for creator_id, data in marker_data[_CONTENT_ID].items():
	self._create_and_add_instance(
	data, creator_id, segment, instances)
	else:
	instances.extend(self._collect_legacy_instance(segment, marker_data))
	# Legacy instances handling
	if _CONTENT_ID not in marker_data:
	instances.extend(
	self._collect_legacy_instance(segment, marker_data)
	)
	continue
	for creator_id, data in marker_data[_CONTENT_ID].items():
	self._create_and_add_instance(
	data, creator_id, segment, instances)

[iLLiCiTiT]

Shouldn't this be function somehwere in ayon_flame.api? (I have no context so maybe not)

[iLLiCiTiT]

Suggested change

	instance.data.pop("reviewTrack")
	# Remove review track to avoid creation of reviewable
	# for the instance
	instance.data.pop("reviewTrack")

[iLLiCiTiT]

Is this something that is "artist" error or "code" error? If it is something that artist should know about then use PublishError (from ayon_core.pipeline import PublishError). It will show the error message to user, otherwise he'll see "This is not your fault".

[iLLiCiTiT]

BTW for code readability I would use this, technically the same, but easier to read intention (not pushing tho).

    segment_item = None
    for item in instance.context.data["flameSelectedSegments"]:
        item_data = ayfapi.get_segment_data_marker(item) or {}
        if item_data.get("clip_index") == instance.data["clip_index"]:
             segment_item = item
             break

    if segment_item is None:
        raise PublishError("Could not retrieve source from selected segments.")

[iLLiCiTiT]

Suggested change

	# make sure there is not NoneType rather 0
	if head is None:
	head = 0
	if tail is None:
	tail = 0
	# make sure value is absolute
	if head != 0:
	head = abs(head)
	if tail != 0:
	tail = abs(tail)
	# Make sure there is not None and negative number
	head = abs(head or 0)
	tail = abs(tail or 0)
	# make sure value is absolute
	if head != 0:
	head = abs(head)
	if tail != 0:
	tail = abs(tail)

[iLLiCiTiT]

Suggested change

	# make sure there is not NoneType rather 0
	if head is None:
	head = 0
	if tail is None:
	tail = 0
	# make sure value is absolute
	if head != 0:
	head = abs(head)
	if tail != 0:
	tail = abs(tail)
	# Make sure there is not None and negative number
	head = abs(head or 0)
	tail = abs(tail or 0)

---

BTW did you really wanted to use abs? Should that be clamped to 0 instead?

Suggested change

	# make sure there is not NoneType rather 0
	if head is None:
	head = 0
	if tail is None:
	tail = 0
	# make sure value is absolute
	if head != 0:
	head = abs(head)
	if tail != 0:
	tail = abs(tail)
	# Make sure there is not None and clamp to 0
	if head is None or head < 0:
	head = 0
	if tail is None or head < 0:
	tail = 0

[iLLiCiTiT]

Requires import re.

Suggested change

	split_comments = []
	if "," in comment_string:
	split_comments.extend(comment_string.split(","))
	elif ";" in comment_string:
	split_comments.extend(comment_string.split(";"))
	else:
	split_comments.append(comment_string)
	return split_comments
	return re.split(r",|;", comment_string)

---

Or to be more obvious

Suggested change

	split_comments = []
	if "," in comment_string:
	split_comments.extend(comment_string.split(","))
	elif ";" in comment_string:
	split_comments.extend(comment_string.split(";"))
	else:
	split_comments.append(comment_string)
	return split_comments
	pattern = "|".join([",", ";"])
	return re.split(pattern, comment_string)

[iLLiCiTiT]

Suggested change

	order = order = pyblish.api.CollectorOrder - 0.095
	order = pyblish.api.CollectorOrder - 0.095

[iLLiCiTiT]

Is it possible to run this plugin much earlier? e.g. pyblish.api.CollectorOrder - 0.49? If not please describe why not. Does not happen in this PR, but let me know I'll create issue for it if we can't do it now, thanks.