async-universalis 4.0.0.dev0__tar.gz → 4.1.0.dev0__tar.gz

{async_universalis-4.0.0.dev0/async_universalis.egg-info → async_universalis-4.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: async_universalis
-Version: 4.0.0.dev0
+Version: 4.1.0.dev0
 Summary: A bare-bones wrapper package to utilitize Universalis API in python.
 Author-email: k8thekat <Cadwalladerkatelynn@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE

{async_universalis-4.0.0.dev0 → async_universalis-4.1.0.dev0}/async_universalis/__init__.py

@@ -23,7 +23,7 @@ from __future__ import annotations
 __title__ = "Universalis API wrapper"
 __author__ = "k8thekat"
 __license__ = "GNU"
-__version__ = "4.0.0-dev"
+__version__ = "4.1.0-dev"
 __credits__ = "Universalis and Square Enix"
 
 
@@ -241,14 +241,6 @@ class UniversalisAPI:
             data = await session.get(url=url, **request_params)
 
         LOGGER.debug("<%s._request> | Status Code: %s | Content Type: %s", __class__.__name__, data.status, data.content_type)
-        if not 200 <= data.status < 300:
-            raise UniversalisError(data.status, url, "generic http request")
-        if data.status == 400:
-            raise UniversalisError(
-                data.status,
-                url,
-                "invalid parameters",
-            )
         # 404 - The world/DC or item requested is invalid. When requesting multiple items at once, an invalid item ID will not trigger this.
         # Instead, the returned list of unresolved item IDs will contain the invalid item ID or IDs.
         if data.status == 404:
@@ -257,7 +249,14 @@ class UniversalisAPI:
                 url,
                 "invalid World/DC or Item ID",
             )
-
+        if data.status == 400:
+            raise UniversalisError(
+                data.status,
+                url,
+                "invalid parameters",
+            )
+        if not 200 <= data.status < 300:
+            raise UniversalisError(data.status, url, "generic http request")
         self.api_call_time = datetime.datetime.now(datetime.UTC)
         res: Any = await data.json()
         return res
@@ -284,11 +283,11 @@ class UniversalisAPI:
 
 
         .. note::
-            - If you specify a `<World>`.
+            - If you specify a :class:`World` when getting marketboard data..
                 - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will not have the attributes `world_name`.
-            - If you specify a `<DataCenter>`.
+            - If you specify a :class:`DataCenter` when getting marketboard data...
                 - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will have the `world_id` and `world_name` attributes.
-                - `<CurrentData>` will also have an additional attribute called `dc_name`.
+                - :class:`CurrentData` will also have an additional attribute called `dc_name`.
 
         .. note::
             You can change the default DataCenter by setting the `<UniversalisAPI>.datacenter` property.
@@ -359,11 +358,11 @@ class UniversalisAPI:
             - See `https://docs.universalis.app/` and use their forms to generate a string with the fields you want.
 
         .. note::
-            - If you specify a `<World>`.
+            - If you specify a :class:`World` when getting marketboard data..
                 - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will not have the attributes `world_name`.
-            - If you specify a `<DataCenter>`.
+            - If you specify a :class:`DataCenter` when getting marketboard data...
                 - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will have the `world_id` and `world_name` attributes.
-                - `<CurrentData>` will also have an additional attribute called `dc_name`.
+                - :class:`CurrentData` will also have an additional attribute called `dc_name`.
 
 
         .. note::
@@ -441,11 +440,18 @@ class UniversalisAPI:
             LOGGER.debug("<%s._get_bulk_current_data>. | URL: %s | Response:\n%s", __class__.__name__, api_url, res)
 
             # results.extend([CurrentData(universalis=self, data=value) for value in res.get("items").values() if "listings" in value])
-            data = MultiPart(
-                universalis=self,
-                resolved_items=[CurrentData(universalis=self, data=value) for value in res.get("items").values() if "listings" in value],
-                **res,
-            )
+            if data is None:
+                data = MultiPart(
+                    universalis=self,
+                    resolved_items=[
+                        CurrentData(universalis=self, data=value) for value in res.get("items").values() if "listings" in value
+                    ],
+                    **res,
+                )
+            else:
+                data.items.extend([CurrentData(universalis=self, data=value) for value in res.get("items").values() if "listings" in value])
+                data.unresolved_items.extend(res["unresolvedItems"])
+
         return data
 
     async def get_history_data(
@@ -470,9 +476,9 @@ class UniversalisAPI:
 
 
         .. note::
-            - If you specify a `<World>`.
+            - If you specify a :class:`World` when getting marketboard data..
                 - All `<HistoryData.entries>` will not have the attributes `world_name`.
-            - If you specify a `<DataCenter>`.
+            - If you specify a :class:`DataCenter` when getting marketboard data...
                 - All  `<HistoryData.entries>` will have the `world_id` and `world_name` attributes.
                 - `<HistoryData>` will also have an additional attribute called `dc_name`.
 
@@ -538,9 +544,9 @@ class UniversalisAPI:
 
 
         .. note::
-            - If you specify a `<World>`.
+            - If you specify a :class:`World` when getting marketboard data..
                 - All `<HistoryData.entries>` will not have the attributes `world_name`.
-            - If you specify a `<DataCenter>`.
+            - If you specify a :class:`DataCenter` when getting marketboard data...
                 - All  `<HistoryData.entries>` will have the `world_id` and `world_name` attributes.
                 - `<HistoryData>` will also have an additional attribute called `dc_name`.
 
@@ -592,7 +598,7 @@ class UniversalisAPI:
         if world_or_dc is None:
             world_or_dc = self.default_datacenter
 
-        # If we are given a single entry in our list; use the `get_current_data` instead.
+        # If we are given a single entry in our list; use the `get_history_data` instead.
         # We could modify the `join` statement below; but this is far easier and provides the same results.
         # So if the `dcName` key exists, we searched by a DataCenter.
         # otherwise the `worldName` and `worldID` key will exist.
@@ -623,11 +629,15 @@ class UniversalisAPI:
                 res,
             )
             # results.extend(HistoryData(universalis=self, data=value) for value in res.get("items").values() if "entries" in value)
-            data = MultiPart(
-                universalis=self,
-                resolved_items=[HistoryData(universalis=self, data=value) for value in res.get("items").values() if "entries" in value],
-                **res,
-            )
+            if data is None:
+                data = MultiPart(
+                    universalis=self,
+                    resolved_items=[HistoryData(universalis=self, data=value) for value in res.get("items").values() if "entries" in value],
+                    **res,
+                )
+            else:
+                data.items.extend([HistoryData(universalis=self, data=value) for value in res.get("items").values() if "entries" in value])
+                data.unresolved_items.extend(res["unresolvedItems"])
         return data
 
     @staticmethod
@@ -710,9 +720,9 @@ class Generic:
     _repr_keys: list[str]
 
     world_id: Optional[int]
-    world_name: Optional[str]
-    # This value only exists if you look up results by "Datacenter" instead of "World"
+    # world_name: Optional[str]
     dc_name: Optional[str]
+    "This value only exists if you look up results by `Datacenter` instead of `World`"
     _raw: DataTypedAliase | MultiPartData
 
     def __init__(self, data: DataTypedAliase | MultiPartData) -> None:
@@ -732,6 +742,23 @@ class Generic:
                 f"{e}: {getattr(self, e)}" for e in sorted(self.__dict__) if e.startswith("_") is False
             ])
 
+    @property
+    def world_name(self) -> Optional[str]:
+        """The Final Fantasy 14 World name, if applicable.
+
+        .. note::
+            - If you specify a :class:`World` when getting marketboard data..
+                - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will not have the attributes `world_name`.
+            - If you specify a :class:`DataCenter` when getting marketboard data...
+                - All `<CurrentData.listings>` and `<CurrentData.recent_history>` will have the `world_id` and `world_name` attributes.
+                - :class:`CurrentData` will also have an additional attribute called `dc_name`.
+        """
+        return self._world_name
+
+    @world_name.setter
+    def world_name(self, value: Optional[str]) -> None:
+        self._world_name: Optional[str] = value
+
 
 class GenericData(Generic):
     """Base class for mutual attributes and properties for Universalis data.
@@ -906,6 +933,7 @@ class CurrentData(GenericData):
         self._universalis = universalis
         self._repr_keys = [
             "world_name",
+            "dc_name",
             "last_upload_time",
             "item_id",
             "regular_sale_velocity",
@@ -923,6 +951,7 @@ class CurrentData(GenericData):
         # We get it early here, as the for loop won't set it to `None` if the data isn't there.
         # This is being used for `CurrentDataEntries` as fetching "world" data doesn't provide the field to `listings`.
         self.world_name = data.get("worldName", None)
+        self.dc_name = data.get("dcName", None)
 
         for key_, value in data.items():
             key = UniversalisAPI.from_camel_case(key_name=key_)
@@ -931,8 +960,8 @@ class CurrentData(GenericData):
                 self.listings = value
 
             # This should handle price formatting.
-            elif "price" in key.lower() and (isinstance(value, (int, float))):
-                setattr(self, key, f"{round(value):,d}")
+            # elif "price" in key.lower() and (isinstance(value, (int, float))):
+            #     setattr(self, key, f"{round(value):,d}")
 
             elif key.lower() == "has_data" and isinstance(value, int):
                 self.has_data = bool(value)
@@ -948,7 +977,9 @@ class CurrentData(GenericData):
 
     @listings.setter
     def listings(self, value: list[CurrentListing]) -> None:
-        self._listings: list[CurrentDataEntries] = sorted([CurrentDataEntries(data=entry, world_name=self.world_name) for entry in value])
+        self._listings: list[CurrentDataEntries] = sorted([
+            CurrentDataEntries(data=entry, world_name=self.world_name, dc_name=self.dc_name) for entry in value
+        ])
 
     @property
     def recent_history(self) -> list[HistoryDataEntries]:
@@ -957,7 +988,9 @@ class CurrentData(GenericData):
 
     @recent_history.setter
     def recent_history(self, value: list[HistoryEntries]) -> None:
-        self._recent_history: list[HistoryDataEntries] = sorted([HistoryDataEntries(data=entry) for entry in value])
+        self._recent_history: list[HistoryDataEntries] = sorted([
+            HistoryDataEntries(data=entry, world_name=self.world_name, dc_name=self.dc_name) for entry in value
+        ])
 
 
 class CurrentDataEntries(Generic):
@@ -1037,7 +1070,7 @@ class CurrentDataEntries(Generic):
     _last_review_time: datetime.datetime | int
     _materia: int
 
-    def __init__(self, data: CurrentListing, *, world_name: Optional[str] = None) -> None:
+    def __init__(self, data: CurrentListing, *, world_name: Optional[str] = None, dc_name: Optional[str] = None) -> None:
         """Build your JSON response :class:`CurrentDataEntries`.
 
         Represents the data from property `<CurrentData>.listings`.
@@ -1048,20 +1081,23 @@ class CurrentDataEntries(Generic):
             The JSON response data as a dict.
         world_name: :class:`Optional[str]`
             The Final Fantasy 14 World name, if applicable.
+        dc_name: :class:`Optional[str]`
+            The Final Fantasy 14 DataCenter name, if applicable.
 
         """
         super().__init__(data=data)
-        self._repr_keys = ["world_name", "price_per_unit", "quantity", "hq", "materia", "total", "tax"]
+        self._repr_keys = ["world_name", "dc_name", "price_per_unit", "quantity", "hq", "materia", "total", "tax"]
 
         self.world_name = world_name
+        self.dc_name = dc_name
         for key_, value in data.items():
             key = UniversalisAPI.from_camel_case(key_name=key_)
             if key.lower() in {"on_mannequin", "is_crafted", "hq"} and isinstance(value, int):
                 setattr(self, key, bool(value))
 
             # This should handle price formatting.
-            elif isinstance(value, (int, float)) and ("price" in key.lower() or key.lower() == "total" or key.lower() == "tax"):
-                setattr(self, key, f"{round(value):,d}")
+            # elif isinstance(value, (int, float)) and ("price" in key.lower() or key.lower() == "total" or key.lower() == "tax"):
+            #     setattr(self, key, f"{round(value):,d}")
 
             else:
                 setattr(self, key, value)
@@ -1218,8 +1254,8 @@ class HistoryData(GenericData):
             if key.lower() == "entries" and isinstance(value, list):
                 self.entries = value
             # This should handle price formatting.
-            elif isinstance(value, (int, float)) and "velocity" in key:
-                setattr(self, key, f"{round(value):,d}")
+            # elif isinstance(value, (int, float)) and "velocity" in key:
+            #     setattr(self, key, f"{round(value):,d}")
             else:
                 setattr(self, key, value)
         self.name = self._universalis._get_item(self.item_id)  # type: ignore[reportPrivateUsage] # noqa: SLF001
@@ -1277,7 +1313,7 @@ class HistoryDataEntries(Generic):
     world_id: Optional[int]
     _timestamp: datetime.datetime | int
 
-    def __init__(self, data: HistoryEntries, *, world_name: Optional[str] = None) -> None:
+    def __init__(self, data: HistoryEntries, *, world_name: Optional[str] = None, dc_name: Optional[str] = None) -> None:
         """Build your JSON response :class:`HistoryDataEntries`.
 
         Represents the data from property `<HistoryData>.entries` and `<CurrentData>.recent_history`.
@@ -1288,11 +1324,14 @@ class HistoryDataEntries(Generic):
             The JSON response data as a dict.
         world_name: :class:`Optional[str]`
             The Final Fantasy 14 World name, if applicable.
+        dc_name: :class:`Optional[str]`
+            The Final Fantasy 14 DataCenter name, if applicable.
 
         """
         super().__init__(data=data)
-        self._repr_keys = ["world_name", "timestamp", "quantity", "price_per_unit", "hq"]
+        self._repr_keys = ["world_name", "dc_name", "timestamp", "quantity", "price_per_unit", "hq"]
         self.world_name = world_name
+        self.dc_name = dc_name
 
         for key_, value in data.items():
             key: str = UniversalisAPI.from_camel_case(key_name=key_)
@@ -1300,8 +1339,8 @@ class HistoryDataEntries(Generic):
                 setattr(self, key, bool(value))
 
             # This should handle price formatting.
-            elif isinstance(value, (int, float)) and "price" in key:
-                setattr(self, key, f"{round(value):,d}")
+            # elif isinstance(value, (int, float)) and "price" in key:
+            #     setattr(self, key, f"{round(value):,d}")
             else:
                 setattr(self, key, value)
 

{async_universalis-4.0.0.dev0 → async_universalis-4.1.0.dev0/async_universalis.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: async_universalis
-Version: 4.0.0.dev0
+Version: 4.1.0.dev0
 Summary: A bare-bones wrapper package to utilitize Universalis API in python.
 Author-email: k8thekat <Cadwalladerkatelynn@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE