]> de.git.xonotic.org Git - xonotic/xonstat.git/blobdiff - xonstat/models/game.py
Merge pull request #27 from antzucaro/elo-ping-latency
[xonotic/xonstat.git] / xonstat / models / game.py
index 2462045dcefcfbefa38dab77cb57c27189aa50fb..18cf9e8dc6be5f9839211d7a779aaec52623cebb 100644 (file)
@@ -1,11 +1,18 @@
-from calendar import timegm
+"""
+Models related to games.
+"""
 
-from xonstat.util import pretty_date, strip_colors, html_colors
+from xonstat.models.mixins import FuzzyDateMixin, EpochMixin
+from xonstat.util import strip_colors, html_colors
 
 
-class Game(object):
-    def __init__(self, game_id=None, start_dt=None, game_type_cd=None,
-            server_id=None, map_id=None, winner=None):
+class Game(FuzzyDateMixin, EpochMixin):
+    """
+    An individual game.
+    """
+
+    def __init__(self, game_id=None, start_dt=None, game_type_cd=None, server_id=None, map_id=None,
+                 winner=None):
         self.game_id = game_id
         self.start_dt = start_dt
         self.game_type_cd = game_type_cd
@@ -14,31 +21,39 @@ class Game(object):
         self.winner = winner
 
     def __repr__(self):
-        return "<Game(%s, %s, %s, %s)>" % (self.game_id, self.start_dt, self.game_type_cd, self.server_id)
+        return "<Game({0.game_id}, {0.start_dt}, {0.game_type_cd}, {0.server_id})>".format(self)
 
     def to_dict(self):
-        return {'game_id':self.game_id, 'start':self.start_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
-                'game_type_cd':self.game_type_cd, 'server_id':self.server_id}
-
-    def fuzzy_date(self):
-        return pretty_date(self.start_dt)
-
-    def epoch(self):
-        return timegm(self.start_dt.timetuple())
+        return {
+            'game_id': self.game_id,
+            'start': self.start_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
+            'game_type_cd': self.game_type_cd,
+            'server_id': self.server_id
+        }
 
 
 class PlayerGameStat(object):
+    """
+    The individual statistics a player has gained/lost during a game.
+    """
+
     def __init__(self, player_game_stat_id=None, create_dt=None):
         self.player_game_stat_id = player_game_stat_id
         self.create_dt = create_dt
 
     def __repr__(self):
-        return "<PlayerGameStat(%s, %s, %s)>" % (self.player_id, self.game_id, self.create_dt)
+        return "<PlayerGameStat({0.player_id}, {0.game_id}, {0.create_dt})>".format(self)
 
     def to_dict(self):
-        return {'player_id':self.player_id, 'game_id':self.game_id,
-            'create_dt':self.create_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
-            'alivetime':self.alivetime, 'rank':self.rank, 'score':self.score, 'team':self.team}
+        return {
+            'player_id': self.player_id,
+            'game_id': self.game_id,
+            'create_dt': self.create_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
+            'alivetime': self.alivetime,
+            'rank': self.rank,
+            'score': self.score,
+            'team': self.team
+        }
 
     def nick_stripped(self):
         if self.nick is None:
@@ -64,6 +79,10 @@ class PlayerGameStat(object):
 
 
 class PlayerWeaponStat(object):
+    """
+    The metrics for a single weapon in a game for a player.
+    """
+
     def __init__(self, player_id=None, game_id=None, weapon_cd=None):
         self.player_id = player_id
         self.game_id = game_id
@@ -75,41 +94,47 @@ class PlayerWeaponStat(object):
         self.frags = 0
 
     def __repr__(self):
-        return "<PlayerWeaponStat(%s, %s, %s)>" % (self.player_weapon_stats_id, self.player_id, self.game_id)
+        return ("<PlayerWeaponStat({0.player_weapon_stats_id}, {0.player_id}, {0.game_id})>"
+                .format(self))
 
     def to_dict(self):
         return {
-            'weapon_cd':self.weapon_cd,
-            'player_weapon_stats_id':self.player_weapon_stats_id,
-            'player_id':self.player_id,
-            'game_id':self.game_id,
-            'fired':self.fired,
-            'max':self.max,
-            'hit':self.hit,
-            'actual':self.actual,
-            'frags':self.frags,
+            'weapon_cd': self.weapon_cd,
+            'player_weapon_stats_id': self.player_weapon_stats_id,
+            'player_id': self.player_id,
+            'game_id': self.game_id,
+            'fired': self.fired,
+            'max': self.max,
+            'hit': self.hit,
+            'actual': self.actual,
+            'frags': self.frags,
         }
 
 
 class TeamGameStat(object):
+    """
+    Team level metrics.
+    """
+
     def __init__(self, team_game_stat_id=None, create_dt=None):
         self.team_game_stat_id = team_game_stat_id
         self.create_dt = create_dt
 
     def __repr__(self):
-        return "<TeamGameStat(%s, %s, %s)>" % (self.team_game_stat_id, self.game_id, self.team)
+        return "<TeamGameStat({0.team_game_stat_id}, {0.game_id}, {0.team})>".format(self)
 
     def to_dict(self):
         return {
-            'team_game_stat_id':self.team_game_stat_id,
-            'game_id':self.game_id,
-            'team':self.team,
-            'score':self.score,
-            'rounds':self.rounds,
-            'caps':self.caps,
-            'create_dt':self.create_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
+            'team_game_stat_id': self.team_game_stat_id,
+            'game_id': self.game_id,
+            'team': self.team,
+            'score': self.score,
+            'rounds': self.rounds,
+            'caps': self.caps,
+            'create_dt': self.create_dt.strftime('%Y-%m-%dT%H:%M:%SZ'),
         }
 
+    # TODO: move this function to util
     def team_html_color(self):
         if self.team == 5:
             return "red"
@@ -122,29 +147,48 @@ class TeamGameStat(object):
 
 
 class PlayerGameAnticheat(object):
-    def __init__(self, player_id=None, game_id=None, key=None,
-            value=None, create_dt=None):
-        self.player_id                = player_id
-        self.game_id                  = game_id
-        self.key                      = key
-        self.value                    = value
-        self.create_dt                = create_dt
+    """
+    Anticheat metrics sent by the server to identify odd patterns.
+    """
+
+    def __init__(self, player_id=None, game_id=None, key=None, value=None, create_dt=None):
+        self.player_id = player_id
+        self.game_id = game_id
+        self.key = key
+        self.value = value
+        self.create_dt = create_dt
 
     def __repr__(self):
-        return "<PlayerGameAnticheat(%s, %d)>" % (self.key, self.value)
+        return "<PlayerGameAnticheat({0.key}, {0.value})>".format(self)
 
 
 class GameType(object):
+    """
+    A particular type of game.
+    """
+
     def __repr__(self):
-        return "<GameType(%s, %s, %s)>" % (self.game_type_cd, self.descr, self.active_ind)
+        return "<GameType({0.game_type_cd}, {0.descr}, {0.active_ind})>".format(self)
 
     def to_dict(self):
-        return {'game_type_cd':self.game_type_cd, 'name':self.descr, 'active':self.active_ind}
+        return {
+            'game_type_cd': self.game_type_cd,
+            'name': self.descr,
+            'active': self.active_ind,
+        }
 
 
 class Weapon(object):
+    """
+    A particular type of weapon.
+    """
+
     def __repr__(self):
-        return "<Weapon(%s, %s, %s)>" % (self.weapon_cd, self.descr, self.active_ind)
+        return "<Weapon({0.weapon_cd}, {0.descr}, {0.active_ind})>".format(self)
 
     def to_dict(self):
-        return {'weapon_cd':self.weapon_cd, 'name':self.descr, 'active':self.active_ind}
\ No newline at end of file
+        return {
+            'weapon_cd': self.weapon_cd,
+            'name': self.descr,
+            'active': self.active_ind,
+        }
\ No newline at end of file