Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2026-01-01 16:34:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

require addon name and version

Browse source
This commit is contained in:
Jakub Trllo 2024-08-20 19:14:53 +02:00
parent 173b2f2727
commit 9260a80cb0
2 changed files with 21 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

29
client/ayon_core/addon/base.py
View file

@ -81,17 +81,22 @@ class ProcessPreparationError(Exception):
class ProcessContext:
"""Context of child process.
"""Hold context of process that is going to be started.
Notes:
This class is used to pass context to child process. It can be used
to use different behavior of addon based on information in
the context.
The context can be enhanced in future versions.
Right now the context is simple, having information about addon that wants
to trigger preparation and possibly project name for which it should
happen.
Preparation for process can be required for ayon-core or any other addon.
It can be, change of environment variables, or request login to
a project management.
At the moment of creation is 'ProcessContext' only data holder, but that
might change in future if there will be need.
Args:
addon_name (Optional[str]): Addon name which triggered process.
addon_version (Optional[str]): Addon version which triggered process.
addon_name (str): Addon name which triggered process.
addon_version (str): Addon version which triggered process.
project_name (Optional[str]): Project name. Can be filled in case
process is triggered for specific project. Some addons can have
different behavior based on project. Value is NOT autofilled.
@ -101,16 +106,16 @@ class ProcessContext:
"""
def __init__(
self,
addon_name: Optional[str] = None,
addon_version: Optional[str] = None,
addon_name: str = None,
addon_version: str = None,
project_name: Optional[str] = None,
headless: Optional[bool] = None,
**kwargs,
):
if headless is None:
headless = is_headless_mode_enabled()
self.addon_name: Optional[str] = addon_name
self.addon_version: Optional[str] = addon_version
self.addon_name: str = addon_name
self.addon_version: str = addon_version
self.project_name: Optional[str] = project_name
self.headless: bool = headless

8
client/ayon_core/addon/utils.py
View file

@ -152,8 +152,8 @@ def ensure_addons_are_process_context_ready(
def ensure_addons_are_process_ready(
addon_name: Optional[str] = None,
addon_version: Optional[str] = None,
addon_name: str,
addon_version: str,
project_name: Optional[str] = None,
headless: Optional[bool] = None,
addons_manager: Optional[AddonsManager] = None,
@ -167,8 +167,8 @@ def ensure_addons_are_process_ready(
should not be created.
Args:
addon_name (Optional[str]): Addon name which triggered process.
addon_version (Optional[str]): Addon version which triggered process.
addon_name (str): Addon name which triggered process.
addon_version (str): Addon version which triggered process.
project_name (Optional[str]): Project name. Can be filled in case
process is triggered for specific project. Some addons can have
different behavior based on project. Value is NOT autofilled.