Adds sc2reader.exceptions.ParseError for parse errors.

Author: GraylinKim

sc2reader/exceptions.py

@@ -18,6 +18,9 @@ def __init__(self, msg, type, code, location, replay=None,  game_events=[], buff
     def __str__(self):
         return "{0}, Type: {1}, Code: {2}".format(self.msg, self.type, self.code)
 
+class ParseError(SC2ReaderError):
+    pass
+
 class ProcessError(SC2ReaderError):
     pass
 

sc2reader/parsers.py

@@ -3,7 +3,7 @@
 
 from .objects import *
 from .utils import BIG_ENDIAN,LITTLE_ENDIAN
-
+from .exceptions import ParseError
 
 class SetupParser(object):
     def parse_join_event(self, buffer, frames, type, code, pid):
@@ -131,7 +131,7 @@ def parse_ability_event(self, buffer, frames, type, code, pid):
                 return UnknownLocationAbilityEvent(frames, pid, type, code, None)
 
             else:
-                raise TypeError("Unknown atype & 0x40: flag %X at frame %X" % (flag,frames))
+                raise ParseError("Unknown atype & 0x40: flag %X at frame %X" % (flag,frames))
 
         elif atype & 0x80: # right-click on target?
             # ability (2), object id (4), object type (2), ?? (10)
@@ -154,10 +154,10 @@ def parse_ability_event(self, buffer, frames, type, code, pid):
         else:
             # print hex(atype)
             # print hex(buffer.cursor)
-            raise TypeError()
+            raise ParseError()
 
         # print "%s - %s" % (hex(atype),hex(flag))
-        raise TypeError("Shouldn't be here EVER!")
+        raise ParseError("Shouldn't be here EVER!")
 
     def parse_selection_event(self, buffer, frames, type, code, pid):
         bank = code >> 4
@@ -210,7 +210,7 @@ def parse_hotkey_event(self, buffer, frames, type, code, pid):
         elif action == 2:
             return GetHotkeyEvent(frames, pid, type, code, hotkey, overlay)
         else:
-            raise TypeError("Hotkey Action '{0}' unknown")
+            raise ParseError("Hotkey Action '{0}' unknown")
 
 class ActionParser_18574(ActionParser_16561):
     def parse_ability_event(self, buffer, frames, type, code, pid):
@@ -282,10 +282,10 @@ def parse_ability_event(self, buffer, frames, type, code, pid):
         else:
             # print hex(atype)
             # print hex(buffer.cursor)
-            raise TypeError()
+            raise ParseError()
 
         # print "%s - %s" % (hex(atype),hex(flag))
-        raise TypeError("Shouldn't be here EVER!")
+        raise ParseError("Shouldn't be here EVER!")
 
 class Unknown2Parser(object):
     def parse_0206_event(self, buffer, frames, type, code, pid):

sc2reader/readers.py

@@ -1,7 +1,7 @@
 from .parsers import *
 from .objects import *
 from .utils import AttributeDict, LITTLE_ENDIAN
-import exceptions
+from .exceptions import ParseError, ReadError
 
 class InitDataReader(object):
     def __call__(self,buffer, replay):
@@ -237,16 +237,16 @@ def __call__(self, buffer, replay):
                 # If the type is not a key in the PARSERS lookup table we
                 # probably incorrectly parsed the previous event
                 # TODO: Raise an error instead an store the previous event
-                raise exceptions.ReadError("Unknown event type", type, code, start, replay, game_events, buffer)
+                raise ReadError("Unknown event type", type, code, start, replay, game_events, buffer)
 
-            except TypeError:
+            except ParseError:
                 # For some reason, the type handler that we delegated to didn't
                 # recognize the event code that we extracated.
                 # TODO: Do something meaningful here
-                raise exceptions.ReadError("Unknown event code", type, code, start, replay, game_events, buffer)
+                raise ReadError("Unknown event code", type, code, start, replay, game_events, buffer)
 
-            except exceptions.ReadError as e:
-                raise exceptions.ReadError(e.msg, replay, game_events, buffer, start)
+            except ReadError as e:
+                raise ReadError(e.msg, replay, game_events, buffer, start)
 
             # Because events are parsed in a bitwise fashion, they sometimes
             # leave the buffer in a bitshifted state. Each new event always
@@ -265,7 +265,7 @@ def get_setup_parser(self, code):
         elif code in (0x05,): return self.parse_start_event
         else:
             # TODO: Raise a better error
-            raise exceptions.ReadError("Unknown Setup Parser Code {0}".format(code))
+            raise ReadError("Unknown Setup Parser Code {0}".format(code))
 
     def get_action_parser(self, code):
         # The action events are always associated with a particular player and
@@ -277,7 +277,7 @@ def get_action_parser(self, code):
         elif code & 0x0F == 0xF: return self.parse_transfer_event
         else:
             # TODO: Raise a better error
-            raise exceptions.ReadError("Unknown Action Parser Code {0}".format(code))
+            raise ReadError("Unknown Action Parser Code {0}".format(code))
 
     def get_unknown2_parser(self, code):
         # While its unclear what these events represent, they are MUCH more
@@ -288,7 +288,7 @@ def get_unknown2_parser(self, code):
         elif code == 0x0E: return self.parse_020E_event
         else:
             # TODO: Raise a better error
-            raise exceptions.ReadError("Unknown Unknown2 Parser Code {0}".format(code))
+            raise ReadError("Unknown Unknown2 Parser Code {0}".format(code))
 
     def get_camera_parser(self, code):
         # Each player's camera control events are recorded, separately from the
@@ -301,7 +301,7 @@ def get_camera_parser(self, code):
         elif code == 0x0a: return self.parse_camera0A_event
         else:
             # TODO: Raise a better error
-            raise exceptions.ReadError("Unknown Camera Parser Code {0}".format(code))
+            raise ReadError("Unknown Camera Parser Code {0}".format(code))
 
     def get_unknown4_parser(self, code):
         # I don't know anything about these events. Any parse information for
@@ -317,7 +317,7 @@ def get_unknown4_parser(self, code):
         elif code & 0x0F == 0x0C: return self.parse_04XC_event
         else:
             # TODO: Raise a better error
-            raise exceptions.ReadError("Unknown Unknown4 Parser Code {0}".format(code))
+            raise ReadError("Unknown Unknown4 Parser Code {0}".format(code))
 
 # The storage format for many of the game events has changed, sometimes
 # dramatically, over time. To handle this inconsistency sc2reader uses mixins