django-esi 7.0.1__py3-none-any.whl → 8.0.0a2__py3-none-any.whl

{django_esi-7.0.1.dist-info → django_esi-8.0.0a2.dist-info}/METADATA

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: django-esi
-Version: 7.0.1
+Version: 8.0.0a2
 Summary: Django app for accessing the EVE Swagger Interface (ESI).
+Keywords: eveonline
 Author-email: Alliance Auth <adarnof@gmail.com>
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
@@ -15,8 +16,6 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -24,14 +23,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 License-File: LICENSE
+Requires-Dist: aiopenapi3
 Requires-Dist: bravado>=10.6,<12
-Requires-Dist: brotli
 Requires-Dist: celery>=4.0.2
 Requires-Dist: django>=4.2,<6
+Requires-Dist: httpx[http2, brotli, zstd]
 Requires-Dist: jsonschema<4
 Requires-Dist: python-jose>=3.3
 Requires-Dist: requests>=2.26
 Requires-Dist: requests-oauthlib>=0.8
+Requires-Dist: tenacity
 Requires-Dist: tqdm>=4.62.3
 Requires-Dist: myst-parser ; extra == "docs"
 Requires-Dist: sphinx ; extra == "docs"

{django_esi-7.0.1.dist-info → django_esi-8.0.0a2.dist-info}/RECORD

@@ -1,16 +1,24 @@
-esi/__init__.py,sha256=bGozFstfV7mCOH_OlhaeM255CAmXhs_byhCy_hBj58Y,167
-esi/admin.py,sha256=glkzGf8Z76mEd6BGpsMC0B5LLH5--MWlfOCEkSBL7mI,1110
-esi/app_settings.py,sha256=O8TkKonK2zdF7RjMem1vMhEMulAtjvksxKgchrI8jME,3783
+esi/__init__.py,sha256=x_GMW2iG9w-jeVStEapSJo_3MzGJm8XDnCJ6cTscRq4,199
+esi/admin.py,sha256=9i68WwW_gR0zsGhJKTWK2yMEi44EkhpAaOW0LDpVfM8,1176
+esi/app_settings.py,sha256=2Jp_1myzKCL8A20RYvwQnQd04Ds_CBGsCqwDtsrYf0M,4289
 esi/apps.py,sha256=HIu1niTkOXYmCzMVAjYcaFhHrrXeBbHvui6I44OCHXw,280
-esi/checks.py,sha256=Aa3qiEK86w-dhJ4_OfepUxxxjiySMdR-e2fFKGYA9ss,1912
-esi/clients.py,sha256=hQ8LMfqMh5DnwomatIzCWaDeDOP76-9M6glFLZbNrDE,23529
-esi/decorators.py,sha256=HEaOHv-stiyU-AL4nv24kRNzUbN5TMvT282WA6ZC8pY,8128
+esi/checks.py,sha256=31puQdsrpRUJB-kedp2k7Evo0x2knTWQPZsCUUrJ3dY,1912
+esi/clients.py,sha256=WB5YseJnfZdTeJ9C1Eze-iWXEqIpo5i_8uiQ6w0VkCw,23503
+esi/decorators.py,sha256=2RmPdkrIAwbxOV5Ls8-RIWd_VhmXEDzIG6g5-bs6WZc,9093
 esi/errors.py,sha256=KfFtgX8Mys4uMoQtco0n_pQeaM83yVrRSyW6StXuUjo,308
-esi/managers.py,sha256=0g3J2jgoX-BviisjDEEAypkTayVBY-G2I_ZuskTDUqg,11350
-esi/models.py,sha256=bc8DtvX4cTgLK92O-mgNGXtHIyT_TbH3eefVDGoS8O8,11507
-esi/tasks.py,sha256=AdX30ADt1OK6alTmVW014aDlDs7GEkTYGpQdx2cYQBY,2659
-esi/urls.py,sha256=23dY6ciekJ5wfwzo5LzLp0LFvWudrEAGICpDrscTeD8,152
-esi/views.py,sha256=ytfCILjz1rzITGgAGPyCY9bkFpE3KUfnii2UpHu6Bmc,3916
+esi/exceptions.py,sha256=Zf2cPFFbIYL90sYVtGeZXmna2n_3VyLdVApa5BRUvKc,747
+esi/helpers.py,sha256=-lYojtcWYWtlC_olSItWR3O3zJpjMYTQpNvsax81us8,672
+esi/managers.py,sha256=zdri1aSJrSX9W_kwzbXq44CAAhdufikoOViaJntA41A,11443
+esi/managers.pyi,sha256=BxRNX2yOT3domdrxsuGp4G0TrP_bWmf8VVwvM03eHQE,1977
+esi/models.py,sha256=v33dvnWoiDwhcwc5Y4CvNOtAJocNd2qh5JtyNTtu-P8,11483
+esi/openapi_clients.py,sha256=l7XVB9cXiW04aG18Knb_gsCmQP20TghpyDPuyjUzr1Y,34385
+esi/rate_limiting.py,sha256=fUzso1YCHlBes8SVrEAsP58eRWcFNuO2XEkW6RQLhUE,2600
+esi/stubs.py,sha256=UakysEAq5V454oKbxyEUewncr5sCFZCgwHFh0SJvU3Y,30
+esi/stubs.pyi,sha256=wT1aqp4eATKrReFupxmTz4wpvHNBQ0TpCJ-_zf2TjJg,231643
+esi/tasks.py,sha256=TaE_Q03oLk1ohkPw8KknXpIK-nY47C-oaGUUu4nr8pw,2658
+esi/urls.py,sha256=B4EnmT-MZzs4F8a9ORK1ejAHbpGRN_V4TKks8ww3JGE,151
+esi/views.py,sha256=cq2JkqSAwx-Nqi3amRUA9CKLu3ZLQYHSAH8c8g7xIQ4,3917
+esi/aiopenapi3/plugins.py,sha256=hHvWA_Sil5VTR1KLyF8dPSppx4g-daY9cj0kUSUZKxc,3914
 esi/locale/de/LC_MESSAGES/django.mo,sha256=9_Fc_R8oZpT_CojH8gBxdSqj2K84EMEMn4wkvmOr7Dg,820
 esi/locale/de/LC_MESSAGES/django.po,sha256=2NQVGYzLroHPPrWgmACSnb2d3nwlkMBLxA1uWU3K0FA,1503
 esi/locale/en/LC_MESSAGES/django.mo,sha256=N1pb17IfLd0ASiKO8d68-B4ygSpDkhKOCs8YTzMXQo0,380
@@ -30,6 +38,7 @@ esi/locale/ru/LC_MESSAGES/django.po,sha256=_pMs3mMOGMiHGpk27p8ykllpGnw20l5sSDg-N
 esi/locale/zh_Hans/LC_MESSAGES/django.mo,sha256=hPSO7wlU9cN8f32Qo1Dztq6AHUm2hZfL1hHIDW1R1F4,681
 esi/locale/zh_Hans/LC_MESSAGES/django.po,sha256=fZhif8jOUvY22xurl7eBYsHNKoqf7obtkW5L3894hk4,1451
 esi/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+esi/management/commands/generate_esi_stubs.py,sha256=MlsLe_otphvkRDXs-MwbNLfvIhESKD9tOJxMdqvGunc,10579
 esi/management/commands/migrate_to_ssov2.py,sha256=x9W4xaefrNoG_dNscHIWrWTRk4SuVGIW0s44q2QBN9k,6427
 esi/migrations/0001_initial.py,sha256=ItZOyyCRyfyxUhxCG1P08oylCY355gqOKGF3cJTQmcM,3396
 esi/migrations/0002_scopes_20161208.py,sha256=AG3qVAoEXh8WTgxuvS1pgG8LxLGMzpqr-jqtMjy3qC0,2846
@@ -57,7 +66,7 @@ esi/tests/client_authed_pilot.py,sha256=GN0J59TcscHM9HZH6OaPODM9Zel3mvObjJ4Dmmzc
 esi/tests/client_public_pilot.py,sha256=u6P-qbdYSvQ6A_MJqt8Jrkswt-u-FlvYDKtCvA5-PMo,1252
 esi/tests/factories.py,sha256=2pjkSYKDfO50bzX1nNcUHz_FAAJs7k07u7R8om6AlP0,1375
 esi/tests/factories_2.py,sha256=25NqVe9zzHkl4U1EN3R7pjdN2ahIBXxrrJhQzZhvw58,1972
-esi/tests/jwt_factory.py,sha256=1Ilg99V7Nc_jtUFrYVNm6GfnJ2f5ev0vhpnDhRur8zo,4944
+esi/tests/jwt_factory.py,sha256=0Jj9TjEv18h2XVsRpYc7BWHr3CPtQJgfKeB-9mdHevk,4919
 esi/tests/test_checks.py,sha256=ntq2ijuJ-6pxGruNh21rM4GlXDLVm-o3sy8DrFbjwEM,1846
 esi/tests/test_clients.py,sha256=1JWTBV83nZbt82e37DAnJ7h4gm9m_xU1ZDvEjt0sHsc,41363
 esi/tests/test_decorators.py,sha256=I5MhcLKhN5xD4PxgEQqOWQ2kiXquDqQIEve9dbTOsho,15069
@@ -70,7 +79,7 @@ esi/tests/test_tasks.py,sha256=nIvfXax_8nQCxNQeT-4TJ84i0__t1qWe155z5rnsktQ,4399
 esi/tests/test_templatetags.py,sha256=b68JWE3HvOlr2aUisJHsTsDS4e7IMjDeqTuzMqC7Re4,517
 esi/tests/test_views.py,sha256=Kj_f2yIpmPG0kx-lAX_sfkaHlIpgbkm02ieA1V3o-k4,13073
 esi/tests/threading_pilot.py,sha256=ax_dEdnTNibA-UQHqbZle_2dh_3jcHKRyrYSOKuE_6U,1931
-django_esi-7.0.1.dist-info/licenses/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
-django_esi-7.0.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_esi-7.0.1.dist-info/METADATA,sha256=LlxPclW944wcUkCEkX0XU90sqIc8Qjlk8d5r9XTLn8M,4745
-django_esi-7.0.1.dist-info/RECORD,,
+django_esi-8.0.0a2.dist-info/licenses/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
+django_esi-8.0.0a2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_esi-8.0.0a2.dist-info/METADATA,sha256=nYKhXDNlrzlcplbMUL_eWoZcHQZ3B-oT4S1pgs8elAM,4738
+django_esi-8.0.0a2.dist-info/RECORD,,

esi/__init__.py

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

esi/admin.py

@@ -1,7 +1,8 @@
 from django.contrib import admin
 from django.contrib.auth import get_user_model
+from django.db.models import QuerySet
 
-from .models import Token, Scope, CallbackRedirect
+from .models import CallbackRedirect, Scope, Token
 
 admin.site.register(CallbackRedirect)
 
@@ -13,14 +14,14 @@ class ScopeAdmin(admin.ModelAdmin):
 
 @admin.register(Token)
 class TokenAdmin(admin.ModelAdmin):
-    def get_queryset(self, request):
+    def get_queryset(self, request) -> QuerySet["Token"]:
         qs = super().get_queryset(request)
         return qs.select_related('user').prefetch_related('scopes')
 
     @admin.display(
         description='Scopes'
     )
-    def get_scopes(self, obj):
+    def get_scopes(self, obj) -> str:
         return ", ".join([x.name for x in obj.scopes.all()])
 
     User = get_user_model()

esi/aiopenapi3/plugins.py

@@ -0,0 +1,96 @@
+from aiopenapi3.plugin import Document
+
+
+class Trim204ContentType(Document):
+    """
+    Removes and content-type from responses on a 204 reponses
+    A 204 never has content...
+    """
+    def parsed(self, ctx: Document.Context) -> Document.Context:
+        spec = ctx.document
+        # Patch all paths
+        for path_item in spec.get("paths", {}).values():
+            for method_name in ("get", "post", "put", "delete", "patch", "options", "head"):
+                method = path_item.get(method_name)
+                if not method:
+                    continue
+                if "204" in method['responses']:
+                    method['responses']["204"].pop("content", [])
+        return ctx
+
+
+class RemoveSecurityParameter(Document):
+    """
+    Removes the whole OAuth2 securityScheme
+    """
+    def parsed(self, ctx: Document.Context) -> Document.Context:
+        print("RemoveSecurityParameterPlugin: Removing OAuth2 securityScheme")
+        spec = ctx.document
+        oauth2 = spec.get("components", {}).get("securitySchemes", {}).pop("OAuth2", None)
+        # Patch all paths
+        for path_item in spec.get("paths", {}).values():
+            for method_name in ("get", "post", "put", "delete", "patch", "options", "head"):
+                method = path_item.get(method_name)
+                if not method:
+                    continue
+                method.pop("security", None)
+
+        return ctx
+
+
+class TrimSecurityParameter(Document):
+    """TrimSecurityParameter
+    Trims out of Spec OAuth2 attributes. CCP have fixed this.
+    Leaving in place in case we need a quick reference again.
+    """
+    def parsed(self, ctx: Document.Context) -> Document.Context:
+        print("TrimSecurityParameter: Trimming out of spec attributes")
+        spec = ctx.document
+        oauth2 = spec.get("components", {}).get("securitySchemes", {}).get("OAuth2")
+        if oauth2 and oauth2.get("type") == "oauth2":
+            oauth2.pop("in", None)
+            oauth2.pop("name", None)
+        return ctx
+
+
+class PatchCompatibilityDatePlugin(Document):
+    """
+    Makes the X-Compatibility-Date header optional
+
+    This is because WE specifically add it in the library to the HTTP requests,
+    but without this, it will be a required parameter during request generation before it hits the HTTP library.
+    """
+    def parsed(self, ctx: Document.Context) -> Document.Context:
+        print("PatchCompatibilityDatePlugin: making compatibility date optional")
+        spec = ctx.document
+
+        def patch_param(param):
+            # Follow $ref if present
+            if "$ref" in param:
+                ref = param["$ref"]
+                parts = ref.split("/")
+                if parts[1] == "components" and parts[2] == "parameters":
+                    param_name = parts[-1]
+                    comp_param = spec.get("components", {}).get("parameters", {}).get(param_name)
+                    if comp_param and comp_param.get("name") == "X-Compatibility-Date":
+                        comp_param["required"] = False
+            else:
+                # Inline parameter
+                if (param.get("name") == "X-Compatibility-Date" and param.get("in") == "header"):
+                    param["required"] = False
+
+        # Patch all paths
+        for path_item in spec.get("paths", {}).values():
+            for method_name in ("get", "post", "put", "delete", "patch", "options", "head"):
+                method = path_item.get(method_name)
+                if not method:
+                    continue
+                for param in method.get("parameters", []):
+                    patch_param(param)
+
+        # Patch global parameters in components
+        for param_name, param in spec.get("components", {}).get("parameters", {}).items():
+            if param.get("name") == "X-Compatibility-Date" and param.get("in") == "header":
+                param["required"] = False
+
+        return ctx

esi/app_settings.py

@@ -66,8 +66,21 @@ ESI_REQUESTS_CONNECT_TIMEOUT = getattr(settings, 'ESI_REQUESTS_CONNECT_TIMEOUT',
 Can temporarily overwritten with by passing ``timeout`` with ``result()``
 """
 
-ESI_REQUESTS_READ_TIMEOUT = getattr(settings, 'ESI_REQUESTS_READ_TIMEOUT', 30)
+ESI_REQUESTS_READ_TIMEOUT = getattr(settings, 'ESI_REQUESTS_READ_TIMEOUT', 10)
 """Default read timeouts for all requests to ESI.
+This should be a maximum of 10s as ESI cuts all requests to the monolith off @ 10s.
+
+Can temporarily overwritten with by passing ``timeout`` with ``result()``
+"""
+
+ESI_REQUESTS_WRITE_TIMEOUT = getattr(settings, 'ESI_REQUESTS_WRITE_TIMEOUT', 5)
+"""Default write timeouts for all requests to ESI.
+
+Can temporarily overwritten with by passing ``timeout`` with ``result()``
+"""
+
+ESI_REQUESTS_POOL_TIMEOUT = getattr(settings, 'ESI_REQUESTS_POOL_TIMEOUT', 5)
+"""Default pool timeouts for all requests to ESI.
 
 Can temporarily overwritten with by passing ``timeout`` with ``result()``
 """
@@ -95,5 +108,5 @@ ESI_TOKEN_JWT_AUDIENCE = str(getattr(settings, "ESI_TOKEN_JWT_AUDIENCE", "EVE On
 
 # list of all official language codes supported by ESI
 ESI_LANGUAGES = getattr(settings, 'ESI_LANGUAGES', [
-    'de', 'en-us', 'fr', 'ja', 'ru', 'zh', 'ko'
+    'en', 'de', 'fr', 'ja', 'ru', 'zh', 'ko', 'es'
 ])

esi/checks.py

@@ -1,5 +1,5 @@
-from django.core.checks import Error, Warning, register, Tags
 from django.conf import settings
+from django.core.checks import Error, Tags, Warning, register
 
 
 @register(Tags.security)

esi/clients.py

@@ -1,28 +1,27 @@
-from datetime import datetime
-from hashlib import md5
 import json
 import logging
+import warnings
+from datetime import datetime
+from hashlib import md5
 from time import sleep
+from typing import Any
 from urllib import parse as urlparse
-from typing import Any, Union, Tuple
-import warnings
 
-from bravado.client import SwaggerClient
 from bravado import requests_client
+from bravado.client import SwaggerClient
 from bravado.exception import (
-    HTTPBadGateway, HTTPGatewayTimeout, HTTPServiceUnavailable
+    HTTPBadGateway, HTTPGatewayTimeout, HTTPServiceUnavailable,
 )
-from bravado_core.response import IncomingResponse
-from bravado.swagger_model import Loader
 from bravado.http_future import HttpFuture
-from bravado_core.spec import Spec, CONFIG_DEFAULTS
+from bravado.swagger_model import Loader
+from bravado_core.response import IncomingResponse
+from bravado_core.spec import CONFIG_DEFAULTS, Spec
 from requests.adapters import HTTPAdapter
 
 from django.core.cache import cache
 
+from . import __title__, __url__, __version__, app_settings
 from .errors import TokenExpiredError
-from . import app_settings, __version__, __title__, __url__
-
 
 logger = logging.getLogger(__name__)
 
@@ -75,7 +74,7 @@ class CachingHttpFuture(HttpFuture):
         except ValueError:
             return 0
 
-    def results(self, **kwargs) -> Union[Any, Tuple[Any, IncomingResponse]]:
+    def results(self, **kwargs) -> Any | tuple[Any, IncomingResponse]:
         """Executes the request and returns the response from ESI for the current
         route. Response will include all pages if there are more available.
 
@@ -143,7 +142,7 @@ class CachingHttpFuture(HttpFuture):
             for language in my_languages
         }
 
-    def result(self, **kwargs) -> Union[Any, Tuple[Any, IncomingResponse]]:
+    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.
 
@@ -222,7 +221,7 @@ class CachingHttpFuture(HttpFuture):
 
         return super().result(**kwargs)
 
-    def _result_with_retries(self, **kwargs) -> Tuple[Any, IncomingResponse]:
+    def _result_with_retries(self, **kwargs) -> tuple[Any, IncomingResponse]:
         """Execute request and retry on certain HTTP errors.
 
         ``kwargs`` are passed through to super().result()

esi/decorators.py

@@ -1,14 +1,18 @@
+import functools
 import logging
+import time
 from functools import wraps
-from typing import Union
 
-from .models import Token, CallbackRedirect
+from django.core.cache import cache
 
+from esi.rate_limiting import ESIRateLimitBucket, ESIRateLimits
+
+from .models import CallbackRedirect, Token
 
 logger = logging.getLogger(__name__)
 
 
-def _check_callback(request) -> Union[Token, None]:
+def _check_callback(request) -> Token | None:
     # ensure session installed in database
     if not request.session.exists(request.session.session_key):
         logger.debug("Creating new session for %s", request.user)
@@ -221,3 +225,31 @@ def single_use_token(scopes='', new=False):
         return _wrapped_view
 
     return decorator
+
+
+def wait_for_esi_errorlimit_reset(cache_key="esi_error_limit_reset", poll_interval=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...")
+                while cache.get(cache_key):
+                    time.sleep(poll_interval)
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator
+
+
+def esi_rate_limiter_bucketed(
+    bucket: ESIRateLimitBucket,
+    raise_on_limit: bool = True,
+):
+    # TODO Investigate esi cache hits.
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            ESIRateLimits.check_bucket(bucket, raise_on_limit)
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator

esi/exceptions.py

@@ -0,0 +1,18 @@
+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 (
+            f"ESI Error limited. Reset in {reset} seconds." if reset else "ESI Error limited."
+        )
+        super().__init__(msg, *args)
+
+
+class ESIBucketLimitException(Exception):
+    """Endpoint (Bucket) Specific Rate Limit Exceeded"""
+    def __init__(self, bucket, *args, **kwargs) -> None:
+        self.bucket = bucket
+        msg = kwargs.get("message") or f"ESI bucket limit reached for {bucket}."
+        super().__init__(msg, *args)

esi/helpers.py

@@ -0,0 +1,25 @@
+from esi.models import Token
+
+
+def get_token(character_id: int, scopes: list) -> Token:
+    """Helper method to get a valid token for a specific character with specific scopes.
+
+    Args:
+        character_id: Character to filter on.
+        scopes: array of ESI scope strings to search for.
+
+    Returns:
+        Matching Token
+    """
+    qs = (
+        Token.objects
+        .filter(character_id=character_id)
+        .require_scopes(scopes)
+        .require_valid()
+    )
+    token = qs.first()
+    if token is None:
+        raise Token.DoesNotExist(
+            f"No valid token found for character_id={character_id} with required scopes."
+        )
+    return token