Skills displayed in the Highscores do not include any bonuses (loyalty, equipment etc.).
Skills displayed in the Highscores do not include any bonuses (loyalty, equipment etc.).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Skills displayed in the Highscores do not include any bonuses (loyalty, equipment etc.).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Skills displayed in the Highscores do not include any bonuses (loyalty, equipment etc.).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Not json
") def testGuildTibiaDataUnrelated(self): - content = self._get_resource(tests.tests_character.FILE_CHARACTER_TIBIADATA) + content = self._load_resource(tests.tests_character.FILE_CHARACTER_TIBIADATA) with self.assertRaises(InvalidContent): House.from_tibiadata(content) def testHouseTibiaDataList(self): - content = self._get_resource(FILE_HOUSE_TIBIADATA_LIST) + content = self._load_resource(FILE_HOUSE_TIBIADATA_LIST) houses = ListedHouse.list_from_tibiadata(content) self.assertIsInstance(houses, list) @@ -172,7 +168,7 @@ def testHouseTibiaDataList(self): self.assertIsNotNone(ListedHouse.get_list_url_tibiadata(houses[0].world, houses[0].town)) def testHouseTibiaDataListNotFound(self): - content = self._get_resource(FILE_HOUSE_TIBIADATA_LIST_NOT_FOUND) + content = self._load_resource(FILE_HOUSE_TIBIADATA_LIST_NOT_FOUND) houses = ListedHouse.list_from_tibiadata(content) self.assertIsInstance(houses, list) @@ -184,4 +180,4 @@ def testHouseTibiaDataListInvalidJson(self): def testHouseTibiaDataListUnrelated(self): with self.assertRaises(InvalidContent): - ListedHouse.list_from_tibiadata(self._get_resource(tests.tests_character.FILE_CHARACTER_TIBIADATA)) + ListedHouse.list_from_tibiadata(self._load_resource(tests.tests_character.FILE_CHARACTER_TIBIADATA)) diff --git a/tests/tests_utils.py b/tests/tests_utils.py index a9b1c59e..9025d39e 100644 --- a/tests/tests_utils.py +++ b/tests/tests_utils.py @@ -130,3 +130,6 @@ def testTryEnum(self): def testEnumStr(self): self.assertEqual(str(enums.Sex.MALE), enums.Sex.MALE.value) + self.assertEqual(enums.VocationFilter.from_name("royal paladin"), enums.VocationFilter.PALADINS) + self.assertEqual(enums.VocationFilter.from_name("unknown"), enums.VocationFilter.ALL) + self.assertIsNone(enums.VocationFilter.from_name("unknown", False)) diff --git a/tibiapy/__init__.py b/tibiapy/__init__.py index 68af4d33..15c5fdaf 100644 --- a/tibiapy/__init__.py +++ b/tibiapy/__init__.py @@ -3,7 +3,8 @@ from tibiapy.enums import * from tibiapy.errors import * from tibiapy.guild import * +from tibiapy.highscores import * from tibiapy.house import * from tibiapy.world import * -__version__ = '1.0.0' +__version__ = '1.1.0' diff --git a/tibiapy/character.py b/tibiapy/character.py index 6c023d68..fa7204ae 100644 --- a/tibiapy/character.py +++ b/tibiapy/character.py @@ -1,5 +1,4 @@ import datetime -import json import re import urllib.parse from collections import OrderedDict @@ -12,8 +11,8 @@ from tibiapy.errors import InvalidContent from tibiapy.guild import Guild from tibiapy.house import CharacterHouse -from tibiapy.utils import parse_tibia_date, parse_tibia_datetime, parse_tibiacom_content, parse_tibiadata_date, \ - parse_tibiadata_datetime, try_datetime, try_enum +from tibiapy.utils import parse_json, parse_tibia_date, parse_tibia_datetime, parse_tibiacom_content, \ + parse_tibiadata_date, parse_tibiadata_datetime, try_datetime, try_enum deleted_regexp = re.compile(r'([^,]+), will be deleted at (.*)') # Extracts the death's level and killers. @@ -49,9 +48,9 @@ class AccountInformation(abc.Serializable): __slots__ = ("created", "loyalty_title", "position") def __init__(self, created, loyalty_title=None, position=None): - self.created = created - self.loyalty_title = loyalty_title - self.position = position + self.created = try_datetime(created) + self.loyalty_title = loyalty_title # type: Optional[str] + self.position = position # type: Optional[str] def __repr__(self): return "<%s created=%r>" % (self.__class__.__name__, self.created) @@ -70,8 +69,8 @@ class Achievement(abc.Serializable): __slots__ = ("name", "grade") def __init__(self, name, grade): - self.name = name - self.grade = grade + self.name = name # type: str + self.grade = int(grade) def __repr__(self): return "<%s name=%r grade=%d>" % (self.__class__.__name__, self.name, self.grade) @@ -131,23 +130,22 @@ class Character(abc.BaseCharacter): "achievements", "deaths", "account_information", "other_characters", "deletion_date") def __init__(self, name=None, world=None, vocation=None, level=0, sex=None, **kwargs): - self.name = name - self.former_names = kwargs.get("former_names", []) + self.name = name # type: str + self.former_names = kwargs.get("former_names", []) # type: List[str] self.sex = try_enum(Sex, sex) self.vocation = try_enum(Vocation, vocation) - self.level = level - self.achievement_points = kwargs.get("achievement_points", 0) - self.world = world - self.former_world = kwargs.get("former_world") - self.residence = kwargs.get("residence") - self.married_to = kwargs.get("married_to") + self.level = int(level) + self.achievement_points = int(kwargs.get("achievement_points", 0)) + self.world = world # type: str + self.former_world = kwargs.get("former_world") # type: Optional[str] + self.residence = kwargs.get("residence") # type: str + self.married_to = kwargs.get("married_to") # type: Optional[str] self.house = kwargs.get("house") # type: Optional[CharacterHouse] self.guild_membership = kwargs.get("guild_membership") # type: Optional[GuildMembership] self.last_login = try_datetime(kwargs.get("last_login")) self.account_status = try_enum(AccountStatus, kwargs.get("account_status")) - self.position = try_enum(AccountStatus, kwargs.get("account_status")) - self.position = kwargs.get("position") - self.comment = kwargs.get("comment") + self.position = kwargs.get("position") # type: Optional[str] + self.comment = kwargs.get("comment") # type: Optional[str] self.achievements = kwargs.get("achievements", []) # type: List[Achievement] self.deaths = kwargs.get("deaths", []) # type: List[Death] self.account_information = kwargs.get("account_information") # type: Optional[AccountInformation] @@ -239,10 +237,7 @@ def from_tibiadata(cls, content): ------ InvalidContent If content is not a JSON string of the Character response.""" - try: - json_content = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a valid json string.") + json_content = parse_json(content) char = cls() try: character = json_content["characters"] @@ -627,8 +622,8 @@ class GuildMembership(abc.BaseGuild): __slots__ = ("rank",) def __init__(self, name, rank): - self.name = name - self.rank = rank + self.name = name # type: str + self.rank = rank # type: str def __repr__(self): return "<{0.__class__.__name__} name={0.name!r} rank={0.rank!r}>".format(self) @@ -656,9 +651,9 @@ class Killer(abc.Serializable): __slots__ = ("name", "player", "summon") def __init__(self, name, player=False, summon=None): - self.name = name - self.player = player - self.summon = summon + self.name = name # type: str + self.player = player # type: bool + self.summon = summon # type: Optional[str] def __repr__(self): attributes = "" @@ -700,11 +695,11 @@ class OtherCharacter(abc.BaseCharacter): """ __slots__ = ("world", "online", "deleted") - def __init__(self, name, world=None, online=False, deleted=False): - self.name = name - self.world = world - self.online = online - self.deleted = deleted + def __init__(self, name, world, online=False, deleted=False): + self.name = name # type: str + self.world = world # type: str + self.online = online # type: bool + self.deleted = deleted # type: bool class OnlineCharacter(abc.BaseCharacter): @@ -724,7 +719,7 @@ class OnlineCharacter(abc.BaseCharacter): __slots__ = ("world", "vocation", "level") def __init__(self, name, world, level, vocation): - self.name = name - self.world = world + self.name = name # type: str + self.world = world # type: str self.level = int(level) self.vocation = try_enum(Vocation, vocation) diff --git a/tibiapy/enums.py b/tibiapy/enums.py index eaacee2a..ead81b21 100644 --- a/tibiapy/enums.py +++ b/tibiapy/enums.py @@ -1,6 +1,7 @@ from enum import Enum -__all__ = ('AccountStatus', 'HouseStatus', 'HouseType', 'PvpType', 'Sex', 'TransferType', 'Vocation', 'WorldLocation') +__all__ = ('AccountStatus', 'Category', 'HouseStatus', 'HouseType', 'PvpType', 'Sex', 'TransferType', 'Vocation', + 'VocationFilter', 'WorldLocation') class BaseEnum(Enum): @@ -14,6 +15,21 @@ class AccountStatus(BaseEnum): PREMIUM_ACCOUNT = "Premium Account" +class Category(BaseEnum): + """The different highscores categories.""" + ACHIEVEMENTS = "achievements" + AXE_FIGHTING = "axe" + CLUB_FIGHTING = "club" + DISTANCE_FIGHTING = "distance" + EXPERIENCE = "experience" + FISHING = "fishing" + FIST_FIGHTING = "fist" + LOYALTY_POINTS = "loyalty" + MAGIC_LEVEL = "magic" + SHIELDING = "shielding" + SWORD_FIGHTING = "sword" + + class HouseStatus(BaseEnum): """Renting statuses of a house.""" RENTED = "rented" @@ -63,6 +79,39 @@ class Vocation(BaseEnum): MASTER_SORCERER = "Master Sorcerer" +class VocationFilter(Enum): + """The vocation filters available for Highscores.""" + ALL = 0 + KNIGHTS = 1 + PALADINS = 2 + SORCERERS = 3 + DRUIDS = 4 + + @classmethod + def from_name(cls, name, all_fallback=True): + """Gets a vocation filter from a vocation's name. + + Parameters + ---------- + name: :class:`str` + The name of the vocation. + all_fallback: :class:`bool` + Whether to return :py:attr:`ALL` if no match is found. Otherwise, ``None`` will be returned. + + Returns + ------- + VocationFilter, optional: + The matching vocation filter. + """ + name = name.upper() + for vocation in cls: # type: VocationFilter + if vocation.name in name or vocation.name[:-1] in name and vocation != cls.ALL: + return vocation + if all_fallback or name.upper() == "ALL": + return cls.ALL + return None + + class WorldLocation(BaseEnum): """The possible physical locations for servers.""" EUROPE = "Europe" diff --git a/tibiapy/guild.py b/tibiapy/guild.py index dbeabf1b..bf64a021 100644 --- a/tibiapy/guild.py +++ b/tibiapy/guild.py @@ -1,5 +1,4 @@ import datetime -import json import re import urllib.parse from collections import OrderedDict @@ -11,8 +10,8 @@ from tibiapy.enums import Vocation from tibiapy.errors import InvalidContent from tibiapy.house import GuildHouse -from tibiapy.utils import parse_tibia_date, parse_tibiacom_content, parse_tibiadata_date, try_date, try_datetime, \ - try_enum +from tibiapy.utils import parse_json, parse_tibia_date, parse_tibiacom_content, parse_tibiadata_date, try_date, \ + try_datetime, try_enum __all__ = ("Guild", "GuildMember", "GuildInvite", "ListedGuild") @@ -69,17 +68,17 @@ class Guild(abc.BaseGuild): "disband_condition", "disband_date", "homepage", "members", "invites") def __init__(self, name=None, world=None, **kwargs): - self.name = name - self.world = world - self.logo_url = kwargs.get("logo_url") - self.description = kwargs.get("description") + self.name = name # type: str + self.world = world # type: str + self.logo_url = kwargs.get("logo_url") # type: str + self.description = kwargs.get("description") # type: Optional[str] self.founded = try_date(kwargs.get("founded")) - self.active = kwargs.get("active", False) + self.active = kwargs.get("active", False) # type: bool self.guildhall = kwargs.get("guildhall") # type: Optional[GuildHouse] - self.open_applications = kwargs.get("open_applications", False) - self.disband_condition = kwargs.get("disband_condition") + self.open_applications = kwargs.get("open_applications", False) # type: bool + self.disband_condition = kwargs.get("disband_condition") # type: Optional[str] self.disband_date = try_datetime(kwargs.get("disband_date")) - self.homepage = kwargs.get("homepage") + self.homepage = kwargs.get("homepage") # type: Optional[str] self.members = kwargs.get("members", []) # type: List[GuildMember] self.invites = kwargs.get("invites", []) # type: List[GuildInvite] @@ -173,11 +172,7 @@ def from_tibiadata(cls, content): InvalidContent If content is not a JSON response of a guild's page. """ - try: - json_content = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a json string.") - + json_content = parse_json(content) guild = cls() try: guild_obj = json_content["guild"] @@ -386,12 +381,12 @@ class GuildMember(abc.BaseCharacter): __slots__ = ("name", "rank", "title", "level", "vocation", "joined", "online") def __init__(self, name=None, rank=None, title=None, level=0, vocation=None, **kwargs): - self.name = name - self.rank = rank - self.title = title + self.name = name # type: str + self.rank = rank # type: str + self.title = title # type: Optional[str] self.vocation = try_enum(Vocation, vocation) - self.level = level - self.online = kwargs.get("online", False) + self.level = int(level) + self.online = kwargs.get("online", False) # type: bool self.joined = try_date(kwargs.get("joined")) @@ -409,7 +404,7 @@ class GuildInvite(abc.BaseCharacter): __slots__ = ("date", ) def __init__(self, name=None, date=None): - self.name = name + self.name = name # type: str self.date = try_date(date) def __repr__(self): @@ -437,11 +432,11 @@ class ListedGuild(abc.BaseGuild): __slots__ = ("logo_url", "description", "world", "active") def __init__(self, name, world, logo_url=None, description=None, active=False): - self.name = name - self.world = world - self.logo_url = logo_url - self.description = description - self.active = active + self.name = name # type: str + self.world = world # type: str + self.logo_url = logo_url # type: str + self.description = description # type: Optional[str] + self.active = active # type: bool # region Public methods @classmethod @@ -543,10 +538,7 @@ def list_from_tibiadata(cls, content): InvalidContent If content is not a JSON response of TibiaData's guild list. """ - try: - json_content = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a valid json string.") + json_content = parse_json(content) try: guilds_obj = json_content["guilds"] guilds = [] diff --git a/tibiapy/highscores.py b/tibiapy/highscores.py new file mode 100644 index 00000000..7c007d9c --- /dev/null +++ b/tibiapy/highscores.py @@ -0,0 +1,325 @@ +import math +import re +from collections import OrderedDict +from typing import List + +from tibiapy import Category, InvalidContent, Vocation, VocationFilter, abc +from tibiapy.utils import parse_json, parse_tibiacom_content, try_enum + +__all__ = ("ExpHighscoresEntry", "Highscores", "HighscoresEntry", "LoyaltyHighscoresEntry") + +results_pattern = re.compile(r'Results: (\d+)') + +HIGHSCORES_URL = "https://secure.tibia.com/community/?subtopic=highscores&world=%s&list=%s&profession=%d¤tpage=%d" +HIGHSCORES_URL_TIBIADATA = "https://api.tibiadata.com/v2/highscores/%s/%s/%s.json" + + +class Highscores(abc.Serializable): + """Represents the highscores of a world. + + Tibia.com only shows 25 entries per page. + TibiaData.com shows all results at once. + + Attributes + ---------- + world: :class:`str` + The world the highscores belong to. + category: :class:`Category` + The selected category to displays the highscores of. + vocation: :class:`VocationFilter` + The selected vocation to filter out values. + results_count: :class:`int` + The total amount of highscores entries in this category. These may be shown in another page. + """ + def __init__(self, world, category, **kwargs): + self.world = world # type: str + self.category = try_enum(Category, category, Category.EXPERIENCE) + self.vocation = try_enum(VocationFilter, kwargs.get("vocation"), VocationFilter.ALL) + self.entries = kwargs.get("entries", []) # type: List[HighscoresEntry] + self.results_count = kwargs.get("results_count") # type: int + + def __repr__(self) -> str: + return "<{0.__class__.__name__} world={0.world!r} category={0.category!r} vocation={0.vocation!r}>".format(self) + + @property + def from_rank(self): + """:class:`int`: The starting rank of the provided entries.""" + return self.entries[0].rank if self.entries else 0 + + @property + def to_rank(self): + """:class:`int`: The last rank of the provided entries.""" + return self.entries[-1].rank if self.entries else 0 + + @property + def page(self): + """:class:`int`: The page number the shown results correspond to on Tibia.com""" + return int(math.floor(self.from_rank/25))+1 if self.from_rank else 0 + + @property + def total_pages(self): + """:class:`int`: The total of pages of the highscores category.""" + return int(math.ceil(self.results_count/25)) + + @property + def url(self): + """:class:`str`: The URL to the highscores page on Tibia.com containing the results.""" + return self.get_url(self.world, self.category, self.vocation, self.page) + + @property + def url_tibiadata(self): + """:class:`str`: The URL to the highscores page on TibiaData.com containing the results.""" + return self.get_url_tibiadata(self.world, self.category, self.vocation) + + @classmethod + def from_content(cls, content): + """Creates an instance of the class from the html content of a highscores page. + + Notes + ----- + Tibia.com only shows up to 25 entries per page, so in order to obtain the full highscores, all 12 pages must + be parsed and merged into one. + + Parameters + ---------- + content: :class:`str` + The HTML content of the page. + + Returns + ------- + :class:`Highscores` + The highscores results contained in the page. + + Raises + ------ + InvalidContent + If content is not the HTML of a highscore's page.""" + parsed_content = parse_tibiacom_content(content) + tables = cls._parse_tables(parsed_content) + filters = tables.get("Highscores Filter") + if filters is None: + raise InvalidContent("content does is not from the highscores section of Tibia.com") + world_filter, vocation_filter, category_filter = filters + world = world_filter.find("option", {"selected": True})["value"] + if world == "": + return None + category = category_filter.find("option", {"selected": True})["value"] + vocation_selected = vocation_filter.find("option", {"selected": True}) + vocation = int(vocation_selected["value"]) if vocation_selected else 0 + highscores = cls(world, category, vocation=vocation) + entries = tables.get("Highscores") + if entries is None: + return None + _, header, *rows = entries + info_row = rows.pop() + highscores.results_count = int(results_pattern.search(info_row.text).group(1)) + for row in rows: + cols_raw = row.find_all('td') + highscores._parse_entry(cols_raw) + return highscores + + @classmethod + def from_tibiadata(cls, content, vocation=None): + """Builds a highscores object from a TibiaData highscores response. + + Notes + ----- + Since TibiaData.com's response doesn't contain any indication of the vocation filter applied, + :py:attr:`vocation` can't be determined from the response, so the attribute must be assigned manually. + + If the attribute is known, it can be passed for it to be assigned in this method. + + Parameters + ---------- + content: :class:`str` + The JSON content of the response. + vocation: :class:`VocationFilter`, optional + The vocation filter to assign to the results. Note that this won't affect the parsing. + + Returns + ------- + :class:`Highscores` + The highscores contained in the page, or None if the content is for the highscores of a nonexistent world. + + Raises + ------ + InvalidContent + If content is not a JSON string of the highscores response.""" + json_content = parse_json(content) + try: + highscores_json = json_content["highscores"] + if "error" in highscores_json["data"]: + return None + world = highscores_json["world"] + category = highscores_json["type"] + highscores = cls(world, category) + for entry in highscores_json["data"]: + value_key = "level" + if highscores.category in [Category.ACHIEVEMENTS, Category.LOYALTY_POINTS, Category.EXPERIENCE]: + value_key = "points" + if highscores.category == Category.EXPERIENCE: + highscores.entries.append(ExpHighscoresEntry(entry["name"], entry["rank"], entry["voc"], + entry[value_key], entry["level"])) + elif highscores.category == Category.LOYALTY_POINTS: + highscores.entries.append(LoyaltyHighscoresEntry(entry["name"], entry["rank"], entry["voc"], + entry[value_key], entry["title"])) + else: + highscores.entries.append(HighscoresEntry(entry["name"], entry["rank"], entry["voc"], + entry[value_key])) + highscores.results_count = len(highscores.entries) + except KeyError: + raise InvalidContent("content is not a TibiaData highscores response.") + if isinstance(vocation, VocationFilter): + highscores.vocation = vocation + return highscores + + @classmethod + def get_url(cls, world, category=Category.EXPERIENCE, vocation=VocationFilter.ALL, page=1): + """Gets the Tibia.com URL of the highscores for the given parameters. + + Parameters + ---------- + world: :class:`str` + The game world of the desired highscores. + category: :class:`Category` + The desired highscores category. + vocation: :class:`VocationFiler` + The vocation filter to apply. By default all vocations will be shown. + page: :class:`int` + The page of highscores to show. + + Returns + ------- + The URL to the Tibia.com highscores. + """ + return HIGHSCORES_URL % (world, category.value, vocation.value, page) + + @classmethod + def get_url_tibiadata(cls, world, category=Category.EXPERIENCE, vocation=VocationFilter.ALL): + """Gets the TibiaData.com URL of the highscores for the given parameters. + + Parameters + ---------- + world: :class:`str` + The game world of the desired highscores. + category: :class:`Category` + The desired highscores category. + vocation: :class:`VocationFiler` + The vocation filter to apply. By default all vocations will be shown. + + Returns + ------- + The URL to the TibiaData.com highscores. + """ + return HIGHSCORES_URL_TIBIADATA % (world, category.value.lower(), vocation.name.lower()) + + @classmethod + def _parse_tables(cls, parsed_content): + """ + Parses the information tables found in a highscores page. + + Parameters + ---------- + parsed_content: :class:`bs4.BeautifulSoup` + A :class:`BeautifulSoup` object containing all the content. + + Returns + ------- + :class:`OrderedDict`[:class:`str`, :class:`list`[:class:`bs4.Tag`]] + A dictionary containing all the table rows, with the table headers as keys. + """ + tables = parsed_content.find_all('div', attrs={'class': 'TableContainer'}) + output = OrderedDict() + for table in tables: + title = table.find("div", attrs={'class': 'Text'}).text + title = title.split("[")[0].strip() + inner_table = table.find("div", attrs={'class': 'InnerTableContainer'}) + output[title] = inner_table.find_all("tr") + return output + # endregion + + def _parse_entry(self, cols): + """Parses an entry's row and adds the result to py:attr:`entries`. + + Parameters + ---------- + cols: :class:`bs4.ResultSet` + The list of columns for that entry. + """ + rank, name, vocation, *values = [c.text.replace('\xa0', ' ').strip() for c in cols] + rank = int(rank) + if self.category == Category.EXPERIENCE or self.category == Category.LOYALTY_POINTS: + extra, value = values + else: + value, *extra = values + value = int(value.replace(',', '')) + if self.category == Category.EXPERIENCE: + entry = ExpHighscoresEntry(name, rank, vocation, value, int(extra)) + elif self.category == Category.LOYALTY_POINTS: + entry = LoyaltyHighscoresEntry(name, rank, vocation, value, extra) + else: + entry = HighscoresEntry(name, rank, vocation, value) + self.entries.append(entry) + + +class HighscoresEntry(abc.BaseCharacter): + """Represents a entry for the highscores. + + Attributes + ---------- + name: :class:`str` + The name of the character. + rank: :class:`int` + The character's rank in the respective highscores. + vocation: :class:`Vocation` + The character's vocation. + value: :class:`int` + The character's value for the highscores.""" + def __init__(self, name, rank, vocation, value): + self.name = name # type: str + self.rank = rank # type: int + self.vocation = try_enum(Vocation, vocation) + self.value = value # type: int + + def __repr__(self) -> str: + return "<{0.__class__.__name__} rank={0.rank} name={0.name!r} value={0.value}>".format(self) + + +class ExpHighscoresEntry(HighscoresEntry): + """Represents a entry for the highscores's experience category. + + Attributes + ---------- + name: :class:`str` + The name of the character. + rank: :class:`int` + The character's rank in the respective highscores. + vocation: :class:`Vocation` + The character's vocation. + value: :class:`int` + The character's experience points. + level: :class:`int` + The character's level.""" + def __init__(self, name, rank, vocation, value, level): + super().__init__(name, rank, vocation, value) + self.level = level # type: int + + +class LoyaltyHighscoresEntry(HighscoresEntry): + """Represents a entry for the highscores loyalty points category. + + Attributes + ---------- + name: :class:`str` + The name of the character. + rank: :class:`int` + The character's rank in the respective highscores. + vocation: :class:`Vocation` + The character's vocation. + value: :class:`int` + The character's loyalty points. + title: :class:`str` + The character's loyalty title.""" + def __init__(self, name, rank, vocation, value, title): + super().__init__(name, rank, vocation, value) + self.title = title # type: str diff --git a/tibiapy/house.py b/tibiapy/house.py index 7dc7f60a..c89d60c2 100644 --- a/tibiapy/house.py +++ b/tibiapy/house.py @@ -1,5 +1,4 @@ import datetime -import json import re import urllib.parse from typing import Optional @@ -8,8 +7,8 @@ from tibiapy import abc from tibiapy.enums import HouseStatus, HouseType, Sex from tibiapy.errors import InvalidContent -from tibiapy.utils import parse_number_words, parse_tibia_datetime, parse_tibiacom_content, try_date, try_datetime, \ - try_enum +from tibiapy.utils import parse_json, parse_number_words, parse_tibia_datetime, parse_tibiacom_content, try_date, \ + try_datetime, try_enum __all__ = ("House", "CharacterHouse", "GuildHouse", "ListedHouse") @@ -79,24 +78,24 @@ class House(abc.BaseHouseWithId): "highest_bidder", "auction_end") def __init__(self, name, world=None, **kwargs): - self.id = kwargs.get("id", 0) - self.name = name - self.world = world - self.image_url = kwargs.get("image_url") - self.beds = kwargs.get("beds", 0) + self.id = kwargs.get("id", 0) # type: int + self.name = name # type: str + self.world = world # type: str + self.image_url = kwargs.get("image_url") # type: str + self.beds = kwargs.get("beds", 0) # type: int self.type = try_enum(HouseType, kwargs.get("type"), HouseType.HOUSE) - self.size = kwargs.get("size", 0) - self.rent = kwargs.get("rent", 0) + self.size = kwargs.get("size", 0) # type: int + self.rent = kwargs.get("rent", 0) # type: int self.status = try_enum(HouseStatus, kwargs.get("status"), None) - self.owner = kwargs.get("owner") + self.owner = kwargs.get("owner") # type: Optional[str] self.owner_sex = try_enum(Sex, kwargs.get("owner_sex")) self.paid_until = try_datetime(kwargs.get("paid_until")) self.transfer_date = try_datetime(kwargs.get("transfer_date")) - self.transferee = kwargs.get("transferee") - self.transfer_price = kwargs.get("transfer_price", 0) - self.transfer_accepted = kwargs.get("transfer_accepted", False) - self.highest_bid = kwargs.get("highest_bid", 0) - self.highest_bidder = kwargs.get("highest_bidder") + self.transferee = kwargs.get("transferee") #type: Optional[str] + self.transfer_price = kwargs.get("transfer_price", 0) # type: int + self.transfer_accepted = kwargs.get("transfer_accepted", False) # type: bool + self.highest_bid = kwargs.get("highest_bid", 0) # type: int + self.highest_bidder = kwargs.get("highest_bidder") # type: Optional[str] self.auction_end = try_datetime(kwargs.get("auction_end")) # region Properties @@ -191,10 +190,7 @@ def from_tibiadata(cls, content): InvalidContent If the content is not a house JSON response from TibiaData """ - try: - json_content = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a json string.") + json_content = parse_json(content) try: house_json = json_content["house"] if not house_json["name"]: @@ -277,10 +273,10 @@ class CharacterHouse(abc.BaseHouseWithId): def __init__(self, _id, name, world=None, town=None, owner=None, paid_until_date=None): self.id = int(_id) - self.name = name - self.town = town - self.world = world - self.owner = owner + self.name = name # type: str + self.town = town # type: str + self.world = world # type: str + self.owner = owner # type: str self.paid_until_date = try_date(paid_until_date) self.status = HouseStatus.RENTED self.type = HouseType.HOUSE @@ -300,14 +296,16 @@ class GuildHouse(abc.BaseHouse): type: :class:`HouseType` The type of the house. owner: :class:`str` - The owner of the guildhall.""" + The owner of the guildhall. + paid_until_date: :class:`datetime.date` + The date the last paid rent is due.""" __slots__ = ("owner", "paid_until_date") def __init__(self, name, world=None, owner=None, paid_until_date=None): - self.name = name - self.world = world - self.owner = owner - self.paid_until_date = paid_until_date + self.name = name # type: str + self.world = world # type: str + self.owner = owner # type: str + self.paid_until_date = try_date(paid_until_date) self.status = HouseStatus.RENTED self.type = HouseType.GUILDHALL @@ -345,16 +343,16 @@ class ListedHouse(abc.BaseHouseWithId): __slots__ = ("town", "size", "rent", "time_left", "highest_bid") def __init__(self, name, world, houseid, **kwargs): - self.name = name - self.id = houseid - self.world = world - self.status = kwargs.get("status") - self.type = kwargs.get("type") - self.town = kwargs.get("town") - self.size = kwargs.get("size", 0) - self.rent = kwargs.get("rent", 0) + self.name = name # type: str + self.id = int(houseid) + self.world = world # type: str + self.status = try_enum(HouseStatus, kwargs.get("status")) + self.type = try_enum(HouseType, kwargs.get("type")) + self.town = kwargs.get("town") # type: str + self.size = kwargs.get("size", 0) # type int + self.rent = kwargs.get("rent", 0) # type: int self.time_left = kwargs.get("time_left") # type: Optional[datetime.timedelta] - self.highest_bid = kwargs.get("highest_bid", 0) + self.highest_bid = kwargs.get("highest_bid", 0) # type: int # region Public methods @classmethod @@ -424,10 +422,7 @@ def list_from_tibiadata(cls, content): InvalidContent` Content is not the house list from TibiaData.com """ - try: - json_data = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a json string") + json_data = parse_json(content) try: house_data = json_data["houses"] houses = [] diff --git a/tibiapy/utils.py b/tibiapy/utils.py index 86688b11..14e3df57 100644 --- a/tibiapy/utils.py +++ b/tibiapy/utils.py @@ -1,8 +1,11 @@ import datetime +import json from typing import Optional, Type, TypeVar, Union import bs4 +from tibiapy.errors import InvalidContent + def parse_tibia_datetime(datetime_str) -> Optional[datetime.datetime]: """Parses date and time from the format used in Tibia.com @@ -190,7 +193,7 @@ def try_datetime(obj) -> Optional[datetime.datetime]: Returns ------- - :class:`datetime.datetime` + :class:`datetime.datetime`, optional The represented datetime, or ``None`` if conversion wasn't possible. """ if obj is None: @@ -277,7 +280,7 @@ def try_enum(cls: Type[T], val, default: D = None) -> Union[T, D]: Returns ------- - any + obj: The enum value if found, otherwise None. """ if isinstance(val, cls): @@ -286,3 +289,39 @@ def try_enum(cls: Type[T], val, default: D = None) -> Union[T, D]: return cls(val) except ValueError: return default + + +def parse_json(content): + """Tries to parse a string into a json object. + + This also performs a trim of all values, recursively removing leading and trailing whitespace. + + Parameters + ---------- + content: A JSON format string. + + Returns + ------- + obj: + The object represented by the json string. + + Raises + ------ + InvalidContent + If the content is not a valid json string. + """ + try: + json_content = json.loads(content) + return _recursive_strip(json_content) + except json.JSONDecodeError: + raise InvalidContent("content is not a json string.") + + +def _recursive_strip(value): + if isinstance(value, dict): + return {k: _recursive_strip(v) for k, v in value.items()} + if isinstance(value, list): + return [_recursive_strip(i) for i in value] + if isinstance(value, str): + return value.strip() + return value diff --git a/tibiapy/world.py b/tibiapy/world.py index 62b0a313..44e3602c 100644 --- a/tibiapy/world.py +++ b/tibiapy/world.py @@ -1,4 +1,3 @@ -import json import re from collections import OrderedDict from typing import List @@ -8,8 +7,8 @@ from tibiapy import InvalidContent, abc from tibiapy.character import OnlineCharacter from tibiapy.enums import PvpType, TransferType, WorldLocation -from tibiapy.utils import parse_tibia_datetime, parse_tibia_full_date, parse_tibiacom_content, parse_tibiadata_datetime, \ - try_date, try_datetime, try_enum +from tibiapy.utils import parse_json, parse_tibia_datetime, parse_tibia_full_date, parse_tibiacom_content, \ + parse_tibiadata_datetime, try_date, try_datetime, try_enum __all__ = ("ListedWorld", "World", "WorldOverview") @@ -45,16 +44,16 @@ class ListedWorld(abc.BaseWorld): Whether only premium account players are allowed to play in this server. """ def __init__(self, name, location=None, pvp_type=None, **kwargs): - self.name = name + self.name = name # type: str self.location = try_enum(WorldLocation, location) self.pvp_type = try_enum(PvpType, pvp_type) - self.status = kwargs.get("status") - self.online_count = kwargs.get("online_count", 0) + self.status = kwargs.get("status") # type: str + self.online_count = kwargs.get("online_count", 0) # type: int self.transfer_type = try_enum(TransferType, kwargs.get("transfer_type", TransferType.REGULAR)) - self.battleye_protected = kwargs.get("battleye_protected", False) + self.battleye_protected = kwargs.get("battleye_protected", False) # type: bool self.battleye_date = try_date(kwargs.get("battleye_date")) - self.experimental = kwargs.get("experimental") - self.premium_only = kwargs.get("premium_only", False) + self.experimental = kwargs.get("experimental", False) # type: bool + self.premium_only = kwargs.get("premium_only", False) # type: bool # region Public methods @classmethod @@ -188,21 +187,21 @@ class World(abc.BaseWorld): __slots__ = ("record_count", "record_date", "creation_date", "world_quest_titles", "online_players") def __init__(self, name, location=None, pvp_type=None, **kwargs): - self.name = name + self.name = name # type: str self.location = try_enum(WorldLocation, location) self.pvp_type = try_enum(PvpType, pvp_type) - self.status = kwargs.get("status") - self.online_count = kwargs.get("online_count", 0) - self.record_count = kwargs.get("record_count", 0) + self.status = kwargs.get("status") # type: bool + self.online_count = kwargs.get("online_count", 0) # type: int + self.record_count = kwargs.get("record_count", 0) # type: int self.record_date = try_datetime(kwargs.get("record_date")) - self.creation_date = kwargs.get("creation_date") + self.creation_date = kwargs.get("creation_date") # type: str self.transfer_type = try_enum(TransferType, kwargs.get("transfer_type", TransferType.REGULAR)) - self.world_quest_titles = kwargs.get("world_quest_titles", []) - self.battleye_protected = kwargs.get("battleye_protected", False) + self.world_quest_titles = kwargs.get("world_quest_titles", []) # type: List[str] + self.battleye_protected = kwargs.get("battleye_protected", False) # type: bool self.battleye_date = try_date(kwargs.get("battleye_date")) - self.experimental = kwargs.get("experimental") + self.experimental = kwargs.get("experimental", False) # type: bool self.online_players = kwargs.get("online_players", []) # type: List[OnlineCharacter] - self.premium_only = kwargs.get("premium_only", False) + self.premium_only = kwargs.get("premium_only", False) # type: bool # region Properties @property @@ -276,10 +275,7 @@ def from_tibiadata(cls, content): InvalidContent If the provided content is not a TibiaData world response. """ - try: - json_data = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a valid json string.") + json_data = parse_json(content) try: world_data = json_data["world"] world_info = world_data["world_information"] @@ -412,7 +408,7 @@ class WorldOverview(abc.Serializable): __slots__ = ("record_count", "record_date", "worlds") def __init__(self, **kwargs): - self.record_count = kwargs.get("record_count", 0) + self.record_count = kwargs.get("record_count", 0) # type: int self.record_date = try_datetime(kwargs.get("record_date")) self.worlds = kwargs.get("worlds", []) # type: List[ListedWorld] @@ -514,10 +510,7 @@ def from_tibiadata(cls, content): InvalidContent If the provided content is the json content of the world section in TibiaData.com """ - try: - json_data = json.loads(content) - except json.JSONDecodeError: - raise InvalidContent("content is not a valid json string.") + json_data = parse_json(content) try: worlds_json = json_data["worlds"]["allworlds"] world_overview = cls()