Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

use constants instead of hardcoded values

Browse source
This commit is contained in:
Jakub Trllo 2024-02-20 14:30:20 +01:00
parent 98a0f72f03
commit d724a66633
36 changed files with 191 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

6
client/ayon_core/hosts/aftereffects/api/pipeline.py
View file

@ -9,6 +9,8 @@ from ayon_core.pipeline import (
register_loader_plugin_path,
register_creator_plugin_path,
AVALON_CONTAINER_ID,
AVALON_INSTANCE_ID,
AYON_INSTANCE_ID,
)
from ayon_core.hosts.aftereffects.api.workfile_template_builder import (
AEPlaceholderLoadPlugin,
@ -142,7 +144,9 @@ class AfterEffectsHost(HostBase, IWorkfileHost, ILoadHost, IPublishHost):
layers_meta = stub.get_metadata()
for instance in layers_meta:
if instance.get("id") == "pyblish.avalon.instance":
if instance.get("id") in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
instances.append(instance)
return instances

6
client/ayon_core/hosts/blender/api/pipeline.py
View file

@ -26,6 +26,7 @@ from ayon_core.pipeline import (
deregister_loader_plugin_path,
deregister_creator_plugin_path,
AVALON_CONTAINER_ID,
AYON_CONTAINER_ID,
)
from ayon_core.lib import (
Logger,
@ -563,8 +564,9 @@ def ls() -> Iterator:
called containers.
"""
for container in lib.lsattr("id", AVALON_CONTAINER_ID):
yield parse_container(container)
for id_type in {AYON_CONTAINER_ID, AVALON_CONTAINER_ID}:
for container in lib.lsattr("id", id_type):
yield parse_container(container)
def publish():

8
client/ayon_core/hosts/blender/api/plugin.py
View file

@ -10,6 +10,8 @@ from ayon_core.pipeline import (
Creator,
CreatedInstance,
LoaderPlugin,
AVALON_INSTANCE_ID,
AYON_INSTANCE_ID,
)
from ayon_core.lib import BoolDef
@ -193,7 +195,9 @@ class BaseCreator(Creator):
if not avalon_prop:
continue
if avalon_prop.get('id') != 'pyblish.avalon.instance':
if avalon_prop.get('id') not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
creator_id = avalon_prop.get('creator_identifier')
@ -352,7 +356,7 @@ class BaseCreator(Creator):
instance_data.update(
{
"id": "pyblish.avalon.instance",
"id": AVALON_INSTANCE_ID,
"creator_identifier": self.identifier,
"subset": subset_name,
}

5
client/ayon_core/hosts/flame/plugins/publish/collect_timeline_instances.py
View file

@ -3,6 +3,7 @@ from types import NoneType
import pyblish
import ayon_core.hosts.flame.api as opfapi
from ayon_core.hosts.flame.otio import flame_export
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
from ayon_core.pipeline.editorial import (
is_overlapping_otio_ranges,
get_media_range_with_retimes
@ -47,7 +48,9 @@ class CollectTimelineInstances(pyblish.api.ContextPlugin):
if not marker_data:
continue
if marker_data.get("id") != "pyblish.avalon.instance":
if marker_data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
self.log.debug("__ segment.name: {}".format(

18
client/ayon_core/hosts/fusion/api/plugin.py
View file

@ -12,7 +12,9 @@ from ayon_core.lib import (
)
from ayon_core.pipeline import (
Creator,
CreatedInstance
CreatedInstance,
AVALON_INSTANCE_ID,
AYON_INSTANCE_ID,
)
@ -172,13 +174,13 @@ class GenericCreateSaver(Creator):
if not isinstance(data, dict):
return
required = {
"id": "pyblish.avalon.instance",
"creator_identifier": self.identifier,
}
for key, value in required.items():
if key not in data or data[key] != value:
return
if (
data.get("creator_identifier") != self.identifier
or data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}
):
return
# Get active state from the actual tool state
attrs = tool.GetAttrs()

8
client/ayon_core/hosts/harmony/api/README.md
View file

@ -212,6 +212,7 @@ class CreateComposite(harmony.Creator):
The creator plugin can be configured to use other node types. For example here is a write node creator:
```python
from uuid import uuid4
import ayon_core.hosts.harmony.api as harmony
@ -242,6 +243,7 @@ class CreateRender(harmony.Creator):
#### Collector Plugin
```python
import pyblish.api
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
import ayon_core.hosts.harmony.api as harmony
@ -252,7 +254,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
a composite node and marked with a unique identifier;
Identifier:
id (str): "pyblish.avalon.instance"
id (str): "ayon.create.instance"
"""
label = "Instances"
@ -272,7 +274,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
continue
# Skip containers.
if "container" in data["id"]:
if data["id"] not in {AYON_INSTANCE_ID, AVALON_INSTANCE_ID}:
continue
instance = context.create_instance(node.split("/")[-1])
@ -287,6 +289,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
#### Extractor Plugin
```python
import os
from uuid import uuid4
import pyblish.api
import ayon_core.hosts.harmony.api as harmony
@ -418,6 +421,7 @@ class ExtractImage(pyblish.api.InstancePlugin):
#### Loader Plugin
```python
import os
from uuid import uuid4
import ayon_core.hosts.harmony.api as harmony

2
client/ayon_core/hosts/harmony/plugins/publish/collect_instances.py
View file

@ -13,7 +13,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
a composite node and marked with a unique identifier.
Identifier:
id (str): "pyblish.avalon.instance"
id (str): "ayon.create.instance"
"""
label = "Instances"

11
client/ayon_core/hosts/hiero/api/lib.py
View file

@ -22,7 +22,12 @@ except ImportError:
from ayon_core.client import get_project
from ayon_core.settings import get_project_settings
from ayon_core.pipeline import Anatomy, get_current_project_name
from ayon_core.pipeline import (
Anatomy,
get_current_project_name,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.pipeline.load import filter_containers
from ayon_core.lib import Logger
from . import tags
@ -1217,7 +1222,9 @@ def sync_clip_name_to_data_asset(track_items_list):
# ignore if no data on the clip or not publish instance
if not data:
continue
if data.get("id") != "pyblish.avalon.instance":
if data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
# fix data if wrong name

5
client/ayon_core/hosts/hiero/api/pipeline.py
View file

@ -15,6 +15,7 @@ from ayon_core.pipeline import (
deregister_creator_plugin_path,
deregister_loader_plugin_path,
AVALON_CONTAINER_ID,
AYON_CONTAINER_ID,
)
from ayon_core.tools.utils import host_tools
from . import lib, menu, events
@ -158,7 +159,9 @@ def parse_container(item, validate=True):
def data_to_container(item, data):
if (
not data
or data.get("id") != "pyblish.avalon.container"
or data.get("id") not in {
AYON_CONTAINER_ID, AVALON_CONTAINER_ID
}
):
return

5
client/ayon_core/hosts/hiero/plugins/publish/precollect_instances.py
View file

@ -1,5 +1,6 @@
import pyblish
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
from ayon_core.pipeline.editorial import is_overlapping_otio_ranges
from ayon_core.hosts.hiero import api as phiero
@ -56,7 +57,9 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not tag_data:
continue
if tag_data.get("id") != "pyblish.avalon.instance":
if tag_data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
# get clips subtracks and anotations

8
client/ayon_core/hosts/houdini/api/pipeline.py
View file

@ -15,6 +15,7 @@ from ayon_core.pipeline import (
register_loader_plugin_path,
register_inventory_action_path,
AVALON_CONTAINER_ID,
AYON_CONTAINER_ID,
)
from ayon_core.pipeline.load import any_outdated_containers
from ayon_core.hosts.houdini import HOUDINI_HOST_DIR
@ -271,8 +272,11 @@ def parse_container(container):
def ls():
containers = []
for identifier in (AVALON_CONTAINER_ID,
"pyblish.mindbender.container"):
for identifier in (
AYON_CONTAINER_ID,
AVALON_CONTAINER_ID,
"pyblish.mindbender.container"
):
containers += lib.lsattr("id", identifier)
for container in sorted(containers,

9
client/ayon_core/hosts/houdini/api/plugin.py
View file

@ -11,7 +11,9 @@ from ayon_core.pipeline import (
CreatorError,
LegacyCreator,
Creator as NewCreator,
CreatedInstance
CreatedInstance,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.lib import BoolDef
from .lib import imprint, read, lsattr, add_self_publish_button
@ -118,7 +120,10 @@ class HoudiniCreatorBase(object):
cache = dict()
cache_legacy = dict()
for node in lsattr("id", "pyblish.avalon.instance"):
nodes = []
for id_type in [AYON_INSTANCE_ID, AVALON_INSTANCE_ID]:
nodes.extend(lsattr("id", AYON_INSTANCE_ID))
for node in nodes:
creator_identifier_parm = node.parm("creator_identifier")
if creator_identifier_parm:

7
client/ayon_core/hosts/houdini/plugins/publish/collect_instances.py
View file

@ -2,6 +2,7 @@ import hou
import pyblish.api
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
from ayon_core.hosts.houdini.api import lib
@ -12,7 +13,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
an specific node and marked with a unique identifier;
Identifier:
id (str): "pyblish.avalon.instance
id (str): "ayon.create.instance"
Specific node:
The specific node is important because it dictates in which way the
@ -44,7 +45,9 @@ class CollectInstances(pyblish.api.ContextPlugin):
if not node.parm("id"):
continue
if node.evalParm("id") != "pyblish.avalon.instance":
if node.evalParm("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
# instance was created by new creator code, skip it as

2
client/ayon_core/hosts/houdini/plugins/publish/collect_instances_usd_layered.py
View file

@ -12,7 +12,7 @@ class CollectInstancesUsdLayered(pyblish.api.ContextPlugin):
layers remain set to 'publish' by the user.
This works differently from most of our Avalon instances in the pipeline.
As opposed to storing `pyblish.avalon.instance` as id on the node we store
As opposed to storing `ayon.create.instance` as id on the node we store
`pyblish.avalon.usdlayered`.
Additionally this instance has no need for storing family, asset, subset

5
client/ayon_core/hosts/max/api/pipeline.py
View file

@ -12,6 +12,7 @@ from ayon_core.pipeline import (
register_creator_plugin_path,
register_loader_plugin_path,
AVALON_CONTAINER_ID,
AYON_CONTAINER_ID,
)
from ayon_core.hosts.max.api.menu import OpenPypeMenu
from ayon_core.hosts.max.api import lib
@ -151,7 +152,9 @@ def ls() -> list:
objs = rt.objects
containers = [
obj for obj in objs
if rt.getUserProp(obj, "id") == AVALON_CONTAINER_ID
if rt.getUserProp(obj, "id") in {
AYON_CONTAINER_ID, AVALON_CONTAINER_ID
}
]
for container in sorted(containers, key=attrgetter("name")):

14
client/ayon_core/hosts/max/api/plugin.py
View file

@ -6,7 +6,13 @@ import six
from pymxs import runtime as rt
from ayon_core.lib import BoolDef
from ayon_core.pipeline import CreatedInstance, Creator, CreatorError
from ayon_core.pipeline import (
CreatedInstance,
Creator,
CreatorError,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from .lib import imprint, lsattr, read
@ -162,7 +168,11 @@ class MaxCreatorBase(object):
return shared_data
shared_data["max_cached_subsets"] = {}
cached_instances = lsattr("id", "pyblish.avalon.instance")
cached_instances = []
for id_type in [AYON_INSTANCE_ID, AVALON_INSTANCE_ID]:
cached_instances.extend(lsattr("id", id_type))
for i in cached_instances:
creator_id = rt.GetUserProp(i, "creator_identifier")
if creator_id not in shared_data["max_cached_subsets"]:

19
client/ayon_core/hosts/maya/api/lib.py
View file

@ -35,7 +35,11 @@ from ayon_core.pipeline import (
loaders_from_representation,
get_representation_path,
load_container,
registered_host
registered_host,
AVALON_CONTAINER_ID,
AVALON_INSTANCE_ID,
AYON_INSTANCE_ID,
AYON_CONTAINER_ID,
)
from ayon_core.lib import NumberDef
from ayon_core.pipeline.context_tools import get_current_project_asset
@ -2100,7 +2104,7 @@ def get_related_sets(node):
"""Return objectSets that are relationships for a look for `node`.
Filters out based on:
- id attribute is NOT `pyblish.avalon.container`
- id attribute is NOT `AVALON_CONTAINER_ID`
- shapes and deformer shapes (alembic creates meshShapeDeformed)
- set name ends with any from a predefined list
- set in not in viewport set (isolate selected for example)
@ -2120,7 +2124,12 @@ def get_related_sets(node):
defaults = {"defaultLightSet", "defaultObjectSet"}
# Ids to ignore
ignored = {"pyblish.avalon.instance", "pyblish.avalon.container"}
ignored = {
AVALON_INSTANCE_ID,
AVALON_CONTAINER_ID,
AYON_INSTANCE_ID,
AYON_CONTAINER_ID,
}
view_sets = get_isolate_view_sets()
@ -3151,7 +3160,9 @@ def update_content_on_context_change():
new_data = asset_doc["data"]
for s in scene_sets:
try:
if cmds.getAttr("{}.id".format(s)) == "pyblish.avalon.instance":
if cmds.getAttr("{}.id".format(s)) in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
attr = cmds.listAttr(s)
print(s)
if "asset" in attr:

10
client/ayon_core/hosts/maya/api/pipeline.py
View file

@ -33,6 +33,7 @@ from ayon_core.pipeline import (
deregister_loader_plugin_path,
deregister_inventory_action_path,
deregister_creator_plugin_path,
AYON_CONTAINER_ID,
AVALON_CONTAINER_ID,
)
from ayon_core.pipeline.load import any_outdated_containers
@ -376,9 +377,12 @@ def _ls():
yield iterator.thisNode()
iterator.next()
ids = {AVALON_CONTAINER_ID,
# Backwards compatibility
"pyblish.mindbender.container"}
ids = {
AYON_CONTAINER_ID,
# Backwards compatibility
AVALON_CONTAINER_ID,
"pyblish.mindbender.container"
}
# Iterate over all 'set' nodes in the scene to detect whether
# they have the avalon container ".id" attribute.

11
client/ayon_core/hosts/maya/api/plugin.py
View file

@ -10,6 +10,9 @@ from maya.app.renderSetup.model import renderSetup
from ayon_core.lib import BoolDef, Logger
from ayon_core.settings import get_project_settings
from ayon_core.pipeline import (
AYON_INSTANCE_ID,
AYON_CONTAINER_ID,
AVALON_INSTANCE_ID,
AVALON_CONTAINER_ID,
Anatomy,
@ -110,7 +113,9 @@ class MayaCreatorBase(object):
for node in cmds.ls(type="objectSet"):
if _get_attr(node, attr="id") != "pyblish.avalon.instance":
if _get_attr(node, attr="id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
creator_id = _get_attr(node, attr="creator_identifier")
@ -992,5 +997,7 @@ class ReferenceLoader(Loader):
id_attr = "{}.id".format(node)
if not cmds.attributeQuery("id", node=node, exists=True):
continue
if cmds.getAttr(id_attr) == AVALON_CONTAINER_ID:
if cmds.getAttr(id_attr) not in {
AYON_CONTAINER_ID, AVALON_CONTAINER_ID
}:
cmds.sets(node, forceElement=container)

11
client/ayon_core/hosts/maya/api/workfile_template_builder.py
View file

@ -2,7 +2,12 @@ import json
from maya import cmds
from ayon_core.pipeline import registered_host, get_current_asset_name
from ayon_core.pipeline import (
registered_host,
get_current_asset_name,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.pipeline.workfile.workfile_template_builder import (
TemplateAlreadyImported,
AbstractTemplateBuilder,
@ -73,7 +78,9 @@ class MayaTemplateBuilder(AbstractTemplateBuilder):
for node in imported_sets:
if not cmds.attributeQuery("id", node=node, exists=True):
continue
if cmds.getAttr("{}.id".format(node)) != "pyblish.avalon.instance":
if cmds.getAttr("{}.id".format(node)) not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
if not cmds.attributeQuery("asset", node=node, exists=True):
continue

2
client/ayon_core/hosts/maya/plugins/publish/collect_instances.py
View file

@ -11,7 +11,7 @@ class CollectNewInstances(pyblish.api.InstancePlugin):
an objectSet and marked with a unique identifier;
Identifier:
id (str): "pyblish.avalon.instance"
id (str): "ayon.create.instance"
Limitations:
- Does not take into account nodes connected to those

10
client/ayon_core/hosts/maya/plugins/publish/extract_maya_scene_raw.py
View file

@ -5,7 +5,11 @@ import os
from maya import cmds
from ayon_core.hosts.maya.api.lib import maintained_selection
from ayon_core.pipeline import AVALON_CONTAINER_ID, publish
from ayon_core.pipeline import (
AYON_CONTAINER_ID,
AVALON_CONTAINER_ID,
publish,
)
from ayon_core.pipeline.publish import AYONPyblishPluginMixin
from ayon_core.lib import BoolDef
@ -136,7 +140,9 @@ class ExtractMayaSceneRaw(publish.Extractor, AYONPyblishPluginMixin):
continue
id_attr = "{}.id".format(obj_set)
if cmds.getAttr(id_attr) != AVALON_CONTAINER_ID:
if cmds.getAttr(id_attr) not in {
AYON_CONTAINER_ID, AVALON_CONTAINER_ID
}:
continue
set_content = set(cmds.sets(obj_set, query=True))

10
client/ayon_core/hosts/nuke/api/lib.py
View file

@ -45,6 +45,8 @@ from ayon_core.pipeline import (
get_current_host_name,
get_current_project_name,
get_current_asset_name,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.pipeline.context_tools import (
get_custom_workfile_template_from_session
@ -2300,12 +2302,16 @@ Reopening Nuke should synchronize these paths and resolve any discrepancies.
# backward compatibility
# TODO: remove this once old avalon data api will be removed
avalon_knob_data
and avalon_knob_data.get("id") != "pyblish.avalon.instance"
and avalon_knob_data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}
):
continue
elif (
node_data
and node_data.get("id") != "pyblish.avalon.instance"
and node_data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}
):
continue

6
client/ayon_core/hosts/nuke/api/pipeline.py
View file

@ -18,6 +18,8 @@ from ayon_core.pipeline import (
register_loader_plugin_path,
register_creator_plugin_path,
register_inventory_action_path,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
AVALON_CONTAINER_ID,
get_current_asset_name,
get_current_task_name,
@ -550,7 +552,9 @@ def list_instances(creator_id=None):
if not instance_data:
continue
if instance_data["id"] != "pyblish.avalon.instance":
if instance_data["id"] not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
if creator_id and instance_data["creator_identifier"] != creator_id:

8
client/ayon_core/hosts/nuke/api/plugin.py
View file

@ -19,7 +19,9 @@ from ayon_core.pipeline import (
CreatorError,
Creator as NewCreator,
CreatedInstance,
get_current_task_name
get_current_task_name,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.pipeline.colorspace import (
get_display_view_colorspace_name,
@ -1265,7 +1267,9 @@ def convert_to_valid_instaces():
if not avalon_knob_data:
continue
if avalon_knob_data["id"] != "pyblish.avalon.instance":
if avalon_knob_data["id"] not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
transfer_data.update({

5
client/ayon_core/hosts/nuke/plugins/create/convert_legacy.py
View file

@ -1,3 +1,4 @@
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
from ayon_core.pipeline.create.creator_plugins import SubsetConvertorPlugin
from ayon_core.hosts.nuke.api.lib import (
INSTANCE_DATA_KNOB,
@ -34,7 +35,9 @@ class LegacyConverted(SubsetConvertorPlugin):
if not avalon_knob_data:
continue
if avalon_knob_data["id"] != "pyblish.avalon.instance":
if avalon_knob_data["id"] not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
# catch and break

2
client/ayon_core/hosts/photoshop/api/README.md
View file

@ -75,7 +75,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
an LayerSet and marked with a unique identifier;
Identifier:
id (str): "pyblish.avalon.instance"
id (str): "ayon.create.instance"
"""
label = "Instances"

6
client/ayon_core/hosts/photoshop/api/pipeline.py
View file

@ -9,6 +9,8 @@ from ayon_core.pipeline import (
register_loader_plugin_path,
register_creator_plugin_path,
AVALON_CONTAINER_ID,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.host import (
@ -121,7 +123,9 @@ class PhotoshopHost(HostBase, IWorkfileHost, ILoadHost, IPublishHost):
layers_meta = stub.get_layers_metadata()
if layers_meta:
for instance in layers_meta:
if instance.get("id") == "pyblish.avalon.instance":
if instance.get("id") in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
instances.append(instance)
return instances

6
client/ayon_core/hosts/photoshop/api/ws_stub.py
View file

@ -119,14 +119,14 @@ class PhotoshopServerStub:
"active":true,
"subset":"imageBG",
"family":"image",
"id":"pyblish.avalon.instance",
"id":"ayon.create.instance",
"asset":"Town",
"uuid": "8"
}] - for created instances
OR
[{
"schema": "openpype:container-2.0",
"id": "pyblish.avalon.instance",
"id": "ayon.create.instance",
"name": "imageMG",
"namespace": "Jungle_imageMG_001",
"loader": "ImageLoader",
@ -420,7 +420,7 @@ class PhotoshopServerStub:
(list)
example:
{"8":{"active":true,"subset":"imageBG",
"family":"image","id":"pyblish.avalon.instance",
"family":"image","id":"ayon.create.instance",
"asset":"Town"}}
8 is layer(group) id - used for deletion, update etc.
"""

2
client/ayon_core/hosts/photoshop/plugins/publish/collect_color_coded_instances.py
View file

@ -26,7 +26,7 @@ class CollectColorCodedInstances(pyblish.api.ContextPlugin):
only separate subsets per marked layer.
Identifier:
id (str): "pyblish.avalon.instance"
id (str): "ayon.create.instance"
"""
label = "Collect Color-coded Instances"

5
client/ayon_core/hosts/resolve/plugins/publish/precollect_instances.py
View file

@ -2,6 +2,7 @@ from pprint import pformat
import pyblish
from ayon_core.pipeline import AYON_INSTANCE_ID, AVALON_INSTANCE_ID
from ayon_core.hosts.resolve.api.lib import (
get_current_timeline_items,
get_timeline_item_pype_tag,
@ -39,7 +40,9 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not tag_data:
continue
if tag_data.get("id") != "pyblish.avalon.instance":
if tag_data.get("id") not in {
AYON_INSTANCE_ID, AVALON_INSTANCE_ID
}:
continue
media_pool_item = timeline_item.GetMediaPoolItem()

2
client/ayon_core/hosts/tvpaint/api/pipeline.py
View file

@ -52,7 +52,7 @@ expected that there are also keys `["instances0", "instances1"]`.
Workfile data looks like:
```
[avalon]
instances0=[{{__dq__}id{__dq__}: {__dq__}pyblish.avalon.instance{__dq__...
instances0=[{{__dq__}id{__dq__}: {__dq__}ayon.create.instance{__dq__...
instances1=...more data...
instances=2
```

4
client/ayon_core/pipeline/create/README.md
View file

@ -14,7 +14,7 @@ Except creating and removing instances are all changes not automatically propaga
## CreatedInstance
Product of creation is "instance" which holds basic data defying it. Core data are `creator_identifier`, `family` and `subset`. Other data can be keys used to fill subset name or metadata modifying publishing process of the instance (more described later). All instances have `id` which holds constant `pyblish.avalon.instance` and `instance_id` which is identifier of the instance.
Product of creation is "instance" which holds basic data defying it. Core data are `creator_identifier`, `family` and `subset`. Other data can be keys used to fill subset name or metadata modifying publishing process of the instance (more described later). All instances have `id` which holds constant `ayon.create.instance` or `pyblish.avalon.instance` (for backwards compatibility) and `instance_id` which is identifier of the instance.
Family tells how should be instance processed and subset what name will published item have.
- There are cases when subset is not fully filled during creation and may change during publishing. That is in most of cases caused because instance is related to other instance or instance data do not represent final product.
@ -24,7 +24,7 @@ Family tells how should be instance processed and subset what name will publishe
{
# Immutable data after creation
## Identifier that this data represents instance for publishing (automatically assigned)
"id": "pyblish.avalon.instance",
"id": "ayon.create.instance",
## Identifier of this specific instance (automatically assigned)
"instance_id": <uuid4>,
## Instance family (used from Creator)

12
client/ayon_core/pipeline/create/context.py
View file

@ -27,7 +27,11 @@ from ayon_core.lib.attribute_definitions import (
get_default_values,
)
from ayon_core.host import IPublishHost, IWorkfileHost
from ayon_core.pipeline import Anatomy
from ayon_core.pipeline import (
Anatomy,
AYON_INSTANCE_ID,
AVALON_INSTANCE_ID,
)
from ayon_core.pipeline.plugin_discover import DiscoverResult
from .creator_plugins import (
@ -937,7 +941,11 @@ class CreatedInstance:
# QUESTION Does it make sense to have data stored as ordered dict?
self._data = collections.OrderedDict()
# QUESTION Do we need this "id" information on instance?
self._data["id"] = "pyblish.avalon.instance"
item_id = data.get("id")
# TODO use only 'AYON_INSTANCE_ID' when all hosts support it
if item_id not in {AYON_INSTANCE_ID, AVALON_INSTANCE_ID}:
item_id = AVALON_INSTANCE_ID
self._data["id"] = item_id
self._data["family"] = family
self._data["subset"] = subset_name
self._data["active"] = data.get("active", True)

4
client/ayon_core/pipeline/create/legacy_create.py
View file

@ -10,6 +10,7 @@ import logging
import collections
from ayon_core.client import get_asset_by_id
from ayon_core.pipeline.constants import AVALON_INSTANCE_ID
from .subset_name import get_subset_name
@ -33,7 +34,8 @@ class LegacyCreator(object):
# Default data
self.data = collections.OrderedDict()
self.data["id"] = "pyblish.avalon.instance"
# TODO use 'AYON_INSTANCE_ID' when all hosts support it
self.data["id"] = AVALON_INSTANCE_ID
self.data["family"] = self.family
self.data["asset"] = asset
self.data["subset"] = name

2
client/ayon_core/tools/subsetmanager/README.md
View file

@ -14,6 +14,6 @@ Host is expected to implemented:
- `list_instances` - returning list of dictionaries (instances), must contain
unique uuid field
example:
```[{"uuid":"15","active":true,"subset":"imageBG","family":"image","id":"pyblish.avalon.instance","asset":"Town"}]```
```[{"uuid":"15","active":true,"subset":"imageBG","family":"image","id":"ayon.create.instance","asset":"Town"}]```
- `remove_instance(instance)` - removes instance from file's metadata
instance is a dictionary, with uuid field