mcmahon.py

#! /usr/bin/env python3

# Mcmahon pairing for MGA tournament

import collections
import os
import random
import unittest

import jinja2
import yaml


AGA_RESULTS_TEMPLATE = 'aga_results_template.txt'


class Player(object):

    def __init__(self, name, rank, aga_id, mm_score, mm_init, division):
        self.name = name
        self.rank = rank
        self.aga_id = aga_id
        self.mm_score = mm_score  # list[score, sos, sodos]
        self.mm_init = mm_init
        self.division = division

    def __repr__(self):
        return ('{:s}(name={:s}, rank={:d}, aga_id={:d}, mm_score={}, mm_init={:d}, division={:d})'
                .format(self.__class__.__name__, self.name, self.rank, self.aga_id,
                        self.mm_score, self.mm_init, self.division))

    def __eq__(self, other):
        return type(other) is type(self) and self.__dict__ == other.__dict__

    def __ne__(self, other):
        return type(other) is not type(self) or self.__dict__ != other.__dict__


def player_representer(dumper, data):
    return dumper.represent_mapping('!player', data.__dict__)

yaml.add_representer(Player, player_representer)


def player_constructor(loader, node):
    player_dict = loader.construct_mapping(node)
    return Player(player_dict['name'], player_dict['rank'], player_dict['aga_id'],
                  player_dict['mm_score'], player_dict['mm_init'], player_dict['division'])

yaml.add_constructor('!player', player_constructor)


class Match(object):

    def __init__(self, white, black, winner=None):
        self.white = white
        self.black = black
        self.winner = winner

    def get_winner(self):
        return self._winner

    def set_winner(self, value):
        if value not in [self.white, self.black, None]:
            raise ValueError("'winner' must be equal to either 'white' or 'black' (or 'None')")
        self._winner = value

    winner = property(get_winner, set_winner)

    def __repr__(self):
        safe_winner = self.winner
        if safe_winner is None:
            safe_winner = "None"
        else:
            safe_winner = str(safe_winner)
        return ('<{:s}(white={:d}, black={:d}, winner={:s}>'
                .format(self.__class__.__name__, self.white, self.black, safe_winner))


class Tournament(object):

    def __init__(self, players, id_ctr, rounds, old_pairs, current_players, name, place, start,
                 end, rules):
        self.players = players
        self.id_ctr = id_ctr
        self.rounds = rounds
        self.old_pairs = old_pairs
        self.current_players = current_players
        self.name = name
        self.place = place
        self.start = start
        self.end = end
        self.rules = rules

    @classmethod
    def new_tournament(cls, players=None):
        tournament = cls({}, 0, [], set(), set(), '', '', '', '', '')
        if players is not None:
            for player in players:
                tournament.add_player(player)
        return tournament

    def calculate_mm_score(self):
        # set all mm_scores to original mm_score
        for player in self.players.values():
            player.mm_score[0] = player.mm_init  # score
            player.mm_score[1] = 0  # sos
            player.mm_score[2] = 0  # sodos

        # iterate through each board in each round, add to mm_score when winner
        for i, round_ in enumerate(self.rounds):
            if self.round_is_finished(i):
                for board in round_.values():
                    self.players[board.winner].mm_score[0] += 1  # score

        # now that all sos scores are calculated, can do sos and sodos
        # by iterating through all the boards
        for i, round_ in enumerate(self.rounds):
            if self.round_is_finished(i):
                for board in round_.values():
                    if board.winner == board.white:
                        loser = board.black
                    else:
                        loser = board.white
                    # sos
                    self.players[board.winner].mm_score[1] += self.players[loser].mm_score[0]
                    self.players[loser].mm_score[1] += self.players[board.winner].mm_score[0]
                    # sodos
                    self.players[board.winner].mm_score[2] += self.players[loser].mm_score[0]

    def standings(self):
        return sorted(list(self.players.keys()), key=lambda k: self.players[k].mm_score,
                      reverse=True)

    def __eq__(self, other):
        return type(other) is type(self) and self.__dict__ == other.__dict__

    def __ne__(self, other):
        return type(other) is not type(self) or self.__dict__ != other.__dict__

    def add_player(self, player):
        player_key = self.id_ctr
        self.players[player_key] = player
        self.current_players.add(player_key)
        self.id_ctr += 1

    def drop_player(self, player_id):
        self.current_players.remove(player_id)

    def _pairing_is_valid(self, player_list):
        valid = True
        pairs = []
        temp_list = list(player_list)
        while temp_list:
            pairs.append(frozenset([temp_list.pop(), temp_list.pop()]))
        for pair in pairs:
            if pair in self.old_pairs:
                valid = False
                break
        return valid

    def pairing_score(self, player_list):
        # measures sum of difference of mm_score per pairing
        # assumes even number of people?
        score = 0
        temp_list = list(player_list)
        while temp_list:
            score += abs(self.players[temp_list.pop()].mm_score[0] -
                         self.players[temp_list.pop()].mm_score[0])
        return score

    def generate_pairing(self, sample_size):
        # populate old pairs set, skip if first round
        if self.rounds:
            for match in self.rounds[-1].values():
                self.old_pairs.add(frozenset([match.black, match.white]))

        # Generate candidate pairings for one division
        pairings = []  # list initialized for all pairings in a round
        div_dict = {}  # dict for paritioning player_keys into divisions
        # Create a dict of lists of divisions (list values are player_id)
        for player_id in self.current_players:
            player = self.players[player_id]
            if player.division in div_dict.keys():
                div_dict[player.division].append(player_id)
            else:
                div_dict[player.division] = [player_id]

        # for each division, generate pairings and optimize.
        for div in div_dict.values():
            # generating possible pairings
            div_pairings = []  # list of lists of possible pairings
            for i in range(sample_size):
                random.shuffle(div)
                div_pairings.append(list(div))
            valid_pairings = [pairing for pairing in div_pairings
                              if self._pairing_is_valid(pairing)]
            # look for most optimized pairings
            best_score = 900000
            best_pairing = None
            for pairing in valid_pairings:
                pairing_score = self.pairing_score(pairing)
                if pairing_score < best_score:
                    best_score = pairing_score
                    best_pairing = pairing
            # append best pairing to pairings list
            pairings.append(best_pairing)
        res = [player for division in pairings for player in division]
        # Here is where we sort if it's the first round
        if len(self.rounds) == 0:
            sorted_res = sorted(res)
            return sorted_res
        return res

    def add_result(self, round_, board, winner):
        match = self.rounds[round_][board]
        match.winner = winner
        self.players[winner].mm_score[0] += 1

    def round_is_finished(self, round_):
        finished = True
        for match in self.rounds[round_].values():
            if match.winner is None:
                finished = False
                break
        return finished

    def start_new_round(self, pairing):
        # check that last round is finished
        if len(self.rounds) > 0 and not self.round_is_finished(len(self.rounds) - 1):
            raise RuntimeError('Last round is not yet finished')

        # break pairing list into tuples
        pair_tuples = []
        while pairing:
            player_one = pairing.pop()
            player_two = pairing.pop()
            if (self.players[player_two].mm_score > self.players[player_one].mm_score):
                white = player_two
                black = player_one
            else:
                white = player_one
                black = player_two
            pair_tuples.append((white, black))

        # sort pairing and assign corresponding new Matches to boards
        sorted_pairing = sorted(pair_tuples, key=lambda p: self.players[p[0]].mm_score,
                                reverse=True)
        round_ = dict()
        for board in range(1, len(sorted_pairing) + 1):
            pair = sorted_pairing[board - 1]
            round_[board] = Match(pair[0], pair[1])
        self.rounds.append(round_)

    def wall_list(self):
        # results board sorts players by mmscore, and then shows each round's win
        # or loss per player
        # player, rank, round1, round2, .. roundn, mmscore.

        # build id_to_wall dict to hold conversion between tournament id and
        # wall list id (0 indexed, for now, convert to 1 index at end)
        current_standings = self.standings()
        id_to_wall = {player_id: current_standings.index(player_id)
                      for player_id in current_standings}

        # dictionary representation of the wall standings
        # key is tournament id, value is list of str representaiton (
        # opponent tournament id, win/loss)
        # no mm_score (will be pulled in at the end, along with player name)
        wall_dict = {player_id: list() for player_id in current_standings}

        # for each round, create record of each player's opponents and win/loss
        for idx, round_ in enumerate(self.rounds):
            if self.round_is_finished(idx):
                for match in round_.values():
                    winner_str = '+'
                    loser_str = '-'
                    if match.winner == match.black:
                        winner_str += 'B' + str(id_to_wall[match.white] + 1)
                        loser_str += 'W' + str(id_to_wall[match.black] + 1)
                        wall_dict[match.white].append('{:>5}'.format(loser_str))
                    else:
                        winner_str += 'W' + str(id_to_wall[match.black] + 1)
                        loser_str += 'B' + str(id_to_wall[match.white] + 1)
                        wall_dict[match.black].append('{:>5}'.format(loser_str))
                    wall_dict[match.winner].append('{:>5}'.format(winner_str))
            for player, results in wall_dict.items():
                if len(results) <= idx:
                    results.extend(' ' * 6)

        res = []
        res.append('{:5} {:20} | {:4} |{:3} {:4} | {:15}'.format(' ', 'Player', 'Rank', ' S',
                   ' SOS', 'Opponents'))
        res.append('-' * 78)
        for standing, player_id in enumerate(current_standings):
            player_obj = self.players[player_id]
            # format opponents string
            opponents = ' '.join(wall_dict[player_id])
            # full string for each player
            res.append('{:4}. {:20} | {:4} |{:3} {:4} |{:15}'.format((standing + 1),
                       player_obj.name, player_obj.rank, player_obj.mm_score[0],
                       player_obj.mm_score[1], opponents))
        return '\n'.join(res)

    def pairings_list(self):
        # pretty printing pairings list with board#, names.
        res = []
        res.append('')
        res.append(' ' * 29 + '*' * 20)
        res.append(' ' * 29 + '* Round {} Pairings *'.format(len(self.rounds)))
        res.append(' ' * 29 + '*' * 20)
        res.append('')
        res.append('{:>7} | {:22} | {:22}'.format('Board', 'White', 'Black'))
        res.append('-' * 78)
        current_round = self.rounds[-1]
        for board_key, board in current_round.items():
            res.append('{:7} | {:22} | {:22}'.format(board_key, self.players[board.white].name,
                                                     self.players[board.black].name))
        return '\n'.join(res)

    def aga_results(self, template_path=AGA_RESULTS_TEMPLATE):
        current_dir = os.path.dirname(os.path.realpath(__file__))
        env = jinja2.Environment(loader=jinja2.FileSystemLoader(current_dir))
        template = env.get_template(template_path)
        Game = collections.namedtuple('Game', ['w_id', 'b_id', 'winner', 'handi', 'komi'])
        games = []
        for idx, round_ in enumerate(self.rounds):
            if self.round_is_finished(idx):
                for match in round_.values():
                    white = self.players[match.white]
                    black = self.players[match.black]
                    if match.winner == match.black:
                        winner_str = 'b'
                    else:
                        winner_str = 'w'
                    games.append(Game(white.aga_id, black.aga_id, winner_str, 0, 7))
        Player = collections.namedtuple('Player', ['aga_id', 'name', 'rank'])
        players = []
        for player in self.players.values():
            rank_str = '{}{}'.format(abs(player.rank), 'D' if player.rank > 0 else 'K')
            players.append(Player(player.aga_id, player.name, rank_str))
        return template.render(tournament=self, players=players, games=games)


def tournament_representer(dumper, data):
    return dumper.represent_mapping('!tournament', data.__dict__)

yaml.add_representer(Tournament, tournament_representer)


def tournament_constructor(loader, node):
    tourn_dict = loader.construct_mapping(node)
    return Tournament(tourn_dict['players'], tourn_dict['id_ctr'], tourn_dict['rounds'],
                      tourn_dict['old_pairs'], tourn_dict['current_players'], tourn_dict['name'],
                      tourn_dict['place'], tourn_dict['start'], tourn_dict['end'],
                      tourn_dict['rules'])

yaml.add_constructor('!tournament', tournament_constructor)


class HandiTournament(Tournament):

    def pairing_score(self, player_list):
        # measures sum of difference of mm_score per pairing
        # handi adds in difference of rank as a metric
        # assumes even number of people?
        score_mm = 0
        score_handi = 0
        temp_list = list(player_list)
        while temp_list:
            player1 = temp_list.pop()
            player2 = temp_list.pop()
            score_mm += abs(self.players[player1].mm_score[0]
                            - self.players[player2].mm_score[0])
            score_handi += abs(self.players[player1].rank
                               - self.players[player2].rank)
        return 3 * score_mm + score_handi

    def pairings_list(self):
        # pretty printing pairings list with board#, names.
        res = []
        res.append('')
        res.append(' ' * 29 + '*' * 20)
        res.append(' ' * 29 + '* Round {} Pairings *'.format(len(self.rounds)))
        res.append(' ' * 29 + '*' * 20)
        res.append('')
        res.append('{:^7} | {:^22} | {:^22} | {:^5}'.format('Board', 'White', 'Black', 'Handi'))
        res.append('-' * 78)
        current_round = self.rounds[-1]
        for board_key, board in current_round.items():
            white = self.players[board.white]
            black = self.players[board.black]
            res.append('{:^7} | {:22} | {:22} | {:^5}'.format(board_key, white.name, black.name,
                       abs(white.rank - black.rank)))
        return '\n'.join(res)

    def aga_results(self, template_path=AGA_RESULTS_TEMPLATE):
        current_dir = os.path.dirname(os.path.realpath(__file__))
        env = jinja2.Environment(loader=jinja2.FileSystemLoader(current_dir))
        template = env.get_template(template_path)
        Game = collections.namedtuple('Game', ['w_id', 'b_id', 'winner', 'handi', 'komi'])
        games = []
        for idx, round_ in enumerate(self.rounds):
            if self.round_is_finished(idx):
                for match in round_.values():
                    white = self.players[match.white]
                    black = self.players[match.black]
                    if match.winner == match.black:
                        winner_str = 'b'
                    else:
                        winner_str = 'w'
                    diff = abs(white.rank - black.rank)
                    handi = 0 if diff == 1 else diff
                    komi = 7 if diff == 0 else 0
                    games.append(Game(white.aga_id, black.aga_id, winner_str, handi, komi))
        Player = collections.namedtuple('Player', ['aga_id', 'name', 'rank'])
        players = []
        for player in self.players.values():
            rank_str = '{}{}'.format(abs(player.rank), 'D' if player.rank > 0 else 'K')
            players.append(Player(player.aga_id, player.name, rank_str))
        return template.render(tournament=self, players=players, games=games)


def handi_tournament_representer(dumper, data):
    return dumper.represent_mapping('!handitournament', data.__dict__)

yaml.add_representer(HandiTournament, handi_tournament_representer)


def handi_tournament_constructor(loader, node):
    tourn_dict = loader.construct_mapping(node)
    return HandiTournament(tourn_dict['players'], tourn_dict['id_ctr'], tourn_dict['rounds'],
                           tourn_dict['old_pairs'], tourn_dict['current_players'],
                           tourn_dict['name'], tourn_dict['place'], tourn_dict['start'],
                           tourn_dict['end'], tourn_dict['rules'])

yaml.add_constructor('!handitournament', handi_tournament_constructor)


class PlayerTestCase(unittest.TestCase):

    def setUp(self):
        self.player_one = Player('Andrew', 10, 12345, [5, 0, 0], 5, 1)

    def test_repr(self):
        self.assertEqual(repr(self.player_one), 'Player(name=Andrew, rank=10,'
                                                ' aga_id=12345, mm_score=[5, 0, 0], mm_init=5,'
                                                ' division=1)')

    def test_yaml(self):
        self.assertEqual(self.player_one, yaml.load(yaml.dump(self.player_one)))


class MatchTestCase(unittest.TestCase):

    def setUp(self):
        self.match = Match(1, 3)

    def test_repr(self):
        self.assertEqual(repr(self.match), '<Match(white=1, black=3, winner=None>')

    def test_winner(self):
        with self.assertRaises(ValueError):
            self.match.winner = 4
        self.match.winner = 3
        self.assertEqual(repr(self.match), '<Match(white=1, black=3, winner=3>')


class TournamentTestCase(unittest.TestCase):

    def setUp(self):
        players = [Player('Ma Wang', 7, 12345, [6, 0, 0], 6, 1),
                   Player('Will', 4, 1235, [6, 0, 0], 6, 1),
                   Player('Steve', 4, 234, [6, 0, 0], 6, 1),
                   Player('Mr. Cho', 3, 54, [6, 0, 0], 6, 1),
                   Player('XiaoCheng', 3, 5723, [6, 0, 0], 6, 1),
                   Player('Alex', 1, 632, [6, 0, 0], 6, 1),
                   Player('Matt', 4, 5723, [6, 0, 0], 6, 1),
                   Player('Ed', 2, 5723, [6, 0, 0], 6, 1),
                   Player('Josh', 1, 5723, [6, 0, 0], 6, 1),
                   Player('Kevin', 1, 5723, [6, 0, 0], 6, 1),
                   Player('Gus', 1, 5723, [1, 0, 0], 1, 2),
                   Player('Pete', -2, 5723, [1, 0, 0], 1, 2),
                   Player('Dan', -1, 5723, [1, 0, 0], 1, 2),
                   Player('David', -2, 5723, [1, 0, 0], 1, 2),
                   Player('Alex', -3, 5723, [1, 0, 0], 1, 2),
                   Player('Eric', -4, 5723, [1, 0, 0], 1, 2),
                   Player('Makio', -4, 5723, [1, 0, 0], 1, 2),
                   Player('David', -4, 5723, [1, 0, 0], 1, 2),
                   Player('Eric', -4, 5723, [1, 0, 0], 1, 2),
                   Player('Howie', -4, 5723, [1, 0, 0], 1, 2),
                   ]
        self.tournament = Tournament.new_tournament(players)
        self.pairing = self.tournament.generate_pairing(10000)

    def test_yaml(self):
        self.assertEqual(self.tournament, yaml.load(yaml.dump(self.tournament)))

    def test_generate_pairing(self):
        self.assertEqual(self.tournament.pairing_score(self.pairing), 0)

    def test_new_round(self):
        self.tournament.start_new_round(self.pairing)
        # check that a round was generated and added to the list
        self.assertEqual(len(self.tournament.rounds), 1)
        # check that the round isn't finished
        self.assertFalse(self.tournament.round_is_finished(0))
        with self.assertRaises(RuntimeError):
            self.tournament.start_new_round(self.pairing)

    def test_results(self):
        self.tournament.start_new_round(self.pairing)
        round_ = self.tournament.rounds[0]
        for board in round_.keys():
            # choose a random winner
            match = round_[board]
            self.tournament.add_result(0, board, (match.white if random.randint(0, 1)
                                                  else match.black))
        self.assertTrue(self.tournament.round_is_finished(0))


class HandiTournamentTestCase(unittest.TestCase):

    def setUp(self):
        players = [Player('Ma Wang', -1, 12345, [1, 0, 0], 1, 1),
                   Player('Will', -2, 1235, [1, 0, 0], 1, 1),
                   Player('Steve', -3, 234, [1, 0, 0], 1, 1),
                   Player('Mr. Cho', -4, 54, [1, 0, 0], 1, 1),
                   Player('XiaoCheng', -5, 5723, [1, 0, 0], 1, 1),
                   Player('Alex', -6, 632, [1, 0, 0], 1, 1),
                   Player('Matt', -7, 5723, [1, 0, 0], 1, 1),
                   Player('Ed', -8, 5723, [1, 0, 0], 1, 1),
                   Player('Josh', -9, 5723, [1, 0, 0], 1, 1),
                   Player('Kevin', -10, 5723, [1, 0, 0], 1, 1),
                   Player('Gus', -11, 5723, [1, 0, 0], 1, 1),
                   Player('Pete', -12, 5723, [1, 0, 0], 1, 1),
                   Player('Dan', -13, 5723, [1, 0, 0], 1, 1),
                   Player('David', -14, 5723, [1, 0, 0], 1, 1),
                   Player('Alex', -15, 5723, [1, 0, 0], 1, 1),
                   Player('Eric', -16, 5723, [1, 0, 0], 1, 1),
                   Player('Makio', -17, 5723, [1, 0, 0], 1, 1),
                   Player('David', -18, 5723, [1, 0, 0], 1, 1),
                   Player('Eric', -19, 5723, [1, 0, 0], 1, 1),
                   Player('Howie', -20, 5723, [1, 0, 0], 1, 1),
                   ]
        self.tournament = HandiTournament.new_tournament(players)
        # 10000 was not enough?
        self.pairing = self.tournament.generate_pairing(1)

    def test_generate_pairing(self):
        # in first round, pairings are sorted and should be minimum pairing score
        self.assertEqual(self.tournament.pairing_score(self.pairing), 10)

    def test_new_round(self):
        self.tournament.start_new_round(self.pairing)
        # check that a round was generated and added to the list
        self.assertEqual(len(self.tournament.rounds), 1)
        # check that the round isn't finished
        self.assertFalse(self.tournament.round_is_finished(0))
        with self.assertRaises(RuntimeError):
            self.tournament.start_new_round(self.pairing)

    def test_results(self):
        self.tournament.start_new_round(self.pairing)
        round_ = self.tournament.rounds[0]
        for board in round_.keys():
            # choose a random winner
            match = round_[board]
            self.tournament.add_result(0, board, (match.white if random.randint(0, 1)
                                                  else match.black))
        self.assertTrue(self.tournament.round_is_finished(0))

if __name__ == '__main__':
    unittest.main()