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

rename decorator and add more information to the example

Browse source
This commit is contained in:
Jakub Trllo 2025-10-20 14:58:26 +02:00
parent 5fd5b73e91
commit 882c0bcc6a
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
client/ayon_core/pipeline/create/product_name.py
View file

@ -166,11 +166,21 @@ def _get_product_name_old(
)
def _get_product_name_decorator(func):
def _backwards_compatibility_product_name(func):
"""Helper to decide which variant of 'get_product_name' to use.
The old version expected 'task_name' and 'task_type' arguments. The new
version expects 'folder_entity' and 'task_entity' arguments instead.
The function is also marked with an attribute 'version' so other addons
can check if the function is using the new signature or is using
the old signature. That should allow addons to adapt to new signature.
>>> if getattr(get_product_name, "use_entities", None):
>>> # New signature is used
>>> path = get_product_name(project_name, folder_entity, ...)
>>> else:
>>> # Old signature is used
>>> path = get_product_name(project_name, taks_name, ...)
"""
# Add attribute to function to identify it as the new function
# so other addons can easily identify it.
@ -206,7 +216,7 @@ def _get_product_name_decorator(func):
return inner
@_get_product_name_decorator
@_backwards_compatibility_product_name
def get_product_name(
project_name: str,
folder_entity: dict[str, Any],