django-esi 8.0.0b1__tar.gz → 8.0.0b2__tar.gz

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-esi
-Version: 8.0.0b1
+Version: 8.0.0b2
 Summary: Django app for accessing the EVE Swagger Interface (ESI).
 Keywords: eveonline
 Author-email: Alliance Auth <adarnof@gmail.com>
@@ -9,7 +9,6 @@ Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.1
 Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
@@ -28,8 +27,10 @@ Requires-Dist: aiopenapi3
 Requires-Dist: bravado>=10.6,<12
 Requires-Dist: celery>=4.0.2
 Requires-Dist: django>=4.2,<6
+Requires-Dist: django-redis>=5.2
 Requires-Dist: httpx[brotli, http2, zstd]
 Requires-Dist: jsonschema<4
+Requires-Dist: pydantic>=2.12.3
 Requires-Dist: python-jose>=3.3
 Requires-Dist: requests>=2.26
 Requires-Dist: requests-oauthlib>=0.8

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/__init__.py

@@ -1,6 +1,6 @@
 """Django app for accessing the EVE Swagger Interface (ESI)."""
 
-__version__ = "8.0.0-beta.1"
+__version__ = "8.0.0-beta.2"
 __title__ = 'Django-ESI'
 __url__ = 'https://gitlab.com/allianceauth/django-esi'
 __build_date__ = "2025-09-18"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/aiopenapi3/plugins.py

@@ -1,6 +1,9 @@
 import logging
 from typing import Any
+
 from collections.abc import Generator
+from django.conf import settings
+
 from aiopenapi3.plugin import Document, Init
 
 logger = logging.getLogger(__name__)
@@ -54,9 +57,16 @@ class MinifySpec(Document):
         self.keep_ops = operations
 
     def parsed(self, ctx: Document.Context) -> Document.Context:
-        if self.keep_tags == set() and self.keep_ops == []:
-            logger.error("No tag/path filtering supplied to ESI Client. Using all tags. This will bloat memory use!")
+
+        if len(self.keep_tags) == 0 and self.keep_ops == []:
+            logger.error("No tag/path filtering supplied to ESI Client. Using all tags. This throw an error with `DEBUG=False`!", stack_info=True)
+            if not getattr(settings, "DEBUG", False):
+                # we are in production mode throw error to protect RAM.
+                raise AttributeError("No tag/path filtering supplied to ESI Client.")
+            # We are in debug mode allow an unfiltered client.
             return ctx
+
+        # filter the client.
         spec = ctx.document
 
         remove_paths = set()

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/clients.py

@@ -1,5 +1,6 @@
 import json
 import logging
+from timeit import default_timer
 import warnings
 import datetime as dt
 from hashlib import md5
@@ -10,7 +11,7 @@ from urllib import parse as urlparse
 from bravado import requests_client
 from bravado.client import SwaggerClient
 from bravado.exception import (
-    HTTPBadGateway, HTTPGatewayTimeout, HTTPServiceUnavailable,
+    HTTPBadGateway, HTTPGatewayTimeout, HTTPServiceUnavailable, HTTPError,
 )
 from bravado.http_future import HttpFuture
 from bravado.swagger_model import Loader
@@ -22,6 +23,7 @@ from django.core.cache import cache
 
 from . import __title__, __url__, __version__, app_settings
 from .errors import TokenExpiredError
+from .signals import esi_request_statistics
 
 logger = logging.getLogger(__name__)
 
@@ -144,6 +146,19 @@ class CachingHttpFuture(HttpFuture):
             for language in my_languages
         }
 
+    def _send_signal(self, status_code: int, headers: dict = {}, latency: float = 0) -> None:
+        """
+            Dispatch the esi request statistics signal
+        """
+        esi_request_statistics.send(
+            sender=self.__class__,
+            operation=self.operation.path_name,
+            status_code=status_code,
+            headers=headers,
+            latency=latency,
+            bucket=""
+        )
+
     def result(self, **kwargs) -> Any | tuple[Any, IncomingResponse]:
         """Executes the request and returns the response from ESI. Response will
         include the requested / first page only if there are more pages available.
@@ -191,6 +206,9 @@ class CachingHttpFuture(HttpFuture):
                 )
 
             if cached:
+                self._send_signal(
+                    status_code=0
+                )
                 result, response = cached
                 expiry = self._time_to_expiry(str(response.headers.get('Expires')))
                 if expiry < 0:
@@ -245,6 +263,7 @@ class CachingHttpFuture(HttpFuture):
 
         retries = 0
         while retries <= max_retries:
+            _t = default_timer()
             try:
                 if app_settings.ESI_INFO_LOGGING_ENABLED:
                     params = self.future.request.params
@@ -269,6 +288,11 @@ class CachingHttpFuture(HttpFuture):
                     logger.debug('ESI response content: %s', response.text)
                 break
             except (HTTPBadGateway, HTTPGatewayTimeout, HTTPServiceUnavailable) as ex:
+                self._send_signal(
+                    status_code=ex.status_code,
+                    headers=ex.response.headers,
+                    latency=default_timer() - _t
+                )
                 if retries < max_retries:
                     retries += 1
                     logger.warning(
@@ -285,7 +309,23 @@ class CachingHttpFuture(HttpFuture):
                     sleep(wait_secs)
                 else:
                     raise ex
+            except HTTPError as ex:
+                """
+                    Throw any other error into the signal
+                    then just re-raise
+                """
+                self._send_signal(
+                    status_code=ex.status_code,
+                    headers=ex.response.headers,
+                    latency=default_timer() - _t
+                )
+                raise ex
 
+        self._send_signal(
+            status_code=response.status_code,
+            headers=response.headers,
+            latency=default_timer() - _t
+        )
         # restore original value
         self.request_config.also_return_response = _also_return_response
         return result, response

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/decorators.py

@@ -1,7 +1,8 @@
-import functools
 import logging
 import time
 from functools import wraps
+from typing import Any
+from collections.abc import Callable
 
 from django.core.cache import cache
 
@@ -227,12 +228,20 @@ def single_use_token(scopes='', new=False):
     return decorator
 
 
-def wait_for_esi_errorlimit_reset(cache_key="esi_error_limit_reset", poll_interval=1):
+def wait_for_esi_errorlimit_reset(cache_key="esi_error_limit_reset", poll_interval=1) -> Callable[..., Callable[..., Any]]:
+    """
+    Decorator to apply a polling sleep while the ESI Server/Client is in an Error Limit state
+    The preferred non-blocking method is to retry your tasks after the limit reset time has passed
+
+    Args:
+        cache_key (str, optional):  NOT USUALLY CHANGED. Defaults to "esi_error_limit_reset".
+        poll_interval (int, optional): Interval in seconds to poll redis. Defaults to 1.
+    """
     def decorator(func):
         def wrapper(*args, **kwargs):
             reset = cache.get(cache_key)
             if reset is not None:
-                print(f"ESI Error Limited, waiting {reset}s before retrying...")
+                logger.error(f"ESI Error Limited, waiting {reset}s before retrying...")
                 while cache.get(cache_key):
                     time.sleep(poll_interval)
             return func(*args, **kwargs)
@@ -240,16 +249,23 @@ def wait_for_esi_errorlimit_reset(cache_key="esi_error_limit_reset", poll_interv
     return decorator
 
 
-def esi_rate_limiter_bucketed(
-    bucket: ESIRateLimitBucket,
-    raise_on_limit: bool = True,
-):
-    # TODO Investigate esi cache hits.
+def esi_rate_limiter_bucketed(bucket: ESIRateLimitBucket, raise_on_limit: bool = True):
+    """
+    Decorator for custom manual rate limits on some endpoints to apply a polling sleep while the bucket is exhausted.
+    MARKET_DATA_HISTORY
+    CHARACTER_CORPORATION_HISTORY
+    The preferred non-blocking method is to retry your tasks after the limit reset time has passed
+
 
+    Args:
+        bucket (ESIRateLimitBucket): The Bucket to rate limit against
+        raise_on_limit (bool, optional): Whether to raise an Exception when the limit is reached. Defaults to True.
+    """
+    # TODO Investigate esi cache hits.
     def decorator(func):
-        @functools.wraps(func)
+        @wraps(func)
         def wrapper(*args, **kwargs):
-            ESIRateLimits.check_bucket(bucket, raise_on_limit)
+            ESIRateLimits.check_decr_bucket(bucket, raise_on_limit)
             return func(*args, **kwargs)
         return wrapper
     return decorator

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/exceptions.py

@@ -4,10 +4,12 @@ from aiopenapi3.errors import HTTPServerError as base_HTTPServerError
 from aiopenapi3.errors import HTTPClientError as base_HTTPClientError
 from aiopenapi3.errors import HTTPError
 
+
 class ESIErrorLimitException(Exception):
     """ESI Global Error Limit Exceeded
     https://developers.eveonline.com/docs/services/esi/best-practices/#error-limit
     """
+
     def __init__(self, reset=None, *args, **kwargs) -> None:
         self.reset = reset
         msg = kwargs.get("message") or (
@@ -18,8 +20,10 @@ class ESIErrorLimitException(Exception):
 
 class ESIBucketLimitException(Exception):
     """Endpoint (Bucket) Specific Rate Limit Exceeded"""
-    def __init__(self, bucket, *args, **kwargs) -> None:
+
+    def __init__(self, bucket, reset: float = 0, *args, **kwargs) -> None:
         self.bucket = bucket
+        self.reset = reset
         msg = kwargs.get("message") or f"ESI bucket limit reached for {bucket}."
         super().__init__(msg, *args)
 
@@ -37,11 +41,11 @@ class HTTPNotModified(HTTPError):
 
 @dataclasses.dataclass(repr=False)
 class HTTPClientError(base_HTTPClientError):
-    """response code 4xx"""
+    """HTTP Response Code 4xx"""
     pass
 
 
 @dataclasses.dataclass(repr=False)
 class HTTPServerError(base_HTTPServerError):
-    """response code 5xx"""
+    """HTTP Response Code 5xx"""
     pass

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/helpers.py

@@ -25,6 +25,7 @@ def get_token(character_id: int, scopes: list) -> Token:
         )
     return token
 
+
 def pascal_case_string(string: str) -> str:
     """
     Convert a string to PascalCase by capitalizing the first letter of each word and removing spaces,

{django_esi-8.0.0b1/esi/locale/pl_PL → django_esi-8.0.0b2/esi/locale/cs_CZ}/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/de/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: Peter Pfeufer, 2023\n"
 "Language-Team: German (https://app.transifex.com/alliance-auth/teams/107430/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/en/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/es/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: trenus, 2023\n"
 "Language-Team: Spanish (https://app.transifex.com/alliance-auth/teams/107430/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/fr_FR/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2020-12-28 06:44+0000\n"
 "Last-Translator: rockclodbuster, 2023\n"
 "Language-Team: French (France) (https://app.transifex.com/alliance-auth/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/it_IT/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: Thomas Turini, 2024\n"
 "Language-Team: Italian (Italy) (https://app.transifex.com/alliance-auth/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/ja/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: kotaneko, 2023\n"
 "Language-Team: Japanese (https://app.transifex.com/alliance-auth/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/ko_KR/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: Seowon Jung <seowon@hawaii.edu>, 2023\n"
 "Language-Team: Korean (Korea) (https://app.transifex.com/alliance-auth/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/nl_NL/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1/esi/locale/cs_CZ → django_esi-8.0.0b2/esi/locale/pl_PL}/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/ru/LC_MESSAGES/django.po

@@ -10,9 +10,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: Gnevich <and.vareba81@gmail.com>, 2025\n"
 "Language-Team: Russian (https://app.transifex.com/alliance-auth/teams/107430/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/sk/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/uk/LC_MESSAGES/django.po

@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/locale/zh_Hans/LC_MESSAGES/django.po

@@ -9,9 +9,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Django ESI 8.0.0-beta.1\n"
+"Project-Id-Version: Django ESI 8.0.0-beta.2\n"
 "Report-Msgid-Bugs-To: https://gitlab.com/allianceauth/django-esi/-/issues\n"
-"POT-Creation-Date: 2025-10-17 15:19+1000\n"
+"POT-Creation-Date: 2025-10-31 15:18+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
 "Last-Translator: heguyChen, 2023\n"
 "Language-Team: Chinese Simplified (https://app.transifex.com/alliance-auth/"

{django_esi-8.0.0b1 → django_esi-8.0.0b2}/esi/managers.pyi

@@ -54,6 +54,9 @@ class TokenManager(Manager[Token]):
     def get_queryset(self) -> "TokenQueryset":
         ...
 
+    def require_scopes(self, scope_string: str | list) -> "TokenQueryset":
+        ...
+
     def filter(self, *args: Any, **kwargs: Any) -> "TokenQueryset":
         ...