Improve replay events parse speed by 20+%.

Moves loggers from instance variables to event class variables,
dramatically reducing calls to the (apparently slow) getLogger
function. See pull request 46 for more details:

    GraylinKim#46

Thanks @fbulens.

Author: GraylinKim

sc2reader/events.py

@@ -2,11 +2,11 @@
 
 from sc2reader.utils import Length, LITTLE_ENDIAN
 from sc2reader.data.utils import DataObject
-from sc2reader import log_utils
+from sc2reader.log_utils import loggable
 
+@loggable
 class Event(object):
     def __init__(self, frame, pid):
-        self.logger = log_utils.get_logger(self.__class__)
         self.pid = pid
         self.frame = frame
         self.second = frame >> 4
@@ -18,6 +18,7 @@ def load_context(self, replay):
         if self.pid != 16:
             self.player = replay.person[self.pid]
 
+@loggable
 class GameEvent(Event):
     """Abstract Event Type, should not be directly instanciated"""
     def __init__(self, frame, pid, event_type, event_code):
@@ -43,11 +44,13 @@ def __str__(self):
 # Message Events
 #########################
 
+@loggable
 class MessageEvent(Event):
     def __init__(self, frame, pid, flags):
         super(MessageEvent, self).__init__(frame, pid)
         self.flags=flags
 
+@loggable
 class ChatEvent(MessageEvent):
     def __init__(self, frame, pid, flags, buffer):
         super(ChatEvent, self).__init__(frame, pid, flags)
@@ -60,6 +63,7 @@ def __init__(self, frame, pid, flags, buffer):
         self.to_all = (self.target == 0)
         self.to_allies = (self.target == 2)
 
+@loggable
 class PacketEvent(MessageEvent):
     def __init__(self, frame, pid, flags, buffer):
         super(PacketEvent, self).__init__(frame, pid, flags)
@@ -68,6 +72,7 @@ def __init__(self, frame, pid, flags, buffer):
         # send over the network to establish latency or connectivity.
         self.data = buffer.read_chars(4)
 
+@loggable
 class PingEvent(MessageEvent):
     def __init__(self, frame, pid, flags, buffer):
         super(PingEvent, self).__init__(frame, pid, flags)
@@ -100,6 +105,7 @@ class CameraMovementEvent(GameEvent):
 class PlayerActionEvent(GameEvent):
     pass
 
+@loggable
 class ResourceTransferEvent(PlayerActionEvent):
     def __init__(self, frames, pid, type, code, target, minerals, vespene):
         super(ResourceTransferEvent, self).__init__(frames, pid, type, code)
@@ -116,6 +122,7 @@ def load_context(self, replay):
         self.sender = replay.player[self.sender]
         self.reciever = replay.player[self.reciever]
 
+@loggable
 class AbilityEvent(PlayerActionEvent):
     def __init__(self, framestamp, player, type, code, ability):
         super(AbilityEvent, self).__init__(framestamp, player, type, code)
@@ -140,6 +147,7 @@ def __str__(self):
             ability_name = self.data.ability(self.ability) if self.ability in self.data.abilities else "UNKNOWN"
             return self._str_prefix() + "Ability (%s) - %s" % (hex(self.ability), ability_name)
 
+@loggable
 class TargetAbilityEvent(AbilityEvent):
     def __init__(self, framestamp, player, type, code, ability, target):
         super(TargetAbilityEvent, self).__init__(framestamp, player, type, code, ability)
@@ -172,6 +180,7 @@ def __str__(self):
 
         return AbilityEvent.__str__(self) + "; Target: {0}".format(target)
 
+@loggable
 class LocationAbilityEvent(AbilityEvent):
     def __init__(self, framestamp, player, type, code, ability, location):
         super(LocationAbilityEvent, self).__init__(framestamp, player, type, code, ability)
@@ -183,6 +192,7 @@ def __str__(self):
 class SelfAbilityEvent(AbilityEvent):
     pass
 
+@loggable
 class HotkeyEvent(PlayerActionEvent):
     def __init__(self, framestamp, player, type, code, hotkey, deselect):
         super(HotkeyEvent, self).__init__(framestamp, player, type, code)
@@ -198,6 +208,7 @@ class AddToHotkeyEvent(HotkeyEvent):
 class GetFromHotkeyEvent(HotkeyEvent):
     pass
 
+@loggable
 class SelectionEvent(PlayerActionEvent):
     def __init__(self, framestamp, player, type, code, bank, objects, deselect):
         super(SelectionEvent, self).__init__(framestamp, player, type, code)
@@ -228,4 +239,4 @@ def load_context(self, replay):
 
                 objects.append(obj)
 
-        self.objects = objects
+        self.objects = objects

sc2reader/log_utils.py

@@ -46,4 +46,8 @@ def get_logger(entity):
 
     except AttributeError as e:
         msg = "Cannot retrieve logger for {0}. Only strings, classes, and functions supported."
-        raise TypeError(msg.format(entity))
+        raise TypeError(msg.format(entity))
+
+def loggable(cls):
+    cls.logger = get_logger(cls)
+    return cls