From 47c7e8634c9deafe307e25cfe4bb654851fbbb63 Mon Sep 17 00:00:00 2001
From: Roy Nieterau <roy_nieterau@hotmail.com>
Date: Thu, 18 Apr 2024 12:10:45 +0200
Subject: [PATCH] Do not expose the `event_system` on the builder directly -
 but expose the register and trigger event methods

---
 .../workfile/workfile_template_builder.py     | 60 ++++++++-----------
 1 file changed, 26 insertions(+), 34 deletions(-)

diff --git a/client/ayon_core/pipeline/workfile/workfile_template_builder.py b/client/ayon_core/pipeline/workfile/workfile_template_builder.py
index b27b614579..22a4c984bc 100644
--- a/client/ayon_core/pipeline/workfile/workfile_template_builder.py
+++ b/client/ayon_core/pipeline/workfile/workfile_template_builder.py
@@ -247,14 +247,6 @@ class AbstractTemplateBuilder(object):
             self._log = Logger.get_logger(repr(self))
         return self._log
 
-    @property
-    def event_system(self):
-        """Event System of the Workfile templatee builder.
-        Returns:
-            EventSystem: The event system.
-        """
-        return self._event_system
-
     def refresh(self):
         """Reset cached data."""
 
@@ -743,7 +735,7 @@ class AbstractTemplateBuilder(object):
                 placeholder.set_finished()
 
             # Trigger on_depth_processed event
-            self.event_system.emit(
+            self.trigger_event(
                 topic="template.depth_processed",
                 data={
                     "depth": iter_counter,
@@ -771,7 +763,7 @@ class AbstractTemplateBuilder(object):
                 placeholders.append(placeholder)
 
         # Trigger on_finished event
-        self.event_system.emit(
+        self.trigger_event(
             topic="template.finished",
             data={
                 "depth": iter_counter,
@@ -905,6 +897,30 @@ class AbstractTemplateBuilder(object):
             "create_first_version": create_first_version
         }
 
+    def trigger_event(self, topic, data=None, source=None):
+        self._event_system.emit(topic, data, source)
+
+    def register_event_callback(self, topic, callback, order=None):
+        self._event_system.add_callback(topic, callback, order=order)
+
+    def register_on_finished_callback(
+            self, callback, order=None
+    ):
+        self.register_event_callback(
+            topic="template.finished",
+            callback=callback,
+            order=order
+        )
+
+    def register_on_depth_processed_callback(
+            self, callback, order=None
+    ):
+        self.register_event_callback(
+            topic="template.depth_processed",
+            callback=callback,
+            order=order
+        )
+
 
 @six.add_metaclass(ABCMeta)
 class PlaceholderPlugin(object):
@@ -1135,30 +1151,6 @@ class PlaceholderPlugin(object):
         plugin_data[key] = value
         self.builder.set_shared_populate_data(self.identifier, plugin_data)
 
-    def register_on_finished_callback(
-            self, placeholder, callback, order=None
-    ):
-        self.register_callback(
-            placeholder,
-            topic="template.finished",
-            callback=callback,
-            order=order
-        )
-
-    def register_on_depth_processed_callback(
-            self, placeholder, callback, order=None
-    ):
-        self.register_callback(
-            placeholder,
-            topic="template.depth_processed",
-            callback=callback,
-            order=order
-        )
-
-    def register_callback(self, placeholder, topic, callback, order=None):
-        self.log.debug("Registering '%s' callback: %s", topic, callback)
-        self.builder.event_system.add_callback(topic, callback, order=order)
-
 
 class PlaceholderItem(object):
     """Item representing single item in scene that is a placeholder to process.