solution.py

class Solution(object):
    """ Encapsulates cryptic crossword solutions

    Attributes:
        score: an indication of how likely the solution is to be correct
        notes: newline separated notes on the derivation of the solution
        solution: the word believed to be a solution
    """

    def __init__(self, soln, score, clue_type, indicator=""):
        """
        :param solver.IndicatorType clue_type: solver that gave this clue.
        :param str indicator: The word that indicates the solver type if
            there was one.
        :param str soln: The word of the solution
        :param float score: The solution's score
        """
        self.score = score
        note = 'Clue type ' + str(clue_type)
        if indicator:
            note += ' indicated by ' + indicator
        self.notes = [note]
        self.solution = soln

    def add_note(self, note):
        """ Add a note to a solution

        :param str note: the note to be added
        """
        self.notes.append(note)

    def __str__(self):
        ret = self.solution
        ret += "\nScore: " + str(self.score) + "\n"
        ret += "\n".join(self.notes)
        return ret

    def __cmp__(self, other):
        return cmp(self.score, other.score)