Added flag to only parse auction's basic information

Author: Galarzaa90

CHANGELOG.rst

@@ -6,6 +6,12 @@ Changelog
     Due to this library relying on external content, older versions are not guaranteed to work.
     Try to always use the latest version.
 
+3.4.0 (2020-09-19)
+=================
+
+- Added option to only parsed the listed information of an auction, to skip the rest of the parsing.
+- Fixed wrong type hint in ``ListedAuction`` for ``status``.
+
 3.3.0 (2020-09-09)
 =================
 

serve.py

@@ -77,8 +77,9 @@ async def get_auction(request: web.Request):
     fetch_items = int(request.query.get("fetch_items", 0))
     fetch_mounts = int(request.query.get("fetch_mounts", 0))
     fetch_outfits = int(request.query.get("fetch_outfits", 0))
+    skip_details = int(request.query.get("skip_details", 0))
     boosted = await app["tibiapy"].fetch_auction(int(auction_id), fetch_items=fetch_items, fetch_mounts=fetch_mounts,
-                                                 fetch_outfits=fetch_outfits)
+                                                 fetch_outfits=fetch_outfits, skip_details=skip_details)
     return web.json_response(boosted, dumps=CustomJson.dumps)
 
 

tibiapy/__init__.py

@@ -17,7 +17,7 @@
 from tibiapy.bazaar import *
 from tibiapy.client import *
 
-__version__ = '3.3.0'
+__version__ = '3.4.0'
 
 from logging import NullHandler
 

tibiapy/bazaar.py

@@ -645,7 +645,7 @@ def __init__(self, **kwargs):
         self.auction_end: datetime.datetime = kwargs.get("auction_end")
         self.bid: int = kwargs.get("bid", 0)
         self.bid_type: BidType = kwargs.get("bid_type")
-        self.status: str = kwargs.get("status")
+        self.status: AuctionStatus = kwargs.get("status")
 
     def __repr__(self):
         return f"<{self.__class__.__name__} auction_id={self.auction_id} name={self.name} world={self.world}>"
@@ -960,7 +960,7 @@ def skills_map(self) -> Dict[str, 'SkillEntry']:
         return {skill.name: skill for skill in self.skills}
 
     @classmethod
-    def from_content(cls, content, auction_id=0):
+    def from_content(cls, content, auction_id=0, skip_details=False):
         """Parses an auction detail page from Tibia.com and extracts its data.
 
         Parameters
@@ -971,6 +971,11 @@ def from_content(cls, content, auction_id=0):
             The ID of the auction.
 
             It is not possible to extract the ID from the page's content, so it may be passed to assign it manually.
+        skip_details: :class:`bool`, optional
+            Whether to skip parsing the entire auction and only parse the information shown in lists. False by default.
+
+            This allows fetching basic information like name, level, vocation, world, bid and status, shaving off some
+            parsing time.
 
         Returns
         -------
@@ -990,6 +995,8 @@ def from_content(cls, content, auction_id=0):
             raise InvalidContent("content does not belong to a auction details page in Tibia.com")
         auction = cls._parse_auction(auction_row)
         auction.auction_id = auction_id
+        if skip_details:
+            return auction
 
         details_tables = cls._parse_tables(parsed_content)
         if "General" in details_tables:

tibiapy/client.py

@@ -267,7 +267,8 @@ async def fetch_auction_history(self, page=1):
         parsing_time = time.perf_counter() - start_time
         return TibiaResponse(response, auction_history, parsing_time)
 
-    async def fetch_auction(self, auction_id, *, fetch_items=False, fetch_mounts=False, fetch_outfits=False):
+    async def fetch_auction(self, auction_id, *, fetch_items=False, fetch_mounts=False, fetch_outfits=False,
+                            skip_details=False):
         """Fetches an auction by its ID.
 
         .. versionadded:: 3.3.0
@@ -282,6 +283,11 @@ async def fetch_auction(self, auction_id, *, fetch_items=False, fetch_mounts=Fal
             Whether to fetch all of the character's mounts. By default only the first page is fetched.
         fetch_outfits: :class:`bool`
             Whether to fetch all of the character's outfits. By default only the first page is fetched.
+        skip_details: :class:`bool`, optional
+            Whether to skip parsing the entire auction and only parse the information shown in lists. False by default.
+
+            This allows fetching basic information like name, level, vocation, world, bid and status, shaving off some
+            parsing time.
 
         Returns
         -------
@@ -298,9 +304,9 @@ async def fetch_auction(self, auction_id, *, fetch_items=False, fetch_mounts=Fal
         """
         response = await self._request("GET", AuctionDetails.get_url(auction_id))
         start_time = time.perf_counter()
-        auction = AuctionDetails.from_content(response.content, auction_id)
+        auction = AuctionDetails.from_content(response.content, auction_id, skip_details)
         parsing_time = time.perf_counter() - start_time
-        if auction:
+        if auction and not skip_details:
             if fetch_items:
                 await self._fetch_all_pages(auction_id, auction.items, 0)
                 await self._fetch_all_pages(auction_id, auction.store_items, 1)