Add a @plugin decorator for plugins.

Plugins are really just callables that accept a replay as the first
argument. This decorator allows you to curry configuration parameters
for later calls to the plugin.

Author: GraylinKim

sc2reader/plugins/replay.py

@@ -7,14 +7,15 @@
 from sc2reader import log_utils
 from sc2reader.utils import Length
 from sc2reader.events import SelectionEvent, HotkeyEvent, AddToHotkeyEvent, GetFromHotkeyEvent, SetToHotkeyEvent
-from sc2reader.plugins.utils import PlayerSelection, GameState, JSONDateEncoder
+from sc2reader.plugins.utils import PlayerSelection, GameState, JSONDateEncoder, plugin
 
+@plugin
 def toJSON(replay, **user_options):
     options = dict(cls=JSONDateEncoder)
     options.update(user_options)
     return json.dumps(toDict(replay), **options)
 
-
+@plugin
 def toDict(replay):
     # Build observers into dictionary
     observers = list()
@@ -79,7 +80,7 @@ def toDict(replay):
         'observers': observers
     }
 
-
+@plugin
 def APMTracker(replay):
     efilter = lambda event: getattr(event,'is_player_action',False)
     for player in replay.players:
@@ -90,7 +91,7 @@ def APMTracker(replay):
             player.apm[event.second/60] += 1
         player.avg_apm = sum(player.apm.values())/float(len(player.apm.keys()))
 
-
+@plugin
 def SelectionTracker(replay):
     logger = log_utils.get_logger(SelectionTracker)
     efilter = lambda e: isinstance(e, SelectionEvent) or isinstance(e, HotkeyEvent)

sc2reader/plugins/utils.py

@@ -1,9 +1,22 @@
 from __future__ import absolute_import
 
 import json
+from functools import wraps
 from datetime import datetime
 from sc2reader import log_utils
 
+from functools import wraps
+def plugin(func):
+    @wraps(func)
+    def wrapper(**options):
+        @wraps(func)
+        def call(*args, **kwargs):
+            opt = kwargs.copy()
+            opt.update(options)
+            return func(*args, **opt)
+        return call
+    return wrapper
+
 class JSONDateEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, datetime):