move static methods to own class to streamline imports

Author: muppet9010

Source/Profiles.py

@@ -1,6 +1,6 @@
 import json as Json
 import os as Os
-from StreamlabsEvent import StreamlabsEvent
+from StreamlabsEvent import StreamlabsEventUtils
 
 
 class Profiles:
@@ -64,9 +64,9 @@ def __init__(self, reactionData, profile):
         if "platform" in reactionData:
             self.platform = reactionData["platform"]
             self.type = reactionData["type"]
-            self.handlerName = StreamlabsEvent.MakeHandlerString(
+            self.handlerName = StreamlabsEventUtils.MakeHandlerString(
                 self.platform, self.type)
-            if self.handlerName not in StreamlabsEvent.handledEventTypes.keys():
+            if self.handlerName not in StreamlabsEventUtils.handledEventTypes.keys():
                 self.logging.LogQuit(
                     "invalid event handler type: " + self.handlerName)
         else:
@@ -106,23 +106,23 @@ def __init__(self, filteredActionData, reaction):
         if self.condition == "":
             self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                  "' condition can not be blank")
-        eventAttributeCheckResult = StreamlabsEvent.IsBadEventAttritubeUsed(
+        eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
             self.reaction.handlerName, self.condition, False)
         if eventAttributeCheckResult != "":
             self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                  "' condition error: " + eventAttributeCheckResult)
-        scriptParseCheck = StreamlabsEvent.IsScriptValid(self.condition)
+        scriptParseCheck = StreamlabsEventUtils.IsScriptValid(self.condition)
         if scriptParseCheck != "":
             self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                  "' has an invalid condition script:\n" + scriptParseCheck)
 
         self.manipulator = filteredActionData["manipulator"]
-        eventAttributeCheckResult = StreamlabsEvent.IsBadEventAttritubeUsed(
+        eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
             self.reaction.handlerName, self.manipulator, False)
         if eventAttributeCheckResult != "":
             self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                  "' manipulator error: " + eventAttributeCheckResult)
-        scriptParseCheck = StreamlabsEvent.IsScriptValid(self.manipulator)
+        scriptParseCheck = StreamlabsEventUtils.IsScriptValid(self.manipulator)
         if scriptParseCheck != "":
             self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                  "' has an invalid manipulator script:\n" + scriptParseCheck)
@@ -134,7 +134,7 @@ def __init__(self, filteredActionData, reaction):
             actionName = action[8:-1]
             if actionName in self.reaction.profile.actions.keys():
                 self.action = self.reaction.profile.actions[actionName]
-                eventAttributeCheckResult = StreamlabsEvent.IsBadEventAttritubeUsed(
+                eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
                     self.reaction.handlerName, self.action.effect, True)
                 if eventAttributeCheckResult != "":
                     self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() + "' referenced action " +
@@ -147,7 +147,7 @@ def __init__(self, filteredActionData, reaction):
             if self.actionText == "":
                 self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
                                      "' action can not be blank")
-            eventAttributeCheckResult = StreamlabsEvent.IsBadEventAttritubeUsed(
+            eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
                 self.reaction.handlerName, self.actionText, True)
             if eventAttributeCheckResult != "":
                 self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +

Source/Streamlabs Rcon Integration.py

@@ -2,7 +2,7 @@
 from Streamlabs import Streamlabs
 from Gui import Gui, GuiWindow
 from Currency import Currency
-from StreamlabsEvent import StreamlabsEvent
+from StreamlabsEvent import StreamlabsEvent, StreamlabsEventUtils
 import json as Json
 from Config import Config
 from Profiles import Profiles
@@ -21,7 +21,7 @@ def Setup(self):
         self.donationsIdsProcessed = {}
         self.translations = Translations(self)
         self.currency = Currency(self)
-        StreamlabsEvent.LoadEventDefinitions()
+        StreamlabsEventUtils.LoadEventDefinitions()
         self.profiles = Profiles(self)
         self.streamlabs = Streamlabs(self)
         self.rcon = Rcon(self)

Source/StreamlabsEvent.py

@@ -4,8 +4,6 @@
 
 
 class StreamlabsEvent():
-    handledEventTypes = {}
-
     def __init__(self, state, data):
         self.state = state
         self.logging = state.logging
@@ -62,7 +60,7 @@ def __init__(self, state, data):
             self.platform = "streamlabs"
         elif self.platform == "twitch_account" and self.type == "subscription" and "gifter" in self.rawMessage and self.rawMessage["gifter"] != None:
             self.type = "subscription_gift"
-        self.handlerName = self.MakeHandlerString(
+        self.handlerName = StreamlabsEventUtils.MakeHandlerString(
             self.platform, self.type)
 
     @property
@@ -96,15 +94,11 @@ def __str__(self):
         return ''.join(str_list)
 
     def IsHandledEvent(self):
-        if self.handlerName in self.handledEventTypes.keys():
+        if self.handlerName in StreamlabsEventUtils.handledEventTypes.keys():
             return True
         else:
             return False
 
-    @staticmethod
-    def MakeHandlerString(platform, type):
-        return platform + "-" + type
-
     def ShouldIgnoreEvent(self):
         if (self.type == "streamlabels") or (self.type == "streamlabels.underlying") or (self.type == "alertPlaying") or (self.type == "subscription-playing") or (self.type == "rollEndCredits") or (self.type == "subMysteryGift"):
             return True
@@ -174,7 +168,7 @@ def GetEventRawTitlesAsPrettyString(self):
         return eventDesc
 
     def SubstituteEventDataIntoString(self, string, modValue="''"):
-        instances = StreamlabsEvent.FindAttributeTagsInString(string)
+        instances = StreamlabsEventUtils.FindAttributeTagsInString(string)
         for instance in instances:
             dataKeyName = instance[1:-1]
             dataKeyValue = "''"
@@ -197,9 +191,24 @@ def SubstituteEventDataIntoString(self, string, modValue="''"):
             elif dataKeyName in self.rawMessage:
                 dataKeyValue = self.rawMessage[dataKeyName]
             string = string.replace(
-                instance, StreamlabsEvent.EspaceStringForRcon(str(dataKeyValue)))
+                instance, StreamlabsEventUtils.EspaceStringForRcon(str(dataKeyValue)))
         return string
 
+
+class StreamlabsEventUtils():
+    handledEventTypes = {}
+
+    @staticmethod
+    def MakeHandlerString(platform, type):
+        return platform + "-" + type
+
+    @staticmethod
+    def EspaceStringForRcon(text):
+        text = text.replace("\\", "\\\\")
+        text = text.replace("'", "\\'")
+        text = text.replace('"', '\\"')
+        return text
+
     @staticmethod
     def FindAttributeTagsInString(string):
         return Regex.findall(r"\[[a-z_A-Z0-9]+\]", string)
@@ -209,28 +218,29 @@ def LoadEventDefinitions():
         with open("eventDefinitions.json", "r") as file:
             data = Json.load(file)
         file.closed
-        StreamlabsEvent.handledEventTypes = data
+        StreamlabsEventUtils.handledEventTypes = data
 
     @staticmethod
     def IsBadEventAttritubeUsed(eventType, string, modValueAllowed):
         if string in ["", "[ALL]", "[NOTHING]"]:
             return ""
-        instances = StreamlabsEvent.FindAttributeTagsInString(string)
+        instances = StreamlabsEventUtils.FindAttributeTagsInString(string)
         for instance in instances:
             dataKeyName = instance[1:-1]
             if dataKeyName == "MODVALUE" and not modValueAllowed:
                 return "[MODVALUE] used when not allowed"
-            if dataKeyName in StreamlabsEvent.handledEventTypes['[ALL]'].keys():
+            if dataKeyName in StreamlabsEventUtils.handledEventTypes['[ALL]'].keys():
                 continue
-            if eventType == "" or dataKeyName not in StreamlabsEvent.handledEventTypes[eventType].keys():
+            if eventType == "" or dataKeyName not in StreamlabsEventUtils.handledEventTypes[eventType].keys():
                 return instance + " not a valid attribute for this event"
         return ""
 
     @staticmethod
     def IsScriptValid(scriptString):
         if scriptString in ["", "[ALL]", "[NOTHING]"]:
             return ""
-        instances = StreamlabsEvent.FindAttributeTagsInString(scriptString)
+        instances = StreamlabsEventUtils.FindAttributeTagsInString(
+            scriptString)
         testScriptString = scriptString
         for instance in instances:
             testScriptString = testScriptString.replace(instance, str(1))
@@ -239,10 +249,3 @@ def IsScriptValid(scriptString):
         except Exception:
             return "config value: " + scriptString + "\n" + Traceback.format_exc(limit=0, chain=False)
         return ""
-
-    @staticmethod
-    def EspaceStringForRcon(text):
-        text = text.replace("\\", "\\\\")
-        text = text.replace("'", "\\'")
-        text = text.replace('"', '\\"')
-        return text