django-esi 8.0.0a2__tar.gz → 8.0.0a3__tar.gz

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-esi
-Version: 8.0.0a2
+Version: 8.0.0a3
 Summary: Django app for accessing the EVE Swagger Interface (ESI).
 Keywords: eveonline
 Author-email: Alliance Auth <adarnof@gmail.com>

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/__init__.py

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

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/aiopenapi3/plugins.py

@@ -19,6 +19,27 @@ class Trim204ContentType(Document):
         return ctx
 
 
+class Add304ContentType(Document):
+    """
+    Adds 304 content-type to responses
+    A 304 never has content. ESI defualt has application/json
+    This is a hack for now
+    """
+    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 "304" not in method['responses']:
+                    method['responses']["304"]={
+                        "description": "Not Modified"
+                    }
+        return ctx
+
+
 class RemoveSecurityParameter(Document):
     """
     Removes the whole OAuth2 securityScheme

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/exceptions.py

@@ -1,3 +1,9 @@
+import dataclasses
+
+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
@@ -16,3 +22,26 @@ class ESIBucketLimitException(Exception):
         self.bucket = bucket
         msg = kwargs.get("message") or f"ESI bucket limit reached for {bucket}."
         super().__init__(msg, *args)
+
+
+@dataclasses.dataclass(repr=False)
+class HTTPNotModified(HTTPError):
+    """The HTTP Status is 304"""
+
+    status_code: int
+    headers: dict[str, str]
+
+    def __str__(self):
+        return f"""<{self.__class__.__name__} {self.status_code} {self.headers}>"""
+
+
+@dataclasses.dataclass(repr=False)
+class HTTPClientError(base_HTTPClientError):
+    """response code 4xx"""
+    pass
+
+
+@dataclasses.dataclass(repr=False)
+class HTTPServerError(base_HTTPServerError):
+    """response code 5xx"""
+    pass

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/locale/en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-06-30 10:57+1000\n"
+"POT-Creation-Date: 2025-09-04 13:41+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"
@@ -18,11 +18,11 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-#: esi/models.py:73
+#: esi/models.py:66
 msgid "Character"
 msgstr ""
 
-#: esi/models.py:74
+#: esi/models.py:67
 msgid "Corporation"
 msgstr ""
 

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/locale/ru/LC_MESSAGES/django.po

@@ -5,15 +5,16 @@
 # 
 # Translators:
 # Filipp Chertiev <f@fzfx.ru>, 2023
+# Gnevich <and.vareba81@gmail.com>, 2025
 # 
 #, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-10-08 23:42+1000\n"
+"POT-Creation-Date: 2025-06-30 10:57+1000\n"
 "PO-Revision-Date: 2023-10-25 11:04+0000\n"
-"Last-Translator: Filipp Chertiev <f@fzfx.ru>, 2023\n"
+"Last-Translator: Gnevich <and.vareba81@gmail.com>, 2025\n"
 "Language-Team: Russian (https://app.transifex.com/alliance-auth/teams/107430/ru/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -21,13 +22,13 @@ msgstr ""
 "Language: ru\n"
 "Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || (n%100>=11 && n%100<=14)? 2 : 3);\n"
 
-#: esi/models.py:72
+#: esi/models.py:73
 msgid "Character"
-msgstr ""
+msgstr "Персонаж"
 
-#: esi/models.py:73
+#: esi/models.py:74
 msgid "Corporation"
-msgstr ""
+msgstr "Корпорация"
 
 #: esi/templates/esi/select_token.html:13
 msgid "ESI Token Selection"
@@ -49,7 +50,7 @@ msgstr "Новый персонаж"
 #: esi/templates/esi/select_token.html:71
 #: esi/templates/esi/select_token.html:107
 msgid "Add Token"
-msgstr ""
+msgstr "Добавить токен"
 
 #: esi/templates/esi/select_token.html:88
 #: esi/templates/esi/select_token.html:89

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/openapi_clients.py

@@ -1,11 +1,13 @@
 import logging
 import warnings
-from datetime import datetime
+from datetime import datetime, date
 from hashlib import md5
 from typing import Any
 
 from aiopenapi3 import OpenAPI
 from aiopenapi3._types import ResponseDataType, ResponseHeadersType
+from aiopenapi3.errors import HTTPServerError as base_HTTPServerError
+from aiopenapi3.errors import HTTPClientError as base_HTTPClientError
 from aiopenapi3.request import OperationIndex, RequestBase
 from httpx import (
     AsyncClient, Client, HTTPStatusError, RequestError, Response, Timeout,
@@ -18,7 +20,8 @@ from tenacity import (
 from django.core.cache import cache
 
 from esi import app_settings
-from esi.aiopenapi3.plugins import PatchCompatibilityDatePlugin, Trim204ContentType
+from esi.exceptions import HTTPClientError, HTTPServerError, HTTPNotModified
+from esi.aiopenapi3.plugins import Add304ContentType, PatchCompatibilityDatePlugin, Trim204ContentType
 from esi.exceptions import ESIErrorLimitException
 from esi.models import Token
 from esi.stubs import ESIClientStub
@@ -121,14 +124,14 @@ def _load_aiopenapi_client_sync(
             path=spec_file,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType(), Add304ContentType()]
         )
     else:
         return OpenAPI.load_sync(
             url=spec_url,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType(), Add304ContentType()]
         )
 
 
@@ -176,14 +179,14 @@ async def _load_aiopenapi_client_async(
             path=spec_file,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType(), Add304ContentType()]
         )
     else:
         return await OpenAPI.load_async(
             url=spec_url,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType(), Add304ContentType()]
         )
 
 
@@ -322,7 +325,12 @@ class BaseEsiOperation():
         Returns:
             str: Key name
         """
-        data = (self.method + self.url + str(self._args) + str(self._kwargs)).encode('utf-8')
+        # ignore the token this will break the cache
+        ignore_keys = [
+            "token",
+        ]
+        _kwargs = { key:value for key, value in self._kwargs.items() if key not in ignore_keys }
+        data = (self.method + self.url + str(self._args) + str(_kwargs)).encode('utf-8')
         str_hash = md5(data).hexdigest()  # nosec B303
         return f'esi_{str_hash}'
 
@@ -360,7 +368,7 @@ class BaseEsiOperation():
         """
         return any(p.name == "before" or p.name == "after" for p in self.operation.parameters)
 
-    def _get_cache(self, cache_key: str) -> tuple[ResponseHeadersType | None, Any, Response | None]:
+    def _get_cache(self, cache_key: str, etag: str) -> tuple[ResponseHeadersType | None, Any, Response | None]:
         """Retrieve cached response and validate expiry
         Args:
             cache_key (str): The cache key to retrieve
@@ -376,12 +384,23 @@ class BaseEsiOperation():
 
         if cached_response:
             logger.debug(f"Cache Hit {self.url}")
-            headers, data = self.parse_cached_request(cached_response)
+            expiry = _time_to_expiry(str(cached_response.headers.get('Expires')))
 
-            expiry = _time_to_expiry(str(headers.get('Expires')))
+            # force check to ensure cache isn't expired
             if expiry < 0:
                 logger.warning("Cache expired by %d seconds, forcing expiry", expiry)
                 return None, None, None
+
+            # check if etag is same before building models from cache
+            if etag:
+                if cached_response.headers.get('Expires') == etag:
+                    raise HTTPNotModified(
+                        status_code=304,
+                        headers=cached_response.headers
+                    )
+
+            # build models
+            headers, data = self.parse_cached_request(cached_response)
             return headers, data, cached_response
 
         return None, None, None
@@ -485,7 +504,7 @@ class EsiOperation(BaseEsiOperation):
         if not etag and app_settings.ESI_CACHE_RESPONSE:
             etag = cache.get(etag_key)
 
-        headers, data, response = self._get_cache(cache_key)
+        headers, data, response = self._get_cache(cache_key, etag=etag) if use_cache else (None, None, None)
 
         if response and use_cache:
             expiry = _time_to_expiry(str(headers.get('Expires')))
@@ -499,17 +518,41 @@ class EsiOperation(BaseEsiOperation):
 
         if not response:
             logger.debug(f"Cache Miss {self.url}")
-            headers, data, response = self._make_request(parameters, etag)
-            if response.status_code == 420:
-                reset = response.headers.get("X-RateLimit-Reset", None)
-                cache.set("esi_error_limit_reset", reset, timeout=reset)
-                raise ESIErrorLimitException(reset=reset)
-            # if response.status_code == 304 and app_settings.ESI_CACHE_RESPONSE:
-            #     cached = cache.get(cache_key)
-            #     if cached:
-            #         return (cached, response) if return_response else cached
-            # we dont want to do this, if we do this we have to store data longer than ttl. rip ram
-            self._store_cache(cache_key, response)
+            try:
+                headers, data, response = self._make_request(parameters, etag)
+                if response.status_code == 420:
+                    reset = response.headers.get("X-RateLimit-Reset", None)
+                    cache.set("esi_error_limit_reset", reset, timeout=reset)
+                    raise ESIErrorLimitException(reset=reset)
+                self._store_cache(cache_key, response)
+
+                # if response.status_code == 304 and app_settings.ESI_CACHE_RESPONSE:
+                #     cached = cache.get(cache_key)
+                #     if cached:
+                #         return (cached, response) if return_response else cached
+                # we dont want to do this, if we do this we have to store data longer than ttl. rip ram
+
+            # Shim our exceptions into Django-ESI
+            except base_HTTPServerError as e:
+                raise HTTPServerError(
+                    status_code=e.status_code,
+                    headers=e.headers,
+                    data=e.data
+                )
+
+            except base_HTTPClientError as e:
+                raise HTTPClientError(
+                    status_code=e.status_code,
+                    headers=e.headers,
+                    data=e.data
+                )
+
+            # Throw a 304 exception for catching.
+            if response.status_code == 304:
+                raise HTTPNotModified(
+                    status_code=304,
+                    headers=response.headers
+                )
 
         return (data, response) if return_response else data
 
@@ -590,7 +633,7 @@ class EsiOperation(BaseEsiOperation):
                 my_languages.append(lang)
 
         return {
-            language: self.results(language=language, **kwargs)
+            language: self.results(accept_language=language, **kwargs)
             for language in my_languages
         }
 
@@ -732,7 +775,7 @@ class EsiOperationAsync(BaseEsiOperation):
                 my_languages.append(lang)
 
         return {
-            language: self.results(language=language, **extra)
+            language: self.results(accept_language=language, **kwargs)
             for language in my_languages
         }
 
@@ -804,7 +847,11 @@ class ESIClient(ESIClientStub):
         if tag == "_":
             return self.api._operationindex
 
-        elif tag in set(self.api._operationindex._tags.keys()):
+        # convert pythonic Planetary_Interaction to Planetary Interaction
+        if "_" in tag:
+            tag = tag.replace("_", " ")
+
+        if tag in set(self.api._operationindex._tags.keys()):
             return ESITag(self.api._operationindex._tags[tag], self.api)
 
         raise AttributeError(
@@ -827,7 +874,11 @@ class ESIClientAsync(ESIClientStub):
         if tag == "_":
             return self.api._operationindex
 
-        elif tag in set(self.api._operationindex._tags.keys()):
+        # convert pythonic Planetary_Interaction to Planetary Interaction
+        if "_" in tag:
+            tag = tag.replace("_", " ")
+
+        if tag in set(self.api._operationindex._tags.keys()):
             return ESITagAsync(self.api._operationindex._tags[tag], self.api)
 
         raise AttributeError(
@@ -839,7 +890,7 @@ class ESIClientAsync(ESIClientStub):
 class ESIClientProvider:
     """Class for providing a single ESI client instance for a whole app
     Args:
-        compatibility_date (str): The compatibility date for the ESI client.
+        compatibility_date (str | date): The compatibility date for the ESI client.
         ua_appname (str): Name of the App for generating a User-Agent,
         ua_version (str): Version of the App for generating a User-Agent,
         ua_url (str, Optional): URL To the Source Code or Documentation for generating a User-Agent,
@@ -855,7 +906,7 @@ class ESIClientProvider:
 
     def __init__(
         self,
-        compatibility_date: str,
+        compatibility_date: str | date,
         ua_appname: str,
         ua_version: str,
         ua_url: str | None = None,
@@ -863,7 +914,10 @@ class ESIClientProvider:
         tenant: str = "tranquility",
         **kwargs
     ) -> None:
-        self._compatibility_date = compatibility_date
+        if type(compatibility_date) is date:
+            self._compatibility_date = self._date_to_string(compatibility_date)
+        else:
+            self._compatibility_date = compatibility_date
         self._ua_appname = ua_appname
         self._ua_version = ua_version
         self._ua_url = ua_url
@@ -899,5 +953,11 @@ class ESIClientProvider:
             self._client_async = ESIClientAsync(api)
         return self._client_async
 
+    @classmethod
+    def _date_to_string(cls, compatibility_date: date) -> str:
+        """Turns a date object in a compatibility_date string"""
+        return f"{compatibility_date.year}-{compatibility_date.month:02}-{compatibility_date.day:02}"
+
+
     def __str__(self) -> str:
         return "ESIClientProvider"

{django_esi-8.0.0a2 → django_esi-8.0.0a3}/esi/stubs.pyi

@@ -2010,6 +2010,36 @@ class GetMarketsStructuresStructureIdOperation(EsiOperation):
         ...
 
 
+class GetMetaChangelogOperation(EsiOperation):
+    """EsiOperation, use result(), results() or results_localized()"""
+    def result(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> dict[str, Any]:
+        """Get the changelog of this API."""
+        ...
+
+    def results(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> list[dict[str, Any]]:
+        """Get the changelog of this API."""
+        ...
+
+    def results_localized(self, languages: list[str] | str | None = None, **extra) -> dict[str, list[dict[str, Any]]]:
+        """Get the changelog of this API."""
+        ...
+
+
+class GetMetaCompatibilityDatesOperation(EsiOperation):
+    """EsiOperation, use result(), results() or results_localized()"""
+    def result(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> dict[str, Any]:
+        """Get a list of compatibility dates."""
+        ...
+
+    def results(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> list[dict[str, Any]]:
+        """Get a list of compatibility dates."""
+        ...
+
+    def results_localized(self, languages: list[str] | str | None = None, **extra) -> dict[str, list[dict[str, Any]]]:
+        """Get a list of compatibility dates."""
+        ...
+
+
 class GetCharactersCharacterIdPlanetsOperation(EsiOperation):
     """EsiOperation, use result(), results() or results_localized()"""
     def result(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> list[dict[str, Any]]:
@@ -3518,6 +3548,18 @@ class ESIClientStub:
 
     Market: _Market = _Market()
 
+    class _Meta:
+        def GetMetaChangelog(self, Accept_Language: str | None = ..., If_None_Match: str | None = ..., X_Compatibility_Date: str | None = ..., X_Tenant: str | None = ..., **kwargs: Any) -> GetMetaChangelogOperation:
+            """Get the changelog of this API."""
+            ...
+
+        def GetMetaCompatibilityDates(self, Accept_Language: str | None = ..., If_None_Match: str | None = ..., X_Compatibility_Date: str | None = ..., X_Tenant: str | None = ..., **kwargs: Any) -> GetMetaCompatibilityDatesOperation:
+            """Get a list of compatibility dates."""
+            ...
+
+
+    Meta: _Meta = _Meta()
+
     class _Planetary_Interaction:
         def GetCharactersCharacterIdPlanets(self, character_id: int, token: Token, Accept_Language: str | None = ..., If_None_Match: str | None = ..., X_Compatibility_Date: str | None = ..., X_Tenant: str | None = ..., **kwargs: Any) -> GetCharactersCharacterIdPlanetsOperation:
             """Returns a list of all planetary colonies owned by a character."""

django_esi-8.0.0a3/esi/tests/test_openapi.py

@@ -0,0 +1,14 @@
+from django.test import TestCase
+from datetime import date
+
+from esi.openapi_clients import ESIClientProvider
+
+
+class TestOpenapiClientProvider(TestCase):
+
+    def test_compatibilitydate_date_to_string(self):
+        testdate_1 = date(2024, 1, 1)
+        testdate_2 = date(2025, 8, 26)
+
+        self.assertEqual("2024-01-01", ESIClientProvider._date_to_string(testdate_1))
+        self.assertEqual("2025-08-26", ESIClientProvider._date_to_string(testdate_2))