Fix up sc2replayer and add object.__str__ methods.

Closes #137.

Author: GraylinKim

sc2reader/objects.py

@@ -53,6 +53,9 @@ def hash(self):
         raw_hash = ','.join(sorted(p.url for p in self.players))
         return hashlib.sha256(raw_hash).hexdigest()
 
+    def __str__(self):
+        return "Team {0}".format(self.number)
+
 
 class Attribute(object):
 
@@ -251,6 +254,9 @@ def __init__(self, sid, slot_data, uid, init_data, pid):
         #: The player id of the observer. Only meaningful in pre 2.0.4 replays
         self.pid = pid
 
+    def __str__(self):
+        return "Observer {0} - {1}".format(self.uid, self.name)
+
 
 class Computer(Entity, Player):
     """
@@ -267,6 +273,9 @@ def __init__(self, sid, slot_data, pid, detail_data, attribute_data):
         #: The auto-generated in-game name for this computer player
         self.name = detail_data.name
 
+    def __str__(self):
+        return "Player {0} - {1} ({2})".format(self.pid, self.name, self.play_race)
+
 
 class Participant(Entity, User, Player):
     """
@@ -283,6 +292,9 @@ def __init__(self, sid, slot_data, uid, init_data, pid, detail_data, attribute_d
         User.__init__(self, uid, init_data)
         Player.__init__(self, pid, detail_data, attribute_data)
 
+    def __str__(self):
+        return "Player {0} - {1} ({2})".format(self.pid, self.name, self.play_race)
+
 
 class PlayerSummary():
     """

sc2reader/scripts/sc2replayer.py

@@ -1,63 +1,69 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import sys, os, re
-# import termios
-# import fcntl
-
+try:
+    # Assume that we are on *nix or Mac
+    import termios
+    import fcntl
+    import os
+    import sys
+
+    def getch():
+        fd = sys.stdin.fileno()
+        oldterm = termios.tcgetattr(fd)
+        newattr = termios.tcgetattr(fd)
+        newattr[3] = newattr[3] & ~termios.ICANON & ~termios.ECHO
+        termios.tcsetattr(fd, termios.TCSANOW, newattr)
+        oldflags = fcntl.fcntl(fd, fcntl.F_GETFL)
+        fcntl.fcntl(fd, fcntl.F_SETFL, oldflags | os.O_NONBLOCK)
+        try:
+            while 1:
+                try:
+                    sys.stdin.read(1)
+                    break
+                except IOError:
+                    pass
+        finally:
+            termios.tcsetattr(fd, termios.TCSAFLUSH, oldterm)
+            fcntl.fcntl(fd, fcntl.F_SETFL, oldflags)
+
+except ImportError as e:
+    try:
+        # Opps, we might be on windows, try this one
+        from msvcrt import getch
+    except ImportError as e:
+        # We can't make getch happen, just dump events to the screen
+        getch = lambda: True
+
+
+import argparse
 import sc2reader
 from sc2reader.events import *
 
-def myGetch():
-    sys.stdin.read(1)
-
-    # fd = sys.stdin.fileno()
-    # oldterm = termios.tcgetattr(fd)
-    # newattr = termios.tcgetattr(fd)
-    # newattr[3] = newattr[3] & ~termios.ICANON & ~termios.ECHO
-    # termios.tcsetattr(fd, termios.TCSANOW, newattr)
-    # oldflags = fcntl.fcntl(fd, fcntl.F_GETFL)
-    # fcntl.fcntl(fd, fcntl.F_SETFL, oldflags | os.O_NONBLOCK)
-    # try:
-    #     while 1:
-    #         try:
-    #             c = sys.stdin.read(1)
-    #             break
-    #         except IOError: pass
-    # finally:
-    #     termios.tcsetattr(fd, termios.TCSAFLUSH, oldterm)
-    #     fcntl.fcntl(fd, fcntl.F_SETFL, oldflags)
-
-def get_args():
-    import argparse
 
+def main():
     parser = argparse.ArgumentParser(
         description="""Step by step replay of game events; shows only the
         Initialization, Ability, and Selection events by default. Press any
-        key to advance through the events in sequential order.""",
-        epilog="And that's all folks")
-
-    parser.add_argument('FILE',type=str,
-        help="The file you would like to replay")
-    parser.add_argument('--player',default=0, type=int,
-        help="The number of the player you would like to watch. Defaults to 0 (All).")
-    parser.add_argument('--bytes',default=False,action="store_true",
-        help="Displays the byte code of the event in hex after each event.")
-    parser.add_argument('--hotkeys',default=False,action="store_true",
-        help="Shows the hotkey events in the event stream.")
-    parser.add_argument('--cameras',default=False,action="store_true",
-        help="Shows the camera events in the event stream.")
+        key to advance through the events in sequential order."""
+    )
 
-    return parser.parse_args()
+    parser.add_argument('FILE', type=str, help="The file you would like to replay")
+    parser.add_argument('--player', default=0, type=int, help="The number of the player you would like to watch. Defaults to 0 (All).")
+    parser.add_argument('--bytes', default=False, action="store_true", help="Displays the byte code of the event in hex after each event.")
+    parser.add_argument('--hotkeys', default=False, action="store_true", help="Shows the hotkey events in the event stream.")
+    parser.add_argument('--cameras', default=False, action="store_true", help="Shows the camera events in the event stream.")
+    args = parser.parse_args()
 
-def main():
-    args = get_args()
     for filename in sc2reader.utils.get_files(args.FILE):
-        replay = sc2reader.load_replay(filename,debug=True)
+        replay = sc2reader.load_replay(filename, debug=True)
         print "Release {0}".format(replay.release_string)
-        print "{0} on {1}".format(replay.type,replay.map)
-        for player in replay.players:
-            print player
+        print "{0} on {1} at {2}".format(replay.type, replay.map_name, replay.start_time)
+        print
+        for team in replay.teams:
+            print team
+            for player in team.players:
+                print "  {0}".format(player)
         print "\n--------------------------\n\n"
 
         # Allow picking of the player to 'watch'
@@ -66,39 +72,21 @@ def main():
         else:
             events = replay.events
 
+        # Allow specification of events to `show`
         # Loop through the events
-        #data = sc2reader.config.build_data[replay.build]
         for event in events:
-            try:
-                pass
-                #event.apply(data)
-            except ValueError as e:
-                if str(e) == "Using invalid abilitiy matchup.":
-                    myGetch()
-                else:
-                    raise e
-
-            # Use their options to filter the event stream
 
-            if isinstance(event,AbilityEvent) or\
-                       isinstance(event,SelectionEvent) or\
-                       isinstance(event,PlayerJoinEvent) or\
-                       isinstance(event, PlayerLeaveEvent) or\
-                       isinstance(event,GameStartEvent) or\
-                       (args.hotkeys and isinstance(event,HotkeyEvent)) or\
-                       (args.cameras and isinstance(event,CameraEvent)):
-                '''
-                if isinstance(event, SelectionEvent) or isinstance(event, HotkeyEvent):
-                '''
+            if isinstance(event, AbilityEvent) or \
+                    isinstance(event, SelectionEvent) or \
+                    isinstance(event, PlayerLeaveEvent) or \
+                    isinstance(event, GameStartEvent) or \
+                    (args.hotkeys and isinstance(event, HotkeyEvent)) or \
+                    (args.cameras and isinstance(event, CameraEvent)):
                 print event
-                #myGetch()
+                getch()
                 if args.bytes:
                     print "\t"+event.bytes.encode('hex')
 
-                if re.search('UNKNOWN|ERROR', str(event)):
-                    myGetch()
-
-
 
 if __name__ == '__main__':
     main()