aiohypixel.shared

Documentation

Custom exceptions related to the Hypixel API and other misc stuff

aiohypixel.shared.GAME_TYPES_TABLE = {2: {'db_name': 'Quake', 'pretty_name': 'Quake', 'type_name': 'QUAKECRAFT'}, 3: {'db_name': 'Walls', 'pretty_name': 'Walls', 'type_name': 'WALLS'}, 4: {'db_name': 'Paintball', 'pretty_name': 'Paintball', 'type_name': 'PAINTBALL'}, 5: {'db_name': 'HungerGames', 'pretty_name': 'Blitz Survival Games', 'type_name': 'SURVIVAL_GAMES'}, 6: {'db_name': 'TNTGames', 'pretty_name': 'TNT Games', 'type_name': 'TNTGAMES'}, 7: {'db_name': 'VampireZ', 'pretty_name': 'VampireZ', 'type_name': 'VAMPIREZ'}, 13: {'db_name': 'Walls3', 'pretty_name': 'Mega Walls', 'type_name': 'WALLS3'}, 14: {'db_name': 'Arcade', 'pretty_name': 'Arcade', 'type_name': 'ARCADE'}, 17: {'db_name': 'Arena', 'pretty_name': 'Arena', 'type_name': 'ARENA'}, 20: {'db_name': 'UHC', 'pretty_name': 'UHC Champions', 'type_name': 'UHC'}, 21: {'db_name': 'MCGO', 'pretty_name': 'Cops and Crims', 'type_name': 'MCGO'}, 23: {'db_name': 'Battleground', 'pretty_name': 'Warlords', 'type_name': 'BATTLEGROUND'}, 24: {'db_name': 'SuperSmash', 'pretty_name': 'Smash Heroes', 'type_name': 'SUPER_SMASH'}, 25: {'db_name': 'GingerBread', 'pretty_name': 'Turbo Kart Racers', 'type_name': 'GINGERBREAD'}, 26: {'db_name': 'Housing', 'pretty_name': 'Housing', 'type_name': 'HOUSING'}, 51: {'db_name': 'SkyWars', 'pretty_name': 'SkyWars', 'type_name': 'SKYWARS'}, 52: {'db_name': 'TrueCombat', 'pretty_name': 'Crazy Walls', 'type_name': 'TRUE_COMBAT'}, 54: {'db_name': 'SpeedUHC', 'pretty_name': 'Speed UHC', 'type_name': 'SPEED_UHC'}, 55: {'db_name': 'SkyClash', 'pretty_name': 'SkyClash', 'type_name': 'SKYCLASH'}, 56: {'db_name': 'Legacy', 'pretty_name': 'Classic Games', 'type_name': 'LEGACY'}, 57: {'db_name': 'Prototype', 'pretty_name': 'Prototype', 'type_name': 'PROTOTYPE'}, 58: {'db_name': 'Bedwars', 'pretty_name': 'Bed Wars', 'type_name': 'BEDWARS'}, 59: {'db_name': 'MurderMystery', 'pretty_name': 'Murder Mystery', 'type_name': 'MURDER_MYSTERY'}, 60: {'db_name': 'BuildBattle', 'pretty_name': 'Build Battle', 'type_name': 'BUILD_BATTLE'}, 61: {'db_name': 'Duels', 'pretty_name': 'Duels', 'type_name': 'DUELS'}}

//github.com/HypixelDev/PublicAPI/blob/master/Documentation/misc/GameType.md)

Type

Mapping for decoding game types (https

aiohypixel.shared.APIResponse(x)

Dummy type to represent an response from the Hypiel API.

exception aiohypixel.shared.AiohypixelException

Base exception class from which all other exceptions by this library are subclassed.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception aiohypixel.shared.UnsuccessfulRequest

Raised when the “success” key from a request is False

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception aiohypixel.shared.PlayerNotFound

Raised if a player/UUID is not found. This exception can usually be ignored. You can catch this exception with except aiohypixel.PlayerNotFoundException:

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception aiohypixel.shared.GuildIDNotValid

Raised if a Guild is not found using a Guild ID. This exception can usually be ignored. You can catch this exception with except aiohypixel.GuildIDNotValid:

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception aiohypixel.shared.HypixelAPIError

Raised if something’s gone very wrong with the API.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception aiohypixel.shared.InvalidAPIKey

Raised if the given API Key is invalid

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class aiohypixel.shared.ImmutableProxy
aiohypixel.shared.is_uuid(item)

Checks if the given string is a valid UUID.

Parameters

item (Union[str, UUID]) – The hexadecimal string to check.

Return type

bool

Inheritance Diagram

Inheritance diagram of aiohypixel.shared