First checkpoint in validating readers, processors, and configurations via metaclass contracts

Author: GraylinKim

sc2reader/__init__.py

@@ -35,10 +35,10 @@ def read_file(filename,config=DefaultConfig()):
                 raise NotYetImplementedError("No parser was found that accepted the replay file;check configuration")
 
         #Do cleanup and post processing
-        for process in config.processors:
-            replay = process(replay)
+        for processor in config.processors:
+            replay = processor.process(replay)
 
         return replay
 
 __all__ = [DefaultConfig,read,read_file]
-__version__ = "0.1.0"
+__version__ = "0.1.0"

sc2reader/config.py

@@ -6,42 +6,71 @@
 from sc2reader.objects import Replay
 from sc2reader.processors import *
 from sc2reader.readers import *
+from sc2reader.utils import key_in_bases
 
-class DefaultConfig(object):
-    def __init__(self):
-        self.ReplayClass = Replay
-        
-        self.readers = OrderedDict()
-        self.readers['replay.initData'] = [ ReplayInitDataReader() ]
-        self.readers['replay.details'] = [ ReplayDetailsReader() ]
-        self.readers['replay.attributes.events'] = [ AttributeEventsReader_17326(), AttributeEventsReader() ]
-        self.readers['replay.message.events'] = [ MessageEventsReader() ]
-        self.readers['replay.game.events'] = [ GameEventsReader_17326(), GameEventsReader_16561(), GameEventsReader() ]
-        
-        self.processors = [
-                PeopleProcessor,
-                AttributeProcessor,
-                TeamsProcessor,
-                MessageProcessor,
-                RecorderProcessor,
-                EventProcessor,
-                ApmProcessor,
-                ResultsProcessor
-            ]
-
-class NoEventsConfig(object):
-    def __init__(self):
-        self.ReplayClass = Replay
-        self.readers = OrderedDict()
-        self.readers['replay.initData'] = [ ReplayInitDataReader() ]
-        self.readers['replay.details'] = [ ReplayDetailsReader() ]
-        self.readers['replay.attributes.events'] = [ AttributeEventsReader_17326(), AttributeEventsReader() ]
-        self.readers['replay.message.events'] = [ MessageEventsReader() ]
-
-        self.processors = [
-            PeopleProcessor,
-            AttributeProcessor,
-            TeamsProcessor,
-            MessageProcessor,
-            RecorderProcessor,
+#####################################################
+# Metaclass used to help enforce the usage contract
+#####################################################
+class MetaConfig(type):
+    def __new__(meta, class_name, bases, class_dict):
+        if class_name != 'Config': #Parent class is exempt from checks
+            assert 'ReplayClass' in class_dict or key_in_bases('ReplayClass',bases), \
+                "%s must specify 'ReplayClass' to be the class acting as a replay container" % class_name
+
+            assert 'readers' in class_dict or key_in_bases('readers',bases), \
+                "%s must specify 'dict<string,list<Reader>> readers'" % class_name
+
+            assert 'processors' in class_dict or key_in_bases('processors',bases), \
+                "%s must specify 'list<Processor> processors'" % class_name
+
+        return type.__new__(meta, class_name, bases, class_dict)
+
+class Config(object):
+    __metaclass__ = MetaConfig
+
+#####################################################
+
+class DefaultConfig(Config):
+    ReplayClass = Replay
+
+    ''' The dict([ (key1,value1),(key2,value2).... ]) method has been applied
+        here in order to keep the reading order intact
+    '''
+    readers = OrderedDict([
+            ('replay.initData', [ReplayInitDataReader()]),
+            ('replay.details', [ReplayDetailsReader()]),
+            ('replay.attributes.events', [AttributeEventsReader_17326(), AttributeEventsReader()]),
+            ('replay.message.events', [MessageEventsReader()]),
+            ('replay.game.events', [GameEventsReader_17326(), GameEventsReader_16561(), GameEventsReader()]),
+        ])
+
+    processors = [
+            PeopleProcessor(),
+            AttributeProcessor(),
+            TeamsProcessor(),
+            MessageProcessor(),
+            RecorderProcessor(),
+            EventProcessor(),
+            ApmProcessor(),
+            ResultsProcessor()
         ]
+
+#####################################################
+
+class NoEventsConfig(DefaultConfig):
+
+    readers = OrderedDict([
+            ('replay.initData', [ReplayInitDataReader()]),
+            ('replay.details', [ReplayDetailsReader()]),
+            ('replay.attributes.events', [AttributeEventsReader_17326(), AttributeEventsReader()]),
+            ('replay.message.events', [MessageEventsReader()]),       
+        ])
+
+    processors = [
+            PeopleProcessor(),
+            AttributeProcessor(),
+            TeamsProcessor(),
+            MessageProcessor(),
+            RecorderProcessor(),
+        ]
+