Modernize project

hexproof/mtgjson/fetch.py

@@ -2,25 +2,27 @@
 * MTGJSON Request Handling
 """
 import os
-# Standard Library Imports
-from typing import Callable, Optional
 from pathlib import Path
+from typing import Callable, Optional
 
-# Third Party Imports
 import requests
 import yarl
-from ratelimit import sleep_and_retry, RateLimitDecorator
-from backoff import on_exception, expo
-from omnitils.fetch import request_header_default, download_file
+from backoff import expo, on_exception
+from limits import RateLimitItemPerHour, RateLimitItemPerSecond
+from limits.storage import MemoryStorage
+from limits.strategies import MovingWindowRateLimiter
+from omnitils.fetch import download_file, request_header_default
 from omnitils.files.archive import unpack_tar_gz
+from omnitils.rate_limit import rate_limit
 
-# Local Imports
-from hexproof.mtgjson.enums import MTGJsonURL
 from hexproof.mtgjson import schema as MTGJsonTypes
+from hexproof.mtgjson.enums import MTGJsonURL
 
 # Rate limiter to safely limit MTGJSON requests
-mtgjson_rate_limit = RateLimitDecorator(calls=20, period=1)
-mtgjson_gql_rate_limit = RateLimitDecorator(calls=20, period=1)
+_rate_limit_storage = MemoryStorage()
+_rate_limiter = MovingWindowRateLimiter(_rate_limit_storage)
+_mtgjson_rate_limit = RateLimitItemPerSecond(20)
+_mtgjson_gql_rate_limit = RateLimitItemPerHour(500)
 
 
 """
@@ -35,8 +37,7 @@ def request_handler_mtgjson(func) -> Callable:
         There are no known rate limits for requesting JSON file resources.
         We include a 20-per-second rate limit just to be nice.
     """
-    @sleep_and_retry
-    @mtgjson_rate_limit
+    @rate_limit(limiter=_rate_limiter, limit=_mtgjson_rate_limit)
     @on_exception(expo, requests.exceptions.RequestException, max_tries=2, max_time=1)
     def decorator(*args, **kwargs):
         return func(*args, **kwargs)
@@ -50,8 +51,7 @@ def request_handler_mtgjson_gql(func) -> Callable:
         MTGJSON GraphQL requests are capped at 500 per-hour per-token at the moment.
         https://mtgjson.com/mtggraphql/#rate-limits
     """
-    @sleep_and_retry
-    @mtgjson_gql_rate_limit
+    @rate_limit(limiter=_rate_limiter, limit=_mtgjson_gql_rate_limit)
     @on_exception(expo, requests.exceptions.RequestException, max_tries=2, max_time=1)
     def decorator(*args, **kwargs):
         return func(*args, **kwargs)

hexproof/mtgjson/schema/card.py

@@ -316,5 +316,3 @@ class CardToken(Schema):
 """
 
 Card = Union[CardAtomic, CardDeck, CardSet, CardSetDeck, CardToken]
-Card.__doc__ = ('A Card is a data structure with variations of Data Models that is found within files '
-                'that reference cards, and is not a Data Model itself.')

hexproof/mtgpics/fetch.py

@@ -1,23 +1,26 @@
 """
 * MTGPics Data Requests
 """
-# Standard Libray Imports
 from typing import Callable, Optional
 
-# Third Party Imports
 import requests
 import yarl
 from backoff import expo, on_exception
+from limits import RateLimitItemPerSecond
+from limits.storage import MemoryStorage
+from limits.strategies import MovingWindowRateLimiter
 from omnitils.exceptions import return_on_exception
 from omnitils.fetch import request_header_default
-from ratelimit import sleep_and_retry, RateLimitDecorator
+from omnitils.rate_limit import rate_limit
 
 """
 * MTGPics Request Handlers
 """
 
-# Rate limiter to safely limit Scryfall requests
-mtgp_rate_limit = RateLimitDecorator(calls=20, period=1)
+# Rate limiter to safely limit MTGPics requests
+_rate_limit_storage = MemoryStorage()
+_rate_limiter = MovingWindowRateLimiter(_rate_limit_storage)
+_rate_limit = RateLimitItemPerSecond(20)
 
 
 def request_handler_mtgpics(func: Callable) -> Callable:
@@ -30,8 +33,7 @@ def request_handler_mtgpics(func: Callable) -> Callable:
         Wrapped function.
     """
 
-    @sleep_and_retry
-    @mtgp_rate_limit
+    @rate_limit(limiter=_rate_limiter, limit=_rate_limit)
     @on_exception(expo, requests.exceptions.RequestException, max_tries=2, max_time=1)
     def wrapper(*args, **kwargs):
         return func(*args, **kwargs)

hexproof/scryfall/enums.py

@@ -231,6 +231,7 @@ class SetType(StrConstant):
     Core = 'core'
     Expansion = 'expansion'
     Masters = 'masters'
+    Eternal = 'eternal'
     Alchemy = 'alchemy'
     Masterpiece = 'masterpiece'
     Arsenal = 'arsenal'

hexproof/scryfall/fetch.py

@@ -1,25 +1,27 @@
 """
 * Scryfall Request Handling
 """
-# Third Party Imports
 from pathlib import Path
 from typing import Callable, Optional
 
-# Third Party Imports
 import requests
 import yarl
-from omnitils.fetch import request_header_default, download_file
+from backoff import expo, on_exception
+from limits import RateLimitItemPerSecond
+from limits.storage import MemoryStorage
+from limits.strategies import MovingWindowRateLimiter
+from omnitils.fetch import download_file, request_header_default
+from omnitils.rate_limit import rate_limit
 from omnitils.strings import normalize_str
-from ratelimit import sleep_and_retry, RateLimitDecorator
-from backoff import on_exception, expo
 from requests import RequestException
 
-# Local Imports
-from hexproof.scryfall.enums import ScryURL
 from hexproof.scryfall import schema as ScrySchema
+from hexproof.scryfall.enums import ScryURL
 
-# Rate limiter to safely limit MTGJSON requests
-scryfall_rate_limit = RateLimitDecorator(calls=20, period=1)
+# Rate limiter to safely limit Scryfall requests
+_rate_limit_storage = MemoryStorage()
+_rate_limiter = MovingWindowRateLimiter(_rate_limit_storage)
+_rate_limit = RateLimitItemPerSecond(20)
 
 
 """
@@ -42,8 +44,7 @@ def request_handler_scryfall(func) -> Callable:
     Returns:
         The wrapped function.
     """
-    @sleep_and_retry
-    @scryfall_rate_limit
+    @rate_limit(limiter=_rate_limiter, limit=_rate_limit)
     @on_exception(expo, RequestException, max_tries=2, max_time=1)
     def decorator(*args, **kwargs):
         return func(*args, **kwargs)