Hotfixes:

- Events response object uses .get() method now to accomodate different EventType HTTP responses.
- Various typehint error fixes.
- Fixed some duplicate tests coming from git merge/rebase mistakes.

Author: dehidehidehi

open_sea_v1/endpoints/assets.py

@@ -76,7 +76,7 @@ def url(self):
 
     @property
     def parsed_http_response(self) -> list[AssetResponse]:
-        return self.parse_http_response(AssetResponse, 'assets')
+        return self.parse_http_response(AssetResponse, 'assets')  # type: ignore
 
     def _get_request(self, **kwargs):
         params = dict(

open_sea_v1/endpoints/client.py

@@ -18,20 +18,29 @@ class ClientParams:
     """Common OpenSea Endpoint parameters to pass in."""
     offset: int = 0
     page_size: int = 50
-    limit: Optional[int] = None
+    limit: int = 50
     max_pages: Optional[int] = None
     api_key: Optional[str] = None
 
     def __post_init__(self):
+        if self.max_pages:
+            self.max_pages += 1  # prevent paginator from ending one page early
         self._validate_attrs()
-        self._decrement_max_pages_attr()
         self._set_max_rate_limit()
 
     def _validate_attrs(self) -> None:
-        if self.limit is not None and not 0 < self.limit <= 300:
+        if not 0 < self.limit <= 300:
             raise ValueError(f'{self.limit=} must be over 0 and lesser or equal to 300.')
-        if self.page_size is not None and not 0 <= self.page_size <= 50:
+
+        if self.max_pages is not None and self.max_pages <= 0:
+            raise ValueError(f'{self.max_pages=} must be greater than 0.')
+
+        if not 0 <= self.page_size <= 50:
             raise ValueError(f'{self.page_size=} must be between 0 and 50.')
+
+        if self.limit < self.page_size:
+            raise ValueError(f'{self.limit=} cannot be lesser than {self.page_size=}.')
+
         if self.max_pages is not None and self.max_pages < 0:
             raise ValueError(f'{self.max_pages=} must be greater than or equal to 0.')
 
@@ -49,6 +58,7 @@ def _set_max_rate_limit(self) -> None:
         if self.api_key:
             raise NotImplementedError("I don't know what the rate limit is for calls with an API key is yet.")
 
+
 @dataclass
 class BaseClient(ABC):
     """
@@ -61,20 +71,11 @@ class BaseClient(ABC):
         If True, will throttle the amount of requests per second to the OpenSea API.
         If you pass an API key into the client_params instance, the rate limiting will change accordingly.
         If False, will not throttle.
-
-    retry: bool
-        OpenSea will occasionally return an empty response object, although the same query would yield
-        a full response object afterwards.
-        If True, will pause the request for one second before trying again once.
-        If it fails again, the empty response is returned.
-        If set to False, the client always returns the first response object, even if it is empty.
-
     """
 
     client_params: ClientParams
     url = None
     rate_limiting: bool = True
-    retry: bool = True
 
     def __post_init__(self):
         self.processed_pages: int = 0
@@ -115,17 +116,20 @@ def get_pages(self) -> Generator[list[list[BaseResponse]], None, None]:
             if self.parsed_http_response is not None:  # edge case
                 self.processed_pages += 1
                 self.client_params.offset += self.client_params.page_size
+                self.client_params._decrement_max_pages_attr()
+                if not self.parsed_http_response:
+                    break  # prevents returning last empty page
                 yield self.parsed_http_response
 
     def remaining_pages(self) -> bool:
         if self._http_response is None:
             return True
 
-        if (max_pages_was_set := self.client_params.max_pages is not None) and \
-            (previous_page_was_not_empty := len(self.parsed_http_response) > 0) and \
-                (remaining_pages_until_max_pages := self.processed_pages <= self.client_params.max_pages):
-            return True
+        if is_the_last_page := len(self.parsed_http_response) < self.client_params.page_size:
+            return False
 
-        if is_not_the_last_page := len(self.parsed_http_response) >= self.client_params.offset:
-            return True
-        return False
+        max_pages_reached: bool = self.client_params.max_pages is not None and self.client_params.max_pages <= 0
+        if max_pages_reached:
+            return False
+
+        return True

open_sea_v1/endpoints/collections.py

@@ -50,7 +50,7 @@ def url(self):
 
     @property
     def parsed_http_response(self) -> list[CollectionResponse]:
-        return self.parse_http_response(CollectionResponse, 'collections')
+        return self.parse_http_response(CollectionResponse, 'collections')  # type: ignore
 
     def _get_request(self, **kwargs):
         params = dict(

open_sea_v1/endpoints/events.py

@@ -106,7 +106,7 @@ def _get_request(self, **kwargs) -> Response:
 
     @property
     def parsed_http_response(self) -> list[EventResponse]:
-        return self.parse_http_response(EventResponse, 'asset_events')
+        return self.parse_http_response(EventResponse, 'asset_events')  # type: ignore
 
     def _validate_request_params(self) -> None:
         self._validate_param_auction_type()

open_sea_v1/endpoints/orders.py

@@ -6,6 +6,7 @@
 from open_sea_v1.endpoints.abc import BaseEndpoint
 from open_sea_v1.endpoints.client import BaseClient, ClientParams, MAX_CALLS_PER_SECOND, RATE_LIMIT
 from open_sea_v1.endpoints.urls import EndpointURLS
+from open_sea_v1.responses.collection import CollectionResponse
 from open_sea_v1.responses.order import OrderResponse
 
 
@@ -107,15 +108,13 @@ class OrdersEndpoint(BaseClient, BaseEndpoint):
 
     def __post_init__(self):
         self._validate_request_params()
-        if not self.client_params:
-            raise AttributeError('Attribute client_params is missing.')
 
     @property
     def url(self):
         return EndpointURLS.ORDERS.value
 
     @property
-    def parsed_http_response(self) -> list[CollectionResponse]:
+    def parsed_http_response(self) -> list[OrderResponse]:
         orders_jsons = self._http_response.json()['orders']
         orders = [OrderResponse(order_json) for order_json in orders_jsons]
         return orders

open_sea_v1/endpoints/tests/test_assets.py

@@ -35,7 +35,7 @@ def test_param_token_ids_raise_exception_if_missing_contract_address_and_address
         self.assertRaises(ValueError, AssetsEndpoint, token_ids=[1, 2, 3])
 
     def test_params_cannot_be_simultaneously_be_passed_asset_contract_address_and_contract_addresses(self):
-        params = self.default_asset_params | dict(asset_contract_address=True, asset_contract_addresses=True)
+        params = self.default_asset_params | dict(asset_contract_address=True, asset_contract_addresses=True)  # type: ignore
         self.assertRaises(ValueError, AssetsEndpoint, **params)
 
     def test_param_token_ids_returns_assets_corresponding_to_single_contract(self):

open_sea_v1/endpoints/tests/test_client.py

@@ -6,63 +6,6 @@
 from open_sea_v1.responses.event import EventResponse
 
 
-
-class TestClientParams(TestCase):
-
-    def test_max_pages_attr_is_automatically_decremented_by_1(self):
-        params = ClientParams(max_pages=1)
-        self.assertEqual(params.max_pages, 0)
-
-    def test_max_pages_attr_raises_value_error_if_below_or_equal_to_zero(self):
-        self.assertRaises(ValueError, ClientParams, max_pages=-1)
-
-    def test_limit_attr_raises_value_error_if_not_between_0_and_300(self):
-        self.assertRaises(ValueError, ClientParams, limit=-1)
-        self.assertRaises(ValueError, ClientParams, limit=301)
-
-    def test_page_size_attr_raises_value_error_if_not_between_0_and_50(self):
-        self.assertRaises(ValueError, ClientParams, page_size=-1)
-        self.assertRaises(ValueError, ClientParams, page_size=51)
-
-
-class TestClientParams(TestCase):
-
-    def test_max_pages_attr_is_automatically_decremented_by_1(self):
-        params = ClientParams(max_pages=1)
-        self.assertEqual(params.max_pages, 0)
-
-    def test_max_pages_attr_raises_value_error_if_below_or_equal_to_zero(self):
-        self.assertRaises(ValueError, ClientParams, max_pages=-1)
-
-    def test_limit_attr_raises_value_error_if_not_between_0_and_300(self):
-        self.assertRaises(ValueError, ClientParams, limit=-1)
-        self.assertRaises(ValueError, ClientParams, limit=301)
-
-    def test_page_size_attr_raises_value_error_if_not_between_0_and_50(self):
-        self.assertRaises(ValueError, ClientParams, page_size=-1)
-        self.assertRaises(ValueError, ClientParams, page_size=51)
-
-
-
-
-class TestClientParams(TestCase):
-
-    def test_max_pages_attr_is_automatically_decremented_by_1(self):
-        params = ClientParams(max_pages=1)
-        self.assertEqual(params.max_pages, 0)
-
-    def test_max_pages_attr_raises_value_error_if_below_or_equal_to_zero(self):
-        self.assertRaises(ValueError, ClientParams, max_pages=-1)
-
-    def test_limit_attr_raises_value_error_if_not_between_0_and_300(self):
-        self.assertRaises(ValueError, ClientParams, limit=-1)
-        self.assertRaises(ValueError, ClientParams, limit=301)
-
-    def test_page_size_attr_raises_value_error_if_not_between_0_and_50(self):
-        self.assertRaises(ValueError, ClientParams, page_size=-1)
-        self.assertRaises(ValueError, ClientParams, page_size=51)
-
-
 class TestClientParams(TestCase):
 
     def test_max_pages_attr_is_automatically_decremented_by_1(self):
@@ -158,7 +101,7 @@ def test_pagination_does_not_return_duplicates_between_different_pages(self):
         limit = 2
         max_pages = 2
         self.sample_client.client_params = ClientParams(limit=limit, page_size=limit, max_pages=max_pages)
-        events_resps: list[EventResponse] = list(chain.from_iterable(self.sample_client.get_pages()))
+        events_resps: list[EventResponse] = list(chain.from_iterable(self.sample_client.get_pages()))  # type: ignore
         unique_ids = set(e.id for e in events_resps)
         self.assertEqual(len(unique_ids), (limit+1) * max_pages)
 

open_sea_v1/endpoints/tests/test_events.py

@@ -38,11 +38,11 @@ def test_param_auction_type_raises_if_not_from_auction_type_enum_values(self):
         self.assertRaises((ValueError, TypeError), self.create_and_get, **updated_kwargs)
 
     def test_param_auction_type_raises_if_not_isinstance_of_str(self):
-        updated_kwargs = self.events_default_kwargs | dict(auction_type=0.0)
+        updated_kwargs = self.events_default_kwargs | dict(auction_type=0.0)  # type: ignore
         self.assertRaises((ValueError, TypeError), self.create_and_get, **updated_kwargs)
 
     def test_param_auction_type_does_not_raise_if_is_none(self):
-        updated_kwargs = self.events_default_kwargs | dict(auction_type=None)
+        updated_kwargs = self.events_default_kwargs | dict(auction_type=None)  # type: ignore
         self.create_and_get(**updated_kwargs)
 
     def test_param_only_opensea_true_filters_properly(self):
@@ -55,30 +55,30 @@ def test_param_only_opensea_false_does_not_filter(self):
         """
         Have no idea how to test this param.
         """
-        # updated_kwargs = self.events_default_kwargs | dict(only_opensea=False, offset=1, limit=100)
+        # updated_kwargs = self.events_kwargs | dict(only_opensea=False, offset=1, limit=100)
         # events = self.create_and_get(**updated_kwargs)
         # self.assertTrue(any('opensea.io' not in event.asset.permalink for event in events))
         pass
 
     def test_param_occurred_before_raises_exception_if_not_datetime_instances(self):
-        updated_kwargs = self.events_default_kwargs | dict(occurred_before=True)
+        updated_kwargs = self.events_default_kwargs | dict(occurred_before=True)  # type: ignore
         self.assertRaises(TypeError, self.create_and_get, **updated_kwargs)
 
     def test_param_occurred_before_and_after_raises_exception_if_are_equal_values(self):
         dt_now = datetime.now()
         occurred_params = dict(occurred_before=dt_now, occurred_after=dt_now)
-        updated_kwargs = self.events_default_kwargs | occurred_params
+        updated_kwargs = self.events_default_kwargs | occurred_params  # type: ignore
         self.assertRaises(ValueError, self.create_and_get, **updated_kwargs)
 
     def test_param_occurred_before_and_after_does_not_raise_if_both_are_none(self):
-        updated_kwargs = self.events_default_kwargs | dict(occurred_before=None, occurred_after=None)
+        updated_kwargs = self.events_default_kwargs | dict(occurred_before=None, occurred_after=None)  # type: ignore
         self.create_and_get(**updated_kwargs)
 
     def test_param_occurred_after_cannot_be_higher_than_occurred_before(self):
         occurred_before = datetime.now()
         occurred_after = occurred_before + timedelta(microseconds=1)
         occurred_params = dict(occurred_before=occurred_before, occurred_after=occurred_after)
-        updated_kwargs = self.events_default_kwargs | occurred_params
+        updated_kwargs = self.events_default_kwargs | occurred_params  # type: ignore
         self.assertRaises(ValueError, self.create_and_get, **updated_kwargs)
 
     def test_param_occurred_after_filters_properly(self):

open_sea_v1/endpoints/tests/test_orders.py

@@ -32,14 +32,6 @@ def test_attr_token_id_raises_if_not_defined_together_with_asset_contract_addres
         self.endpoint_kwargs |= dict(asset_contract_address='str')
         OrdersEndpoint(**self.endpoint_kwargs)
 
-    def test_attr_token_ids_raises_if_len_is_above_30(self):
-        self.endpoint_kwargs |= dict(asset_contract_address=self.asset_contract_address, token_ids=list(range(1, 32)))
-        self.assertRaises(ValueError, OrdersEndpoint, **self.endpoint_kwargs)
-
-    def test_attr_token_ids_raises_if_len_is_above_30(self):
-        self.endpoint_kwargs |= dict(asset_contract_address=self.asset_contract_address, token_ids=list(range(1, 32)))
-        self.assertRaises(ValueError, OrdersEndpoint, **self.endpoint_kwargs)
-
     def test_attr_token_ids_raises_if_not_defined_together_with_asset_contract_address(self):
         self.endpoint_kwargs |= dict(token_ids=[1, 2])
         self.assertRaises(AttributeError, OrdersEndpoint, **self.endpoint_kwargs)

open_sea_v1/responses/asset.py

@@ -85,31 +85,28 @@ def __str__(self):
 
     def __post_init__(self):
         self._set_common_attrs()
-        self._set_optional_attrs()
 
     def _set_common_attrs(self):
-        self.token_id = str(self._json["token_id"])
-        self.num_sales = self._json["num_sales"]
-        self.background_color = self._json["background_color"]
-        self.image_url = self._json["image_url"]
-        self.image_preview_url = self._json["image_preview_url"]
-        self.image_thumbnail_url = self._json["image_thumbnail_url"]
-        self.image_original_url = self._json["image_original_url"]
-        self.animation_url = self._json["animation_url"]
-        self.animation_original_url = self._json["animation_original_url"]
-        self.name = self._json["name"]
-        self.description = self._json["description"]
-        self.external_link = self._json["external_link"]
-        self.permalink = self._json["permalink"]
-        self.decimals = self._json["decimals"]
-        self.token_metadata = self._json["token_metadata"]
-        self.id = str(self._json["id"])
-
-    def _set_optional_attrs(self):
         """
-        Most asset responses are alike, but some are returned with less information.
-        To avoid raising KeyErrors, we will use the .get method when setting these attributes.
+        Depending on the EventType you request, some elements of the json response will be missing.
+        For that reason we use .get() on every element.
         """
+        self.token_id = str(self._json.get("token_id") or '')
+        self.num_sales = self._json.get("num_sales")
+        self.background_color = self._json.get("background_color")
+        self.image_url = self._json.get("image_url")
+        self.image_preview_url = self._json.get("image_preview_url")
+        self.image_thumbnail_url = self._json.get("image_thumbnail_url")
+        self.image_original_url = self._json.get("image_original_url")
+        self.animation_url = self._json.get("animation_url")
+        self.animation_original_url = self._json.get("animation_original_url")
+        self.name = self._json.get("name")
+        self.description = self._json.get("description")
+        self.external_link = self._json.get("external_link")
+        self.permalink = self._json.get("permalink")
+        self.decimals = self._json.get("decimals")
+        self.token_metadata = self._json.get("token_metadata")
+        self.id = str(self._json.get("id") or '')
         self.transfer_fee = self._json.get("transfer_fee")
         self.transfer_fee_payment_token = self._json.get("transfer_fee_payment_token")
         self.is_presale = self._json.get("is_presale")