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

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

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: django-esi
-Version: 8.0.0a1
+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

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

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

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

@@ -1,6 +1,24 @@
 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

{django_esi-8.0.0a1 → django_esi-8.0.0a2}/esi/app_settings.py

@@ -108,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'
 ])

{django_esi-8.0.0a1 → django_esi-8.0.0a2}/esi/management/commands/generate_esi_stubs.py

@@ -102,7 +102,7 @@ class Command(BaseCommand):
             f.write("# flake8: noqa=E501\n")
             f.write("# Auto Generated do not edit\n")
             # Python Imports
-            f.write("from typing import Any, Optional\n\n")
+            f.write("from typing import Any\n\n")
             f.write("from esi.openapi_clients import EsiOperation\n")
             f.write("from esi.models import Token\n\n\n")
 
@@ -114,15 +114,25 @@ class Command(BaseCommand):
                 # result(), Results(), Results_Localized() etc. all live here
                 ops = stub_api._operationindex._tags[tag]
                 for nm, op in sorted(ops._operations.items()):
+                    op_type = op[0]
                     op_obj = op[2]
                     docstring = (op_obj.description or op_obj.summary or "").replace("\n", " ").strip()
                     op_class_name = sanitize_operation_class(nm)
 
                     response_type = "Any"
                     try:
-                        resp_200 = op_obj.responses.get("200")
-                        if resp_200 and "application/json" in resp_200.content:
-                            response_type = schema_to_type(resp_200.content["application/json"].schema_)
+                        match op_type:
+                            case "post":
+                                resp_201 = op_obj.responses.get("201")
+                                if resp_201 and "application/json" in resp_201.content:
+                                    response_type = schema_to_type(resp_201.content["application/json"].schema_)
+                            case "put" | "delete":
+                                response_type = "None"
+                            case _:
+                                resp_200 = op_obj.responses.get("200")
+                                if resp_200 and "application/json" in resp_200.content:
+                                    response_type = schema_to_type(resp_200.content["application/json"].schema_)
+
                     except Exception:
                         response_type = "Any"
 
@@ -130,22 +140,26 @@ class Command(BaseCommand):
 
                     if op_class_name not in operation_classes:
                         f.write(f"class {op_class_name}(EsiOperation):\n")
-                        f.write("    \"\"\"EsiOperation, use result(), results() or results_localized()\"\"\"\n")
+                        if response_type != "None":
+                            f.write("    \"\"\"EsiOperation, use result(), results() or results_localized()\"\"\"\n")
+                        else:
+                            f.write("    \"\"\"EsiOperation, use result()\"\"\"\n")
 
                         # result()
                         f.write(f"    def result(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> {response_type}:\n")  # noqa: E501
                         f.write(f"        \"\"\"{docstring}\"\"\"\n") if docstring else None
                         f.write("        ...\n\n")
-
-                        # results()
-                        f.write(f"    def results(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> {results_type}:\n")  # noqa: E501
-                        f.write(f"        \"\"\"{docstring}\"\"\"\n") if docstring else None
-                        f.write("        ...\n\n")
-
-                        # results_localized()
-                        f.write(f"    def results_localized(self, languages: str | list[str] = 'en', **kwargs) -> {results_type}:\n")
-                        f.write(f"        \"\"\"{docstring}\"\"\"\n") if docstring else None
-                        f.write("        ...\n\n\n")
+                        if response_type != "None":
+                            # We only need the extra utility functions if its actually an endpoint that returns data
+                            # results()
+                            f.write(f"    def results(self, etag: str | None = None, return_response: bool = False, use_cache: bool = True, **extra) -> {results_type}:\n")  # noqa: E501
+                            f.write(f"        \"\"\"{docstring}\"\"\"\n") if docstring else None
+                            f.write("        ...\n\n")
+
+                            # results_localized()
+                            f.write(f"    def results_localized(self, languages: list[str] | str | None = None, **extra) -> dict[str, {results_type}]:\n")
+                            f.write(f"        \"\"\"{docstring}\"\"\"\n") if docstring else None
+                            f.write("        ...\n\n\n")
 
                         operation_classes[op_class_name] = True
 
@@ -172,6 +186,9 @@ class Command(BaseCommand):
 
                     params = ["self"]
                     optional_params = []
+                    if getattr(op_obj, "requestBody", None):
+                        params.append(f"body: {schema_to_type(op_obj.requestBody.content['application/json'].schema_)}")
+
                     for p in getattr(op_obj, "parameters", []):
                         required = getattr(p, "required", False)
                         schema_type_value = getattr(getattr(p, "schema_", None), "type", None)
@@ -181,7 +198,7 @@ class Command(BaseCommand):
                             param_type = "Any"
                         default = ""
                         if not required:
-                            param_type = f"Optional[{param_type}]"
+                            param_type = f"{param_type} | None"
                             default = " = ..."
                         param_name = p.name.replace("-", "_")
                         if param_name == "authorization" and needs_oauth:

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

@@ -18,7 +18,7 @@ from tenacity import (
 from django.core.cache import cache
 
 from esi import app_settings
-from esi.aiopenapi3.plugins import PatchCompatibilityDatePlugin
+from esi.aiopenapi3.plugins import PatchCompatibilityDatePlugin, Trim204ContentType
 from esi.exceptions import ESIErrorLimitException
 from esi.models import Token
 from esi.stubs import ESIClientStub
@@ -121,14 +121,14 @@ def _load_aiopenapi_client_sync(
             path=spec_file,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
         )
     else:
         return OpenAPI.load_sync(
             url=spec_url,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
         )
 
 
@@ -176,14 +176,14 @@ async def _load_aiopenapi_client_async(
             path=spec_file,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
         )
     else:
         return await OpenAPI.load_async(
             url=spec_url,
             session_factory=session_factory,
             use_operation_tags=True,
-            plugins=[PatchCompatibilityDatePlugin()]
+            plugins=[PatchCompatibilityDatePlugin(), Trim204ContentType()]
         )
 
 
@@ -326,6 +326,16 @@ class BaseEsiOperation():
         str_hash = md5(data).hexdigest()  # nosec B303
         return f'esi_{str_hash}'
 
+    def _extract_body_param(self) -> Token | None:
+        """Pop the request body from parameters to be able to check the param validity
+        Returns:
+            Any | None: the request body
+        """
+        _body = self._kwargs.pop("body", None)
+        if _body and not getattr(self.operation, "requestBody", False):
+            raise ValueError("Request Body provided on endpoint with no request body paramater.")
+        return _body
+
     def _extract_token_param(self) -> Token | None:
         """Pop token from parameters or use the Client wide token if set
         Returns:
@@ -450,7 +460,7 @@ class EsiOperation(BaseEsiOperation):
                     req.req.headers["Authorization"] = f"Bearer {self.token.valid_access_token()}"
             if etag:
                 req.req.headers["If-None-Match"] = etag
-            return req.request(parameters=self._unnormalize_parameters(parameters))
+            return req.request(data=self.body, parameters=self._unnormalize_parameters(parameters))
         return retry(__func)
 
     def result(
@@ -467,6 +477,7 @@ class EsiOperation(BaseEsiOperation):
         """
 
         self.token = self._extract_token_param()
+        self.body = self._extract_body_param()
         parameters = self._kwargs | extra
         cache_key = self._cache_key()
         etag_key = f"{cache_key}_etag"
@@ -508,8 +519,8 @@ class EsiOperation(BaseEsiOperation):
             return_response: bool = False,
             use_cache: bool = True,
             **extra) -> tuple[list[Any], Response | Any | None] | list[Any]:
-        all_results = []
-        last_response = None
+        all_results: list[Any] = []
+        last_response: Response | None = None
         """Executes the request and returns the response from ESI for the current
         operation. Response will include all pages if there are more available.
 
@@ -557,10 +568,31 @@ class EsiOperation(BaseEsiOperation):
 
         return (all_results, last_response) if return_response else all_results
 
-    def results_localized(self, languages: str | list[str] = "en", **kwargs) -> list[Any]:
-        # We can either push Accept-Language up to the library level
-        # OR we insert the parameter into each request here
-        raise NotImplementedError()
+    def results_localized(
+            self,
+            languages: list[str] | str | None = None,
+            **kwargs) -> dict[str, list[Any]]:
+        """Executes the request and returns the response from ESI for all default languages and pages (if any).
+        Args:
+            languages: (list[str], str, optional) language(s) to return instead of default languages
+        Raises:
+            ValueError: Invalid or Not Supported Language Code ...
+        Returns:
+            dict[str, list[Any]]: Dict of all responses with the language code as keys.
+        """
+        if not languages:
+            my_languages = list(app_settings.ESI_LANGUAGES)
+        else:
+            my_languages = []
+            for lang in dict.fromkeys(languages):
+                if lang not in app_settings.ESI_LANGUAGES:
+                    raise ValueError('Invalid or Not Supported Language Code: %s' % lang)
+                my_languages.append(lang)
+
+        return {
+            language: self.results(language=language, **kwargs)
+            for language in my_languages
+        }
 
     def required_scopes(self) -> list[str]:
         """Return a simple list of scopes required for an endpoint. #Requires loading and processing a client
@@ -678,8 +710,31 @@ class EsiOperationAsync(BaseEsiOperation):
 
         return (all_results, last_response) if return_response else all_results
 
-    async def results_localized(self, languages: str | list[str] = "en", **kwargs) -> list[Any]:
-        raise NotImplementedError()
+    def results_localized(
+            self,
+            languages: list[str] | str | None = None,
+            **extra) -> dict[str, list[Any]]:
+        """Executes the request and returns the response from ESI for all default languages and pages (if any).
+        Args:
+            languages: (list[str], str, optional) language(s) to return instead of default languages
+        Raises:
+            ValueError: Invalid or Not Supported Language Code ...
+        Returns:
+            dict[str, list[Any]]: Dict of all responses with the language code as keys.
+        """
+        if not languages:
+            my_languages = list(app_settings.ESI_LANGUAGES)
+        else:
+            my_languages = []
+            for lang in dict.fromkeys(languages):
+                if lang not in app_settings.ESI_LANGUAGES:
+                    raise ValueError('Invalid or Not Supported Language Code: %s' % lang)
+                my_languages.append(lang)
+
+        return {
+            language: self.results(language=language, **extra)
+            for language in my_languages
+        }
 
     def required_scopes(self) -> list[str]:
         """Return a simple list of scopes required for an endpoint. #Requires loading and processing a client
@@ -795,6 +850,9 @@ class ESIClientProvider:
         client_async(): ESIClientAsync
     """
 
+    _client: ESIClient | None = None
+    _client_async: ESIClientAsync | None = None
+
     def __init__(
         self,
         compatibility_date: str,