From 9260a80cb0becbf322a78ad431a7de45b8f29836 Mon Sep 17 00:00:00 2001
From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>
Date: Tue, 20 Aug 2024 19:14:53 +0200
Subject: [PATCH] require addon name and version

---
 client/ayon_core/addon/base.py  | 29 +++++++++++++++++------------
 client/ayon_core/addon/utils.py |  8 ++++----
 2 files changed, 21 insertions(+), 16 deletions(-)

diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py
index e627fb2b38..494c0f3da7 100644
--- a/client/ayon_core/addon/base.py
+++ b/client/ayon_core/addon/base.py
@@ -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
 
diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py
index 32b42bf1e2..1dea4cc4fe 100644
--- a/client/ayon_core/addon/utils.py
+++ b/client/ayon_core/addon/utils.py
@@ -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.