Merge pull request #81 from ynput/enhancement/OP-8208_Use-folderPath-during-publishing

Chore: Use 'folderPath' instead of 'asset' during publishing
This commit is contained in:
Jakub Trllo 2024-02-21 12:48:54 +01:00 committed by GitHub
commit 38883078ed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
75 changed files with 155 additions and 142 deletions

View file

@ -98,7 +98,7 @@ class CollectAERender(publish.AbstractCollectRender):
source=current_file,
label="{} - {}".format(subset_name, family),
subset=subset_name,
asset=inst.data["asset"],
folderPath=inst.data["folderPath"],
task=task_name,
attachTo=False,
setMembers='',
@ -175,7 +175,7 @@ class CollectAERender(publish.AbstractCollectRender):
version_str = "v{:03d}".format(render_instance.version)
if "#" not in file_name: # single frame (mov)W
path = os.path.join(base_dir, "{}_{}_{}.{}".format(
render_instance.asset,
render_instance.folderPath,
render_instance.subset,
version_str,
ext
@ -184,7 +184,7 @@ class CollectAERender(publish.AbstractCollectRender):
else:
for frame in range(start, end + 1):
path = os.path.join(base_dir, "{}_{}_{}.{}.{}".format(
render_instance.asset,
render_instance.folderPath,
render_instance.subset,
version_str,
str(frame).zfill(self.padding_width),

View file

@ -50,11 +50,11 @@ class CollectWorkfile(pyblish.api.ContextPlugin):
asset_entity = context.data["assetEntity"]
project_entity = context.data["projectEntity"]
asset_name = get_asset_name_identifier(asset_entity)
folder_path = get_asset_name_identifier(asset_entity)
instance_data = {
"active": True,
"asset": asset_name,
"folderPath": folder_path,
"task": task,
"frameStart": context.data['frameStart'],
"frameEnd": context.data['frameEnd'],

View file

@ -30,7 +30,7 @@ class ValidateInstanceAssetRepair(pyblish.api.Action):
for instance in instances:
data = stub.read(instance[0])
data["asset"] = get_current_asset_name()
data["folderPath"] = get_current_asset_name()
stub.imprint(instance[0].instance_id, data)
@ -53,7 +53,7 @@ class ValidateInstanceAsset(pyblish.api.InstancePlugin):
order = ValidateContentsOrder
def process(self, instance):
instance_asset = instance.data["asset"]
instance_asset = instance.data["folderPath"]
current_asset = get_current_asset_name()
msg = (
f"Instance asset {instance_asset} is not the same "

View file

@ -22,7 +22,9 @@ class CreateAction(plugin.BaseCreator):
)
# Get instance name
name = plugin.prepare_scene_name(instance_data["asset"], subset_name)
name = plugin.prepare_scene_name(
instance_data["folderPath"], subset_name
)
if pre_create_data.get("use_selection"):
for obj in lib.get_selection():

View file

@ -22,7 +22,7 @@ class CollectCelactionInstances(pyblish.api.ContextPlugin):
asset_name = get_asset_name_identifier(asset_entity)
shared_instance_data = {
"asset": asset_name,
"folderPath": asset_name,
"frameStart": asset_entity["data"]["frameStart"],
"frameEnd": asset_entity["data"]["frameEnd"],
"handleStart": asset_entity["data"]["handleStart"],

View file

@ -34,7 +34,7 @@ class CollecTimelineOTIO(pyblish.api.ContextPlugin):
project_settings=context.data["project_settings"]
)
asset_name = get_asset_name_identifier(asset_doc)
folder_path = get_asset_name_identifier(asset_doc)
# adding otio timeline to context
with opfapi.maintained_segment_selection(sequence) as selected_seg:
@ -42,7 +42,7 @@ class CollecTimelineOTIO(pyblish.api.ContextPlugin):
instance_data = {
"name": subset_name,
"asset": asset_name,
"folderPath": folder_path,
"subset": subset_name,
"family": "workfile",
"families": []

View file

@ -55,7 +55,7 @@ class ExtractProductResources(publish.Extractor):
# flame objects
segment = instance.data["item"]
asset_name = instance.data["asset"]
folder_path = instance.data["folderPath"]
segment_name = segment.name.get_value()
clip_path = instance.data["path"]
sequence_clip = instance.context.data["flameSequence"]
@ -249,7 +249,7 @@ class ExtractProductResources(publish.Extractor):
out_mark = in_mark + source_duration_handles
exporting_clip = self.import_clip(clip_path)
exporting_clip.name.set_value("{}_{}".format(
asset_name, segment_name))
folder_path, segment_name))
# add xml tags modifications
modify_xml_data.update({

View file

@ -168,10 +168,10 @@ class IntegrateBatchGroup(pyblish.api.InstancePlugin):
handle_start = instance.data["handleStart"]
handle_end = instance.data["handleEnd"]
frame_duration = (frame_end - frame_start) + 1
asset_name = instance.data["asset"]
folder_path = instance.data["folderPath"]
task_name = task_data["name"]
batchgroup_name = "{}_{}".format(asset_name, task_name)
batchgroup_name = "{}_{}".format(folder_path, task_name)
batch_data = {
"shematic_reels": [

View file

@ -68,7 +68,7 @@ class CollectFusionRender(
source=current_file,
label=inst.data["label"],
subset=subset_name,
asset=inst.data["asset"],
folderPath=inst.data["folderPath"],
task=task_name,
attachTo=False,
setMembers='',

View file

@ -72,7 +72,7 @@ class FusionRenderLocal(
self.log.info(
"Rendered '{nm}' for asset '{ast}' under the task '{tsk}'".format(
nm=instance.data["name"],
ast=instance.data["asset"],
ast=instance.data["folderPath"],
tsk=instance.data["task"],
)
)

View file

@ -21,7 +21,9 @@ class ValidateUniqueSubsets(pyblish.api.ContextPlugin):
# Collect instances per subset per asset
instances_per_subset_asset = defaultdict(lambda: defaultdict(list))
for instance in context:
asset = instance.data.get("asset", context.data.get("asset"))
asset = instance.data.get(
"folderPath", context.data.get("folderPath")
)
subset = instance.data.get("subset", context.data.get("subset"))
instances_per_subset_asset[asset][subset].append(instance)

View file

@ -98,7 +98,7 @@ class CollectFarmRender(publish.AbstractCollectRender):
self_name = self.__class__.__name__
asset_name = context.data["asset"]
folder_path = context.data["folderPath"]
for node in context.data["allNodes"]:
data = harmony.read(node)
@ -142,7 +142,7 @@ class CollectFarmRender(publish.AbstractCollectRender):
source=context.data["currentFile"],
label=node.split("/")[1],
subset=subset_name,
asset=asset_name,
folderPath=folder_path,
task=task_name,
attachTo=False,
setMembers=[node],

View file

@ -31,7 +31,7 @@ class CollectPalettes(pyblish.api.ContextPlugin):
if (not any([re.search(pattern, task_name)
for pattern in self.allowed_tasks])):
return
asset_name = context.data["asset"]
folder_path = context.data["folderPath"]
for name, id in palettes.items():
instance = context.create_instance(name)
@ -39,7 +39,7 @@ class CollectPalettes(pyblish.api.ContextPlugin):
"id": id,
"family": "harmony.palette",
'families': [],
"asset": asset_name,
"folderPath": folder_path,
"subset": "{}{}".format("palette", name)
})
self.log.info(

View file

@ -36,5 +36,5 @@ class CollectWorkfile(pyblish.api.ContextPlugin):
"family": family,
"families": [family],
"representations": [],
"asset": context.data["asset"]
"folderPath": context.data["folderPath"]
})

View file

@ -27,9 +27,10 @@ class ValidateInstanceRepair(pyblish.api.Action):
# Apply pyblish.logic to get the instances for the plug-in
instances = pyblish.api.instances_by_plugin(failed, plugin)
folder_path = get_current_asset_name()
for instance in instances:
data = harmony.read(instance.data["setMembers"][0])
data["asset"] = get_current_asset_name()
data["folderPath"] = folder_path
harmony.imprint(instance.data["setMembers"][0], data)
@ -42,7 +43,7 @@ class ValidateInstance(pyblish.api.InstancePlugin):
order = ValidateContentsOrder
def process(self, instance):
instance_asset = instance.data["asset"]
instance_asset = instance.data["folderPath"]
current_asset = get_current_asset_name()
msg = (
"Instance asset is not the same as current asset:"

View file

@ -118,9 +118,9 @@ class CollectClipEffects(pyblish.api.InstancePlugin):
data["subset"] = name
data["family"] = family
data["families"] = [family]
data["name"] = data["subset"] + "_" + data["asset"]
data["name"] = data["subset"] + "_" + data["folderPath"]
data["label"] = "{} - {}".format(
data['asset'], data["subset"]
data["folderPath"], data["subset"]
)
data["effects"] = effects

View file

@ -102,7 +102,7 @@ class CollectFrameTagInstances(pyblish.api.ContextPlugin):
# first collect all available subset tag frames
subset_data = {}
context_asset_doc = context.data["assetEntity"]
context_asset_name = get_asset_name_identifier(context_asset_doc)
context_folder_path = get_asset_name_identifier(context_asset_doc)
for tag_data in sequence_tags:
frame = int(tag_data["start"])
@ -120,7 +120,7 @@ class CollectFrameTagInstances(pyblish.api.ContextPlugin):
subset_data[subset] = {
"frames": [frame],
"format": tag_data["format"],
"asset": context_asset_name
"folderPath": context_folder_path
}
return subset_data
@ -133,7 +133,7 @@ class CollectFrameTagInstances(pyblish.api.ContextPlugin):
"label": "{} {}".format(name, subset_data["frames"]),
"family": "image",
"families": ["frame"],
"asset": subset_data["asset"],
"folderPath": subset_data["folderPath"],
"subset": name,
"format": subset_data["format"],
"frames": subset_data["frames"]

View file

@ -57,7 +57,7 @@ class ExtractClipEffects(publish.Extractor):
"sourceStart", "sourceStartH", "sourceEnd", "sourceEndH",
"frameStart", "frameEnd",
"clipIn", "clipOut", "clipInH", "clipOutH",
"asset", "version"
"folderPath", "version"
]
# pass data to version

View file

@ -98,7 +98,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
data.update({
"name": "{}_{}".format(asset, subset),
"label": label,
"asset": asset,
"folderPath": asset,
"asset_name": asset_name,
"item": track_item,
"families": families,
@ -189,7 +189,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not hierarchy_data:
return
asset = data["asset"]
asset = data["folderPath"]
asset_name = data["asset_name"]
# insert family into families
@ -241,7 +241,6 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not master_layer:
return
asset = data.get("asset")
item = data.get("item")
clip_name = item.name()
@ -249,7 +248,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not self.test_any_audio(item):
return
asset = data["asset"]
asset = data["folderPath"]
asset_name = data["asset_name"]
# insert family into families

View file

@ -17,7 +17,7 @@ class PrecollectWorkfile(pyblish.api.ContextPlugin):
order = pyblish.api.CollectorOrder - 0.491
def process(self, context):
asset = context.data["asset"]
asset = context.data["folderPath"]
asset_name = asset.split("/")[-1]
active_timeline = hiero.ui.activeSequence()
@ -64,7 +64,7 @@ class PrecollectWorkfile(pyblish.api.ContextPlugin):
"label": "{} - {}Main".format(
asset, family),
"name": "{}_{}".format(asset_name, family),
"asset": context.data["asset"],
"folderPath": context.data["folderPath"],
# TODO use 'get_subset_name'
"subset": "{}{}Main".format(asset_name, family.capitalize()),
"item": project,

View file

@ -72,7 +72,7 @@ class CollectInstances(pyblish.api.ContextPlugin):
# Create nice name if the instance has a frame range.
label = data.get("name", node.name())
label += " (%s)" % data["asset"] # include asset in name
label += " (%s)" % data["folderPath"] # include folder in name
instance = context.create_instance(label)

View file

@ -55,7 +55,7 @@ class CollectUsdBootstrap(pyblish.api.InstancePlugin):
self.log.debug("Add bootstrap for: %s" % bootstrap)
project_name = instance.context.data["projectName"]
asset_name = instance.data["asset"]
asset_name = instance.data["folderPath"]
asset_doc = get_asset_by_name(project_name, asset_name)
assert asset_doc, "Asset must exist: %s" % asset_name
@ -95,7 +95,7 @@ class CollectUsdBootstrap(pyblish.api.InstancePlugin):
new.data["optional"] = False
# Copy some data from the instance for which we bootstrap
for key in ["asset"]:
for key in ["folderPath"]:
new.data[key] = instance.data[key]
def _subset_exists(self, project_name, instance, subset_name, asset_doc):
@ -107,7 +107,7 @@ class CollectUsdBootstrap(pyblish.api.InstancePlugin):
for inst in context:
if (
inst.data["subset"] == subset_name
and inst.data["asset"] == asset_doc_name
and inst.data["folderPath"] == asset_doc_name
):
return True

View file

@ -55,7 +55,7 @@ class CollectUsdLayers(pyblish.api.InstancePlugin):
layer_inst.data["families"] = [family]
layer_inst.data["subset"] = "__stub__"
layer_inst.data["label"] = label
layer_inst.data["asset"] = instance.data["asset"]
layer_inst.data["folderPath"] = instance.data["folderPath"]
layer_inst.data["instance_node"] = instance.data["instance_node"]
# include same USD ROP
layer_inst.append(rop_node)

View file

@ -285,7 +285,7 @@ class ExtractUSDLayered(publish.Extractor):
# to detect whether we should make this into a new publish
# version. If not, skip it.
asset = get_asset_by_name(
project_name, dependency.data["asset"], fields=["_id"]
project_name, dependency.data["folderPath"], fields=["_id"]
)
subset = get_subset_by_name(
project_name,

View file

@ -18,7 +18,7 @@ class ValidateUSDShadeModelExists(pyblish.api.InstancePlugin):
def process(self, instance):
project_name = instance.context.data["projectName"]
asset_name = instance.data["asset"]
asset_name = instance.data["folderPath"]
subset = instance.data["subset"]
# Assume shading variation starts after a dot separator

View file

@ -94,7 +94,7 @@ class CollectRender(pyblish.api.InstancePlugin):
renderer = str(renderer_class).split(":")[0]
# also need to get the render dir for conversion
data = {
"asset": instance.data["asset"],
"folderPath": instance.data["folderPath"],
"subset": str(instance.name),
"publish": True,
"maxversion": str(get_max_version()),

View file

@ -15,7 +15,7 @@ class GenerateUUIDsOnInvalidAction(pyblish.api.Action):
receive new UUIDs are actually invalid.
Requires:
- instance.data["asset"]
- instance.data["folderPath"]
"""
@ -78,7 +78,7 @@ class GenerateUUIDsOnInvalidAction(pyblish.api.Action):
# should be always available, but kept a way to query it by name.
asset_doc = instance.data.get("assetEntity")
if not asset_doc:
asset_name = instance.data["asset"]
asset_name = instance.data["folderPath"]
project_name = instance.context.data["projectName"]
self.log.info((
"Asset is not stored on instance."

View file

@ -24,7 +24,8 @@ from ayon_core.client import (
get_asset_by_name,
get_subsets,
get_last_versions,
get_representation_by_name
get_representation_by_name,
get_asset_name_identifier,
)
from ayon_core.settings import get_project_settings
from ayon_core.pipeline import (
@ -3143,21 +3144,25 @@ def fix_incompatible_containers():
def update_content_on_context_change():
"""
This will update scene content to match new asset on context change
This will update scene content to match new folder on context change
"""
scene_sets = cmds.listSets(allSets=True)
asset_doc = get_current_project_asset()
new_asset = asset_doc["name"]
new_folder_path = get_asset_name_identifier(asset_doc)
new_data = asset_doc["data"]
for s in scene_sets:
try:
if cmds.getAttr("{}.id".format(s)) == "pyblish.avalon.instance":
attr = cmds.listAttr(s)
print(s)
if "asset" in attr:
print(" - setting asset to: [ {} ]".format(new_asset))
cmds.setAttr("{}.asset".format(s),
new_asset, type="string")
if "folderPath" in attr:
print(
" - setting folder to: [ {} ]".format(new_folder_path)
)
cmds.setAttr(
"{}.folderPath".format(s),
new_folder_path, type="string"
)
if "frameStart" in attr:
cmds.setAttr("{}.frameStart".format(s),
new_data["frameStart"])

View file

@ -307,7 +307,7 @@ class CollectMayaRender(pyblish.api.InstancePlugin):
_instance.data["version"] = context.data["version"]
# Define nice label
label = "{0} ({1})".format(layer_name, instance.data["asset"])
label = "{0} ({1})".format(layer_name, instance.data["folderPath"])
label += " [{0}-{1}]".format(
int(data["frameStartHandle"]), int(data["frameEndHandle"])
)

View file

@ -99,7 +99,7 @@ class CollectVrayScene(pyblish.api.InstancePlugin):
instance.data.update(data)
# Define nice label
label = "{0} ({1})".format(layer_name, instance.data["asset"])
label = "{0} ({1})".format(layer_name, instance.data["folderPath"])
label += " [{0}-{1}]".format(
int(data["frameStartHandle"]), int(data["frameEndHandle"])
)

View file

@ -61,7 +61,7 @@ class ExtractUnrealSkeletalMeshFbx(publish.Extractor):
# we rely on hierarchy under one root.
original_parent = to_extract[0].split("|")[1]
parent_node = instance.data.get("asset")
parent_node = instance.data.get("folderPath")
# this needs to be done for AYON
# WARNING: since AYON supports duplicity of asset names,
# this needs to be refactored throughout the pipeline.

View file

@ -37,7 +37,7 @@ class ValidateInstanceInContext(pyblish.api.InstancePlugin,
if not self.is_active(instance.data):
return
asset = instance.data.get("asset")
asset = instance.data.get("folderPath")
context_asset = self.get_context_asset(instance)
if asset != context_asset:
raise PublishValidationError(
@ -74,4 +74,4 @@ class ValidateInstanceInContext(pyblish.api.InstancePlugin,
@staticmethod
def get_context_asset(instance):
return instance.context.data["asset"]
return instance.context.data["folderPath"]

View file

@ -51,7 +51,7 @@ class ValidateShaderName(pyblish.api.InstancePlugin,
descendants = cmds.ls(descendants, noIntermediate=True, long=True)
shapes = cmds.ls(descendants, type=["nurbsSurface", "mesh"], long=True)
asset_name = instance.data.get("asset")
asset_name = instance.data.get("folderPath")
# Check the number of connected shadingEngines per shape
regex_compile = re.compile(cls.regex)

View file

@ -23,10 +23,10 @@ class ValidateCorrectAssetContext(
current asset (shot). This validator checks if this is so. It is optional
so it can be disabled when needed.
Checking `asset` and `task` keys.
Checking `folderPath` and `task` keys.
"""
order = ValidateContentsOrder
label = "Validate asset context"
label = "Validate Folder context"
hosts = ["nuke"]
actions = [
RepairAction,
@ -85,7 +85,7 @@ class ValidateCorrectAssetContext(
"""Get invalid keys from instance data and context data."""
invalid_keys = []
testing_keys = ["asset", "task"]
testing_keys = ["folderPath", "task"]
for _key in testing_keys:
if _key not in instance.data:
invalid_keys.append(_key)

View file

@ -120,7 +120,7 @@ class PhotoshopServerStub:
"subset":"imageBG",
"family":"image",
"id":"pyblish.avalon.instance",
"asset":"Town",
"folderPath":"Town",
"uuid": "8"
}] - for created instances
OR
@ -421,7 +421,7 @@ class PhotoshopServerStub:
example:
{"8":{"active":true,"subset":"imageBG",
"family":"image","id":"pyblish.avalon.instance",
"asset":"Town"}}
"folderPath":"Town"}}
8 is layer(group) id - used for deletion, update etc.
"""
res = self.websocketserver.call(self.client.call('Photoshop.read'))

View file

@ -28,7 +28,7 @@ class CollectAutoImage(pyblish.api.ContextPlugin):
task_name = context.data["task"]
host_name = context.data["hostName"]
asset_doc = context.data["assetEntity"]
asset_name = get_asset_name_identifier(asset_doc)
folder_path = get_asset_name_identifier(asset_doc)
auto_creator = proj_settings.get(
"photoshop", {}).get(
@ -86,7 +86,7 @@ class CollectAutoImage(pyblish.api.ContextPlugin):
instance = context.create_instance(subset_name)
instance.data["family"] = family
instance.data["asset"] = asset_name
instance.data["folderPath"] = folder_path
instance.data["subset"] = subset_name
instance.data["ids"] = publishable_ids
instance.data["publish"] = True

View file

@ -67,7 +67,7 @@ class CollectAutoReview(pyblish.api.ContextPlugin):
host_name = context.data["hostName"]
asset_doc = context.data["assetEntity"]
asset_name = get_asset_name_identifier(asset_doc)
folder_path = get_asset_name_identifier(asset_doc)
subset_name = get_subset_name(
family,
@ -87,7 +87,7 @@ class CollectAutoReview(pyblish.api.ContextPlugin):
"family": family,
"families": [],
"representations": [],
"asset": asset_name,
"folderPath": folder_path,
"publish": self.publish
})

View file

@ -71,7 +71,7 @@ class CollectAutoWorkfile(pyblish.api.ContextPlugin):
host_name = context.data["hostName"]
asset_doc = context.data["assetEntity"]
asset_name = get_asset_name_identifier(asset_doc)
folder_path = get_asset_name_identifier(asset_doc)
subset_name = get_subset_name(
family,
variant,
@ -91,7 +91,7 @@ class CollectAutoWorkfile(pyblish.api.ContextPlugin):
"family": family,
"families": [],
"representations": [],
"asset": asset_name
"folderPath": folder_path
})
# creating representation

View file

@ -2,7 +2,7 @@
Provides:
context -> Loaded batch file.
- asset
- folderPath
- task (task name)
- taskType
- project_name
@ -71,7 +71,7 @@ class CollectBatchData(pyblish.api.ContextPlugin):
os.environ["AYON_FOLDER_PATH"] = asset_name
os.environ["AYON_TASK_NAME"] = task_name
context.data["asset"] = asset_name
context.data["folderPath"] = asset_name
context.data["task"] = task_name
context.data["taskType"] = task_type
context.data["project_name"] = project_name

View file

@ -56,7 +56,7 @@ class CollectColorCodedInstances(pyblish.api.ContextPlugin):
existing_subset_names = self._get_existing_subset_names(context)
# from CollectBatchData
asset_name = context.data["asset"]
asset_name = context.data["folderPath"]
task_name = context.data["task"]
variant = context.data["variant"]
project_name = context.data["projectEntity"]["name"]
@ -163,7 +163,7 @@ class CollectColorCodedInstances(pyblish.api.ContextPlugin):
instance = context.create_instance(layer.name)
instance.data["family"] = family
instance.data["publish"] = True
instance.data["asset"] = asset
instance.data["folderPath"] = asset
instance.data["task"] = task_name
instance.data["subset"] = subset
instance.data["layer"] = layer

View file

@ -31,7 +31,7 @@ class ValidateInstanceAssetRepair(pyblish.api.Action):
current_asset_name = get_current_asset_name()
for instance in instances:
data = stub.read(instance[0])
data["asset"] = current_asset_name
data["folderPath"] = current_asset_name
stub.imprint(instance[0], data)
@ -54,7 +54,7 @@ class ValidateInstanceAsset(OptionalPyblishPluginMixin,
order = ValidateContentsOrder
def process(self, instance):
instance_asset = instance.data["asset"]
instance_asset = instance.data["folderPath"]
current_asset = get_current_asset_name()
if instance_asset != current_asset:

View file

@ -519,7 +519,7 @@ def imprint(timeline_item, data=None):
Examples:
data = {
'asset': 'sq020sh0280',
'folderPath': 'sq020sh0280',
'family': 'render',
'subset': 'subsetMain'
}

View file

@ -66,7 +66,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
data.update({
"name": "{}_{}".format(asset, subset),
"label": "{} {}".format(asset, subset),
"asset": asset,
"folderPath": asset,
"item": timeline_item,
"publish": get_publish_attribute(timeline_item),
"fps": context.data["fps"],
@ -124,7 +124,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
if not hierarchy_data:
return
asset = data["asset"]
asset = data["folderPath"]
subset = "shotMain"
# insert family into families
@ -134,7 +134,7 @@ class PrecollectInstances(pyblish.api.ContextPlugin):
"name": "{}_{}".format(asset, subset),
"label": "{} {}".format(asset, subset),
"subset": subset,
"asset": asset,
"folderPath": asset,
"family": family,
"families": [],
"publish": get_publish_attribute(timeline_item)

View file

@ -28,7 +28,7 @@ class PrecollectWorkfile(pyblish.api.ContextPlugin):
instance_data = {
"name": "{}_{}".format(asset_name, subset),
"label": "{} {}".format(current_asset_name, subset),
"asset": current_asset_name,
"folderPath": current_asset_name,
"subset": subset,
"item": project,
"family": "workfile",

View file

@ -27,8 +27,8 @@ class CollectTextureSet(pyblish.api.InstancePlugin):
config = self.get_export_config(instance)
asset_doc = get_asset_by_name(
project_name=instance.context.data["projectName"],
asset_name=instance.data["asset"]
instance.context.data["projectName"],
instance.data["folderPath"]
)
instance.data["exportConfig"] = config

View file

@ -53,7 +53,7 @@ class OnlineCreator(TrayPublishCreator):
# disable check for existing subset with the same name
"""
asset = get_asset_by_name(
self.project_name, instance_data["asset"], fields=["_id"])
self.project_name, instance_data["folderPath"], fields=["_id"])
if get_subset_by_name(
self.project_name, origin_basename, asset["_id"],

View file

@ -17,7 +17,7 @@ class CollectShotInstance(pyblish.api.InstancePlugin):
families = ["shot"]
SHARED_KEYS = [
"asset",
"folderPath",
"fps",
"handleStart",
"handleEnd",
@ -132,7 +132,7 @@ class CollectShotInstance(pyblish.api.InstancePlugin):
"sourceIn": _cr_attrs["sourceIn"],
"sourceOut": _cr_attrs["sourceOut"],
"workfileFrameStart": workfile_start_frame,
"asset": _cr_attrs["folderPath"],
"folderPath": _cr_attrs["folderPath"],
}
def _solve_hierarchy_context(self, instance):
@ -170,7 +170,7 @@ class CollectShotInstance(pyblish.api.InstancePlugin):
parents = instance.data.get('parents', [])
# Split by '/' for AYON where asset is a path
asset_name = instance.data["asset"].split("/")[-1]
asset_name = instance.data["folderPath"].split("/")[-1]
actual = {asset_name: in_info}
for parent in reversed(parents):

View file

@ -40,7 +40,7 @@ class ValidateExistingVersion(
formatting_data = {
"subset_name": subset_name,
"asset_name": instance.data["asset"],
"asset_name": instance.data["folderPath"],
"version": version
}
raise PublishXmlValidationError(

View file

@ -65,7 +65,7 @@ class CollectWorkfileData(pyblish.api.ContextPlugin):
# Collect and store current context to have reference
current_context = {
"project_name": context.data["projectName"],
"asset_name": context.data["asset"],
"asset_name": context.data["folderPath"],
"task_name": context.data["task"]
}
self.log.debug("Current context is: {}".format(current_context))
@ -105,7 +105,7 @@ class CollectWorkfileData(pyblish.api.ContextPlugin):
))
# Store context asset name
context.data["asset"] = asset_name
context.data["folderPath"] = asset_name
context.data["task"] = task_name
self.log.info(
"Context is set to Asset: \"{}\" and Task: \"{}\"".format(

View file

@ -20,7 +20,7 @@ class FixAssetNames(pyblish.api.Action):
on = "failed"
def process(self, context, plugin):
context_asset_name = context.data["asset"]
context_asset_name = context.data["folderPath"]
old_instance_items = list_instances()
new_instance_items = []
for instance_item in old_instance_items:
@ -51,9 +51,9 @@ class ValidateAssetName(
def process(self, context):
if not self.is_active(context.data):
return
context_asset_name = context.data["asset"]
context_asset_name = context.data["folderPath"]
for instance in context:
asset_name = instance.data.get("asset")
asset_name = instance.data.get("folderPath")
if asset_name and asset_name == context_asset_name:
continue

View file

@ -64,7 +64,7 @@ class CollectRenderInstances(pyblish.api.InstancePlugin):
new_data = new_instance.data
new_data["asset"] = seq_name
new_data["folderPath"] = seq_name
new_data["setMembers"] = seq_name
new_data["family"] = "render"
new_data["families"] = ["render", "review"]

View file

@ -112,7 +112,7 @@ class ProcessSubmittedCacheJobOnFarm(pyblish.api.InstancePlugin,
output_dir = self._get_publish_folder(
anatomy,
deepcopy(instance.data["anatomyData"]),
instance.data.get("asset"),
instance.data.get("folderPath"),
instance.data["subset"],
instance.context,
instance.data["family"],
@ -126,7 +126,7 @@ class ProcessSubmittedCacheJobOnFarm(pyblish.api.InstancePlugin,
environment = {
"AYON_PROJECT_NAME": instance.context.data["projectName"],
"AYON_FOLDER_PATH": instance.context.data["asset"],
"AYON_FOLDER_PATH": instance.context.data["folderPath"],
"AYON_TASK_NAME": instance.context.data["task"],
"AYON_USERNAME": instance.context.data["user"],
"AYON_LOG_NO_COLORS": "1",
@ -359,7 +359,7 @@ class ProcessSubmittedCacheJobOnFarm(pyblish.api.InstancePlugin,
# publish job file
publish_job = {
"asset": instance_skeleton_data["asset"],
"folderPath": instance_skeleton_data["folderPath"],
"frameStart": instance_skeleton_data["frameStart"],
"frameEnd": instance_skeleton_data["frameEnd"],
"fps": instance_skeleton_data["fps"],

View file

@ -189,7 +189,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin,
output_dir = self._get_publish_folder(
anatomy,
deepcopy(instance.data["anatomyData"]),
instance.data.get("asset"),
instance.data.get("folderPath"),
instances[0]["subset"],
instance.context,
instances[0]["family"],
@ -203,7 +203,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin,
environment = {
"AYON_PROJECT_NAME": instance.context.data["projectName"],
"AYON_FOLDER_PATH": instance.context.data["asset"],
"AYON_FOLDER_PATH": instance.context.data["folderPath"],
"AYON_TASK_NAME": instance.context.data["task"],
"AYON_USERNAME": instance.context.data["user"],
"AYON_LOG_NO_COLORS": "1",
@ -475,7 +475,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin,
# publish job file
publish_job = {
"asset": instance_skeleton_data["asset"],
"folderPath": instance_skeleton_data["folderPath"],
"frameStart": instance_skeleton_data["frameStart"],
"frameEnd": instance_skeleton_data["frameEnd"],
"fps": instance_skeleton_data["fps"],

View file

@ -319,7 +319,7 @@ class BaseCreateRoyalRenderJob(pyblish.api.InstancePlugin,
add_kwargs = {
"project": anatomy_data["project"]["name"],
"asset": instance.context.data["asset"],
"asset": instance.context.data["folderPath"],
"task": anatomy_data["task"]["name"],
"app": instance.context.data.get("appName"),
"envgroup": "farm"

View file

@ -189,8 +189,8 @@ class CollectSequencesFromJob(pyblish.api.ContextPlugin):
"family": families[0], # backwards compatibility / pyblish
"families": list(families),
"subset": subset,
"asset": data.get(
"asset", context.data["asset"]
"folderPath": data.get(
"folderPath", context.data["folderPath"]
),
"stagingDir": root,
"frameStart": start,

View file

@ -132,7 +132,7 @@ class CreatePublishRoyalRenderJob(pyblish.api.InstancePlugin,
# publish job file
publish_job = {
"asset": instance_skeleton_data["asset"],
"folderPath": instance_skeleton_data["folderPath"],
"frameStart": instance_skeleton_data["frameStart"],
"frameEnd": instance_skeleton_data["frameEnd"],
"fps": instance_skeleton_data["fps"],
@ -180,7 +180,7 @@ class CreatePublishRoyalRenderJob(pyblish.api.InstancePlugin,
environment = RREnvList({
"AYON_PROJECT_NAME": anatomy_data["project"]["name"],
"AYON_FOLDER_PATH": instance.context.data["asset"],
"AYON_FOLDER_PATH": instance.context.data["folderPath"],
"AYON_TASK_NAME": anatomy_data["task"]["name"],
"AYON_USERNAME": anatomy_data["user"]
})

View file

@ -24,7 +24,7 @@ class StartTimer(pyblish.api.ContextPlugin):
return
project_name = context.data["projectName"]
asset_name = context.data.get("asset")
asset_name = context.data.get("folderPath")
task_name = context.data.get("task")
if not project_name or not asset_name or not task_name:
self.log.info((

View file

@ -48,7 +48,7 @@ Family tells how should be instance processed and subset what name will publishe
<Plugin name>: {...},
...
},
## Additional data related to instance (`asset`, `task`, etc.)
## Additional data related to instance (`folderPath`, `task`, etc.)
...
}
```

View file

@ -27,7 +27,7 @@ class LegacyCreator(object):
log = logging.getLogger("LegacyCreator")
log.propagate = True
def __init__(self, name, asset, options=None, data=None):
def __init__(self, name, folder_path, options=None, data=None):
self.name = name # For backwards compatibility
self.options = options
@ -35,7 +35,7 @@ class LegacyCreator(object):
self.data = collections.OrderedDict()
self.data["id"] = "pyblish.avalon.instance"
self.data["family"] = self.family
self.data["asset"] = asset
self.data["folderPath"] = folder_path
self.data["subset"] = name
self.data["active"] = True

View file

@ -32,7 +32,7 @@ def get_last_versions_for_instances(
subset_names_by_asset_name = collections.defaultdict(set)
instances_by_hierarchy = {}
for instance in instances:
asset_name = instance.data.get("asset")
asset_name = instance.data.get("folderPath")
subset_name = instance.subset_name
if not asset_name or not subset_name:
if use_value_for_missing:

View file

@ -197,7 +197,7 @@ def create_skeleton_instance(
if data.get("extendFrames", False):
time_data.start, time_data.end = extend_frames(
data["asset"],
data["folderPath"],
data["subset"],
time_data.start,
time_data.end,
@ -228,7 +228,7 @@ def create_skeleton_instance(
"family": family,
"subset": data["subset"],
"families": families,
"asset": data["asset"],
"folderPath": data["folderPath"],
"frameStart": time_data.start,
"frameEnd": time_data.end,
"handleStart": time_data.handle_start,
@ -777,7 +777,7 @@ def create_skeleton_instance_cache(instance):
if data.get("extendFrames", False):
time_data.start, time_data.end = extend_frames(
data["asset"],
data["folderPath"],
data["subset"],
time_data.start,
time_data.end,
@ -805,7 +805,7 @@ def create_skeleton_instance_cache(instance):
"family": family,
"subset": data["subset"],
"families": families,
"asset": data["asset"],
"folderPath": data["folderPath"],
"frameStart": time_data.start,
"frameEnd": time_data.end,
"handleStart": time_data.handle_start,
@ -1011,7 +1011,7 @@ def copy_extend_frames(instance, representation):
version = get_last_version_by_subset_name(
project_name,
instance.data.get("subset"),
asset_name=instance.data.get("asset")
asset_name=instance.data.get("folderPath")
)
# get its files based on extension

View file

@ -30,7 +30,7 @@ class RenderInstance(object):
label = attr.ib() # label to show in GUI
subset = attr.ib() # subset name
task = attr.ib() # task name
asset = attr.ib() # asset name
folderPath = attr.ib() # folder path
attachTo = attr.ib() # subset name to attach render to
setMembers = attr.ib() # list of nodes/members producing render output
publish = attr.ib() # bool, True to publish instance

View file

@ -3,7 +3,7 @@ Requires:
context -> anatomyData
context -> projectEntity
context -> assetEntity
instance -> asset
instance -> folderPath
instance -> subset
instance -> family
@ -68,7 +68,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
instances_with_missing_asset_doc = collections.defaultdict(list)
for instance in context:
instance_asset_doc = instance.data.get("assetEntity")
_asset_name = instance.data["asset"]
_asset_name = instance.data["folderPath"]
# There is possibility that assetEntity on instance is already set
# which can happen in standalone publisher
@ -296,7 +296,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
if hierarchy:
parent_name = hierarchy.split("/")[-1]
asset_name = instance.data["asset"].split("/")[-1]
asset_name = instance.data["folderPath"].split("/")[-1]
anatomy_data.update({
"asset": asset_name,
"hierarchy": hierarchy,
@ -337,7 +337,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
# Try to find task data based on hierarchy context and asset name
hierarchy_context = instance.context.data.get("hierarchyContext")
asset_name = instance.data.get("asset")
asset_name = instance.data.get("folderPath")
if not hierarchy_context or not asset_name:
return

View file

@ -66,7 +66,7 @@ class CollectAudio(pyblish.api.ContextPlugin):
# Add audio to instance if exists.
instances_by_asset_name = collections.defaultdict(list)
for instance in filtered_instances:
asset_name = instance.data["asset"]
asset_name = instance.data["folderPath"]
instances_by_asset_name[asset_name].append(instance)
asset_names = set(instances_by_asset_name.keys())

View file

@ -25,7 +25,7 @@ class CollectContextEntities(pyblish.api.ContextPlugin):
def process(self, context):
project_name = context.data["projectName"]
asset_name = context.data["asset"]
asset_name = context.data["folderPath"]
task_name = context.data["task"]
project_entity = get_project(project_name)

View file

@ -1,7 +1,7 @@
"""
Provides:
context -> projectName (str)
context -> asset (str)
context -> folderPath (str)
context -> task (str)
"""
@ -21,7 +21,7 @@ class CollectCurrentContext(pyblish.api.ContextPlugin):
def process(self, context):
# Check if values are already set
project_name = context.data.get("projectName")
asset_name = context.data.get("asset")
asset_name = context.data.get("folderPath")
task_name = context.data.get("task")
current_context = get_current_context()
@ -29,13 +29,12 @@ class CollectCurrentContext(pyblish.api.ContextPlugin):
context.data["projectName"] = current_context["project_name"]
if not asset_name:
context.data["asset"] = current_context["asset_name"]
context.data["folderPath"] = current_context["asset_name"]
if not task_name:
context.data["task"] = current_context["task_name"]
# QUESTION should we be explicit with keys? (the same on instances)
# - 'asset' -> 'assetName'
# - 'task' -> 'taskName'
self.log.info((
@ -45,6 +44,6 @@ class CollectCurrentContext(pyblish.api.ContextPlugin):
"Task: {task_name}"
).format(
project_name=context.data["projectName"],
asset_name=context.data["asset"],
asset_name=context.data["folderPath"],
task_name=context.data["task"]
))

View file

@ -41,7 +41,7 @@ class CollectFramesFixDef(
instance.data["frames_to_fix"] = frames_to_fix
subset_name = instance.data["subset"]
asset_name = instance.data["asset"]
asset_name = instance.data["folderPath"]
project_entity = instance.data["projectEntity"]
project_name = project_entity["name"]

View file

@ -38,7 +38,6 @@ class CollectFromCreateContext(pyblish.api.ContextPlugin):
for created_instance in create_context.instances:
instance_data = created_instance.data_to_store()
instance_data["asset"] = instance_data.pop("folderPath")
if instance_data["active"]:
thumbnail_path = thumbnail_paths_by_instance_id.get(
created_instance.id
@ -80,7 +79,7 @@ class CollectFromCreateContext(pyblish.api.ContextPlugin):
instance = context.create_instance(subset)
instance.data.update({
"subset": subset,
"asset": in_data["asset"],
"folderPath": in_data["folderPath"],
"task": in_data["task"],
"label": in_data.get("label") or subset,
"name": subset,

View file

@ -62,7 +62,7 @@ class CollectHierarchy(pyblish.api.ContextPlugin):
"pixelAspect": instance.data["pixelAspect"]
}
# Split by '/' for AYON where asset is a path
name = instance.data["asset"].split("/")[-1]
name = instance.data["folderPath"].split("/")[-1]
actual = {name: shot_data}
for parent in reversed(instance.data["parents"]):

View file

@ -71,14 +71,19 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin):
"""
# validate basic necessary data
data_err = "invalid json file - missing data"
required = ["asset", "user", "comment",
required = ["user", "comment",
"job", "instances", "version"]
assert all(elem in data.keys() for elem in required), data_err
if "folderPath" not in data and "asset" not in data:
raise AssertionError(data_err)
if "folderPath" not in data:
data["folderPath"] = data.pop("asset")
# set context by first json file
ctx = self._context.data
ctx["asset"] = ctx.get("asset") or data.get("asset")
ctx["folderPath"] = ctx.get("folderPath") or data.get("folderPath")
ctx["intent"] = ctx.get("intent") or data.get("intent")
ctx["comment"] = ctx.get("comment") or data.get("comment")
ctx["user"] = ctx.get("user") or data.get("user")
@ -87,7 +92,7 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin):
# basic sanity check to see if we are working in same context
# if some other json file has different context, bail out.
ctx_err = "inconsistent contexts in json files - %s"
assert ctx.get("asset") == data.get("asset"), ctx_err % "asset"
assert ctx.get("folderPath") == data.get("folderPath"), ctx_err % "folderPath"
assert ctx.get("intent") == data.get("intent"), ctx_err % "intent"
assert ctx.get("comment") == data.get("comment"), ctx_err % "comment"
assert ctx.get("user") == data.get("user"), ctx_err % "user"

View file

@ -45,7 +45,7 @@ class ExtractHierarchyToAYON(pyblish.api.ContextPlugin):
continue
# Skip if instance asset does not match
instance_asset_name = instance.data.get("asset")
instance_asset_name = instance.data.get("folderPath")
instances_by_asset_name[instance_asset_name].append(instance)
project_doc = context.data["projectEntity"]
@ -189,7 +189,7 @@ class ExtractHierarchyToAYON(pyblish.api.ContextPlugin):
active_folder_paths = set()
for instance in context:
if instance.data.get("publish") is not False:
active_folder_paths.add(instance.data.get("asset"))
active_folder_paths.add(instance.data.get("folderPath"))
active_folder_paths.discard(None)

View file

@ -68,7 +68,7 @@ class ExtractOtioAudioTracks(pyblish.api.ContextPlugin):
def add_audio_to_instances(self, audio_file, instances):
created_files = []
for inst in instances:
name = inst.data["asset"]
name = inst.data["folderPath"]
recycling_file = [f for f in created_files if name in f]

View file

@ -196,12 +196,13 @@ class IntegrateThumbnailsAYON(pyblish.api.ContextPlugin):
))
asset_entity = instance.data["assetEntity"]
folder_path = instance.data["folderPath"]
thumbnail_info_by_entity_id[asset_entity["_id"]] = {
"thumbnail_id": thumbnail_id,
"entity_type": "asset",
}
self.log.debug("Setting thumbnail for asset \"{}\" <{}>".format(
asset_entity["name"], version_id
self.log.debug("Setting thumbnail for folder \"{}\" <{}>".format(
folder_path, version_id
))
op_session = OperationsSession()

View file

@ -113,7 +113,7 @@ class ValidateEditorialAssetName(pyblish.api.ContextPlugin):
def get_parents(self, context):
return_dict = {}
for instance in context:
asset = instance.data["asset"]
asset = instance.data["folderPath"]
families = instance.data.get("families", []) + [
instance.data["family"]
]

View file

@ -36,7 +36,7 @@ class ValidateSubsetUniqueness(pyblish.api.ContextPlugin):
continue
# Ignore instance without asset data
asset = instance.data.get("asset")
asset = instance.data.get("folderPath")
if asset is None:
self.log.warning("Instance found without `asset` data: "
"{}".format(instance.name))