Refactor and documentation.

This commit is contained in:
luxick
2018-02-27 18:59:17 +01:00
parent 2c2fea82fd
commit 1e4e319ecc
11 changed files with 117 additions and 111 deletions

View File

@@ -1,7 +1,14 @@
"""
This module contains shorthand functions for common queries to ease access from the UI
"""
from dsst_sql.sql import *
def get_episodes_for_season(season_id):
def get_episodes_for_season(season_id: int) -> list:
"""Load list of episodes for a specific season
:param season_id: ID of a season
:return: List of sql.Episode or empty list
"""
try:
return list(Season.get(Season.id == season_id).episodes)
except Episode.DoesNotExist:
@@ -9,6 +16,11 @@ def get_episodes_for_season(season_id):
def get_player_deaths_for_season(season_id: int, player_id: int) -> int:
"""Load all the aggregate count of all deaths for a player in a given season
:param season_id: ID of a season
:param player_id: ID of a player
:return: Number of deaths of the player in the season
"""
deaths = 0
for episode in list(Season.get(Season.id == season_id).episodes):
deaths = deaths + len([death for death in list(episode.deaths) if death.player.id == player_id])
@@ -16,7 +28,25 @@ def get_player_deaths_for_season(season_id: int, player_id: int) -> int:
def get_player_victories_for_season(season_id: int, player_id: int) -> int:
"""Load all the aggregate count of all victories for a player in a given season
:param season_id: ID of a season
:param player_id: ID of a player
:return: Number of all victories of the player in the season
"""
victories = 0
for episode in list(Season.get(Season.id == season_id).episodes):
victories = victories + len([vic for vic in list(episode.victories) if vic.player.id == player_id])
return victories
def create_tables():
"""Create all database tables"""
models = [Season, Episode, Player, Drink, Enemy, Death, Victory, Penalty, Episode.players.get_through_model()]
for model in models:
model.create_table()
def drop_tables():
"""Drop all data in database"""
models = [Season, Episode, Player, Drink, Enemy, Death, Victory, Penalty, Episode.players.get_through_model()]
db.drop_tables(models)