Restructure sc2reader options and option handling

Store options into an AttributeDict that gets a copy passed into each
replay object on instanciation. This will allow options to affect the
replay parsing and processing at runtime.

Author: GraylinKim

sc2reader/__init__.py

@@ -1,36 +1,31 @@
-import os
+import os, copy
 
-import copy
+import mpyq
 
-from config import FULL, PARTIAL, CUSTOM, FILES, PROCESSORS, READERS
-from mpyq import MPQArchive
+import config
 from objects import Replay
-from utils import ReplayBuffer
+from utils import ReplayBuffer, AttributeDict
 
 __version__ = "0.3.0"
 __author__ = "Graylin Kim <[email protected]>"
 
+
 class SC2Reader(object):
-    ''' Class level interface to sc2reader.
-        
-        <<usage documentation here>>
-    '''
-
-    def __init__(self, parse_type="FULL", directory="", processors=[], debug=False, files=[], verbose=False, copy=copy.copy):
-        try:
-            #Update and save the reader configuration
-            parse_type = parse_type.upper()
-            files = FILES.get(parse_type, files)
-            processors = PROCESSORS.get(parse_type, processors)
-            self.__dict__.update(locals())
-        except KeyError:
-            raise ValueError("Unrecognized parse_type `%s`" % parse_type)
+    def __init__(self, **options):
+        #Set Defaults before configuring with user options
+        self.options = AttributeDict(
+            directory="",
+            processors=[],
+            debug=False,
+            verbose=False,
+            parse_events=True)
+        self.configure(**options)
 
     def read(self, location):
-        if self.directory:
-            location = os.path.join(self.directory,location)
+        if self.options.directory:
+            location = os.path.join(self.options.directory,location)
 
-        if self.verbose: print "Reading: %s" % location
+        if self.options.verbose: print "Reading: %s" % location
 
         if os.path.isdir(location):
             #SC2Reader::read each subfile/directory and combine the lists
@@ -40,32 +35,36 @@ def read(self, location):
 
         else:
             with open(location) as replay_file:
-                replay = Replay(self.copy(self),replay_file)
-                archive = MPQArchive(location,listfile=False)
+                replay = Replay(replay_file,**self.options.copy())
+                archive = mpyq.MPQArchive(location,listfile=False)
 
                 for file in self.files:
                     buffer = ReplayBuffer(archive.read_file(file))
                     READERS[replay.build][file].read(buffer,replay)
 
-                for process in self.processors:
+                #Handle user processors after internal processors
+                for process in self.processors+self.options.processors:
                     replay = process(replay)
 
                 return replay
 
     def configure(self,**options):
-        self.__dict__.update(options)
+        self.options.update(options)
 
+        #Update system configuration
+        myconfig = config.full if self.options.parse_events else config.partial
+        self.files = myconfig.files
+        self.processors = myconfig.processors
 
-''' The package level interface is just a lightweight wrapper around a default
-    SC2Reader class. See the documentation above for usage details '''
 
+'''Package Level Interface'''
 __defaultSC2Reader = SC2Reader()
 
+#Allow options on the package level read for one off reads.
+def read(location, **options):
+    reader = SC2Reader(**options) if options else __defaultSC2Reader
+    return reader.read(location)
+
+#Allow package level configuration for lazy people
 def configure(**options):
     __defaultSC2Reader.configure(**options)
-
-def read(location, **options):
-    if options:
-        return SC2Reader(**options).read(location)
-    else:
-        return __defaultSC2Reader.read(location)

sc2reader/config.py

@@ -1,47 +1,40 @@
+from utils import AttributeDict
+
 from processors import *
 from readers import *
 
-FULL = "FULL"
-PARTIAL = "PARTIAL"
-CUSTOM = "CUSTOM"
-
-FILES = {
-    "FULL": [
-            'replay.initData',
-            'replay.details',
-            'replay.attributes.events',
-            'replay.message.events',
-            'replay.game.events'
-        ],
-
-    "PARTIAL": [
-            'replay.initData',
-            'replay.details',
-            'replay.attributes.events',
-            'replay.message.events'
-        ],
-}
-
-PROCESSORS = {
-    "FULL": [
-            PeopleProcessor,
-            AttributeProcessor,
-            TeamsProcessor,
-            MessageProcessor,
-            RecorderProcessor,
-            EventProcessor,
-            ApmProcessor,
-            ResultsProcessor,
-        ],
+full = AttributeDict(
+    files = [
+        'replay.initData',
+        'replay.details',
+        'replay.attributes.events',
+        'replay.message.events',
+        'replay.game.events'],
+    processors = [
+        PeopleProcessor,
+        AttributeProcessor,
+        TeamsProcessor,
+        MessageProcessor,
+        RecorderProcessor,
+        EventProcessor,
+        ApmProcessor,
+        ResultsProcessor],
+)
 
-    "PARTIAL": [
+partial = AttributeDict(
+    files = [
+        'replay.initData',
+        'replay.details',
+        'replay.attributes.events',
+        'replay.message.events'],
+    processors = [
             PeopleProcessor,
             AttributeProcessor,
             TeamsProcessor,
             MessageProcessor,
             RecorderProcessor,
         ],
-}
+)
 
 class ReaderMap(dict):
     def __init__(self):

sc2reader/objects.py

@@ -17,9 +17,9 @@ def __str__(self):
 
 class Replay(object):
 
-    def __init__(self, reader, replay_file):
+    def __init__(self, replay_file, **options):
         #Useful references
-        self.reader = reader
+        self.opt = options
         self.filename = replay_file.name
 
         #header information