Scrython/scrython/symbology/symbology.py

from .symbology_object import SymbologyObject

class Symbology(SymbologyObject):
    """
    /symbology

    Positional arguments:
        No arguments are required.

    Optional arguments:
        All arguments are inherited from SymbologyObject

    Attributes:
        object : str . Returns the type of object it is. (card, error, etc)
        has_more : bool . True if there are more pages to the object.
        data : list . A list of all data returned.
        data_length : int . The length of the data returned.

        The following require an integer as an arg, which acts as a tuple.
        symbol_symbol(num) : str . The plaintext symbol, usually written with curly braces.
        symbol_loose_variant(num) : str . The alternate version of the symbol, without curly braces.
        symbol_english(num): str .. An english sentence describing the mana cost.
        symbol_transposable(num): bool . True if it's possibly to write the symbol backwards.
        symbol_represents_mana(num): bool . True if this is a mana symbol.
        symbol_appears_in_mana_costs(num): bool . True if the symbol appears on the mana cost of any card.
        symbol_cmc(num): float . The total converted mana cost of the symbol.
        symbol_funny(num): bool . True if the symbol is featured on any funny cards.
        symbol_colors(num): array . An array of all colors in the given symbol.
        symbol_gatherer_alternates(num): array .. An array of Gatherer like costs.

    Example usage:
        >>> symbol = scrython.symbology.Symbology()
    """
    def __init__(self):
        self.url = 'symbology?'
        super(Symbology, self).__init__(self.url)

    def object(self):
        super(Symbology, self)._checkForKey('object')

        return self.scryfallJson['object']

    def has_more(self):
        super(Symbology, self)._checkForKey('has_more')

        return self.scryfallJson['has_more']

    def data(self):
        super(Symbology, self)._checkForKey('has_more')

        return self.scryfallJson['data']

    def data_length(self):
        super(Symbology, self)._checkForKey('data')

        return len(self.scryfallJson['data'])

    def symbol_symbol(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'symbol')

        return self.scryfallJson['data'][num]['symbol']

    def symbol_loose_variant(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'loose_variant')

        return self.scryfallJson['data'][num]['loose_variant']

    def symbol_transposable(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'transposable')

        return self.scryfallJson['data'][num]['transposable']

    def symbol_represents_mana(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'represents_mana')

        return self.scryfallJson['data'][num]['represents_mana']

    def symbol_cmc(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'cmc')

        return self.scryfallJson['data'][num]['cmc']

    def symbol_appears_in_mana_costs(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'appears_in_mana_costs')

        return self.scryfallJson['data'][num]['appears_in_mana_costs']

    def symbol_funny(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'funny')

        return self.scryfallJson['data'][num]['funny']

    def symbol_colors(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'colors')

        return self.scryfallJson['data'][num]['colors']

    def symbol_english(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'english')

        return self.scryfallJson['data'][num]['english']

    def symbol_gatherer_alternates(self, num):
        super(Symbology, self)._checkForTupleKey('data', num, 'gatherer_alternates')

        return self.scryfallJson['data'][num]['gatherer_alternates']