From f4e2fbbec7318eb8aff9eb6493f364f35f68b8d2 Mon Sep 17 00:00:00 2001 From: Jago Gardiner <jagogardiner@gmail.com> Date: Mon, 24 Apr 2023 14:12:15 +0100 Subject: [PATCH] More documentation and removal of unused file Change-Id: I421cdb93863d097c795836f239247623e2cd054b Signed-off-by: Jago Gardiner <jagogardiner@gmail.com> --- data/csv.py | 35 ------------------------------- data/teams.py | 58 +++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 52 insertions(+), 41 deletions(-) delete mode 100644 data/csv.py diff --git a/data/csv.py b/data/csv.py deleted file mode 100644 index 4a97c02..0000000 --- a/data/csv.py +++ /dev/null @@ -1,35 +0,0 @@ -import csv - -web_output = "" # Empty output string -players = [] # List of all the players -# Could POTENTIALLY have a list for each of those below if we choose this route - - -with open("players_file.csv", "r") as csv_file: - r_csv = csv.reader(csv_file) - - next(r_csv) # skips the headers - - # Allows for direct access to each column - for dict in r_csv: - name = dict[0] - dob = dict[1] - gender = dict[2] - d_signed = dict[3] - curr_team = dict[4] - t_locale = dict[5] - t_manager = dict[6] - salary = dict[7] - st_contract = dict[8] - len_contract = dict[9] - num_games = dict[10] - wins = dict[11] - game1 = dict[12] - game2 = dict[13] - game3 = dict[14] - game4 = dict[15] - game5 = dict[16] - - players.append(name) # Adds to the the list - - web_output += f"<p>{len(players)}, {name} <p>\n" diff --git a/data/teams.py b/data/teams.py index 53668bb..60c21dd 100644 --- a/data/teams.py +++ b/data/teams.py @@ -12,7 +12,7 @@ from .player import ( ) -def team_player_list(team_name) -> list: +def team_player_list(team_name: str) -> list: """Return a list of players for a team. Args: @@ -34,7 +34,16 @@ def team_player_list(team_name) -> list: return team_players -def team_win_percentage_base(team_name) -> float: +def team_win_percentage_base(team_name: str) -> float: + """ + Calculate the base (fg0) win percentage of a team. + + Args: + team_name (str): Team name + + Returns: + float: Win percentage + """ players = team_player_list(team_name) # Calculate the win percentage for each player @@ -46,7 +55,17 @@ def team_win_percentage_base(team_name) -> float: return int(round(sum(win_percentage) / len(win_percentage), 2) * 100) -def team_win_percentage_last_5(team_name) -> list[float]: +def team_win_percentage_last_5(team_name: str) -> list[float]: + """ + Calculate the win percentage of a team per the last 5 games. + + Args: + team_name (str): Team name + + Returns: + list[float]: Win percentage per the last 5 games and the affect on the + overall win percentage. + """ players = team_player_list(team_name) # Calculate the win percentage for each player @@ -77,7 +96,16 @@ def team_win_percentage_last_5(team_name) -> list[float]: } -def team_win_percentage_overall(team_name) -> float: +def team_win_percentage_overall(team_name: str) -> float: + """ + Calculate the overall win percentage of a team. + + Args: + team_name (str): Team name + + Returns: + float: Win percentage + """ players = team_player_list(team_name) # Calculate the win percentage for each player @@ -89,7 +117,16 @@ def team_win_percentage_overall(team_name) -> float: return int(round(sum(win_percentage) / len(win_percentage), 2)) -def team_transfer_value_avr(team_name) -> float: +def team_transfer_value_avr(team_name: str) -> float: + """ + Calculate the average transfer value of a team. + + Args: + team_name (str): Team name + + Returns: + float: Transfer value + """ players = team_player_list(team_name) # Calculate the transfer value for each player @@ -101,7 +138,16 @@ def team_transfer_value_avr(team_name) -> float: return int(round(sum(transfer_values) / len(transfer_values))) -def team_transfer_value_last_5(team_name) -> float: +def team_transfer_value_last_5(team_name: str) -> float: + """ + Calculate the average transfer value of a team over the last 5 games. + + Args: + team_name (str): Team name + + Returns: + float: Transfer value + """ players = team_player_list(team_name) # Calculate the transfer value for each player -- GitLab