aa-ledger 1.0.0__py3-none-any.whl → 1.0.0b2__py3-none-any.whl

ledger/managers/character_mining_manager.py

@@ -29,9 +29,6 @@ from ledger.decorators import log_timing
 from ledger.providers import esi
 
 if TYPE_CHECKING:
-    # Alliance Auth
-    from esi.stubs import CharactersCharacterIdMiningGetItem
-
     # AA Ledger
     from ledger.models.characteraudit import (
         CharacterAudit,
@@ -41,6 +38,15 @@ if TYPE_CHECKING:
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
+class MiningLedgerContext:
+    """Context for Character mining ledger ESI operations."""
+
+    date: timezone.datetime
+    quantity: int
+    solar_system_id: int
+    type_id: int
+
+
 def require_valid_price_percentage(func):
     def wrapper(*args, **kwargs):
         if not isinstance(LEDGER_PRICE_PERCENTAGE, (int, float)):
@@ -168,16 +174,17 @@ class CharacterMiningLedgerEntryManagerBase(models.Manager):
             token=token,
         )
 
-        mining_items = operation.results(force_refresh=force_refresh)
+        mining_items, response = operation.results(
+            return_response=True, force_refresh=force_refresh
+        )
+        logger.debug("ESI response Status: %s", response.status_code)
 
         # Process and update or create mining ledger entries
         self._update_or_create_objs(audit, mining_items)
 
     @transaction.atomic()
     def _update_or_create_objs(
-        self,
-        character: "CharacterAudit",
-        objs: list["CharactersCharacterIdMiningGetItem"],
+        self, character: "CharacterAudit", objs: list[MiningLedgerContext]
     ) -> None:
         """Update or Create mining ledger entries from objs data."""
         existings_pks = set(

ledger/managers/character_planetary_manager.py

@@ -21,10 +21,6 @@ from ledger.models.characteraudit import CharacterAudit
 from ledger.providers import esi
 
 if TYPE_CHECKING:  # pragma: no cover
-    # Alliance Auth
-    from esi.stubs import CharactersCharacterIdPlanetsGetItem as PlanetGetItem
-    from esi.stubs import CharactersCharacterIdPlanetsPlanetIdGet as PlanetDetailsItem
-
     # AA Ledger
     from ledger.models.general import UpdateSectionResult
     from ledger.models.planetary import CharacterPlanet, CharacterPlanetDetails
@@ -32,6 +28,68 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
+class CharacterPlanetContext:
+    """Context for Get colonies ESI operations."""
+
+    last_update: timezone.datetime
+    num_pins: int
+    owner_id: int
+    planet_id: int
+    planet_type: str
+    solar_system_id: int
+    upgrade_level: int
+
+
+class CharacterPlanetLayoutContext:
+    """Context for Get colony layout ESI operations."""
+
+    class LinksContext:
+        destination_pin_id: int
+        link_level: int
+        source_pin_id: int
+
+    class PinsContext:
+        class ContentsContext:
+            amount: int
+            type_id: int
+
+        class ExtractorDetailsContext:
+            head_id: int
+            installed_time: timezone.datetime
+            latitude: float
+            longitude: float
+            quantity_per_cycle: int
+            type_id: int
+            cycle_time: int
+
+        class FactoryDetailsContext:
+            schematic_id: int
+
+        contents: list[ContentsContext] | list
+        expiry_time: timezone.datetime
+        extractor_details: ExtractorDetailsContext | None
+        factory_details: FactoryDetailsContext | None
+        install_time: timezone.datetime | None
+        last_cycle_start: timezone.datetime | None
+        latitude: float
+        longitude: float
+        pin_id: int
+        schematic_id: int | None
+        type_id: int
+
+    class RoutesContext:
+        content_type_id: int
+        destination_pin_id: int
+        quantity: int
+        route_id: int
+        source_pin_id: int
+        waypoints: list
+
+    links: list[LinksContext]
+    pins: list[PinsContext]
+    routes: list[RoutesContext]
+
+
 def to_json_serializable(data):
     if isinstance(data, dict):
         return {k: to_json_serializable(v) for k, v in data.items()}
@@ -73,13 +131,16 @@ class PlanetaryManagerBase(models.Manager):
             token=token,
         )
 
-        planets_items = operation.results(force_refresh=force_refresh)
+        planets_items, response = operation.results(
+            return_response=True, force_refresh=force_refresh
+        )
+        logger.debug("ESI response Status: %s", response.status_code)
 
         self._update_or_create_objs(character=audit, objs=planets_items)
 
     @transaction.atomic()
     def _update_or_create_objs(
-        self, character: "CharacterAudit", objs: list["PlanetGetItem"]
+        self, character: "CharacterAudit", objs: list[CharacterPlanetContext]
     ) -> None:
         """Update or Create planets entries from objs data."""
         # pylint: disable=import-outside-toplevel
@@ -154,14 +215,18 @@ class PlanetaryDetailsQuerySet(models.QuerySet):
         self,
         character: CharacterAudit,
         planet: "CharacterPlanetDetails",
-        objs: list["PlanetDetailsItem"],
+        objs: list[CharacterPlanetLayoutContext],
     ):
         """Update or Create Layout for a given Planet"""
         return self._update_or_create(character=character, planet=planet, objs=objs)
 
     def _convert_to_dict(
         self,
-        result: list,
+        result: list[
+            CharacterPlanetLayoutContext.LinksContext
+            | CharacterPlanetLayoutContext.PinsContext
+            | CharacterPlanetLayoutContext.RoutesContext
+        ],
     ) -> tuple:
         objects_list = []
         for data in result:
@@ -173,7 +238,7 @@ class PlanetaryDetailsQuerySet(models.QuerySet):
         self,
         character: "CharacterAudit",
         planet: "CharacterPlanetDetails",
-        objs: list["PlanetDetailsItem"],
+        objs: list[CharacterPlanetLayoutContext],
     ):
         """Update or Create Layout for a given Planet"""
         if not isinstance(objs, list):
@@ -340,8 +405,11 @@ class PlanetaryDetailsManagerBase(models.Manager):
             )
 
             try:
-                planets_details_items = operation.results(force_refresh=force_refresh)
+                planets_details_items, response = operation.results(
+                    return_response=True, force_refresh=force_refresh
+                )
                 is_updated = True
+                logger.debug("ESI response Status: %s", response.status_code)
             except HTTPNotModified:
                 continue
 
@@ -358,7 +426,7 @@ class PlanetaryDetailsManagerBase(models.Manager):
     def _update_or_create_objs(
         self,
         character: "CharacterAudit",
-        objs: list["PlanetDetailsItem"],
+        objs: list[CharacterPlanetLayoutContext],
         planet_id: int,
     ) -> None:
         """Update or Create planets entries from objs data."""

ledger/managers/corporation_journal_manager.py

@@ -23,12 +23,6 @@ from ledger.models.general import EveEntity
 from ledger.providers import esi
 
 if TYPE_CHECKING:
-    # Alliance Auth
-    from esi.stubs import CorporationsCorporationIdDivisionsGet as DivisionItem
-    from esi.stubs import (
-        CorporationsCorporationIdWalletsDivisionJournalGetItem as JournalItem,
-    )
-
     # AA Ledger
     from ledger.models.corporationaudit import (
         CorporationAudit,
@@ -38,6 +32,43 @@ if TYPE_CHECKING:
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
+# pylint: disable=duplicate-code
+class CorporationJournalContext:
+    """Context for corporation wallet journal ESI operations."""
+
+    amount: float
+    balance: float
+    context_id: int
+    context_id_type: str
+    date: str
+    description: str
+    first_party_id: int
+    id: int
+    reason: str
+    ref_type: str
+    second_party_id: int
+    tax: float
+    tax_receiver_id: int
+
+
+class CorporationDivisionContext:
+    class WalletContext:
+        division: int
+        name: str | None
+
+    class HangerContext:
+        division: int
+        name: str | None
+
+    hanger: list[HangerContext]
+    wallet: list[WalletContext]
+
+
+class CorporationWalletContext:
+    division: int
+    balance: float
+
+
 class CorporationWalletQuerySet(models.QuerySet):
     # pylint: disable=duplicate-code
     def annotate_bounty_income(
@@ -200,10 +231,12 @@ class CorporationWalletManagerBase(models.Manager):
                 )
             )
 
-            # pylint: disable=duplicate-code
             try:
-                journal_items = operation.results(force_refresh=force_refresh)
+                journal_items, response = operation.results(
+                    return_response=True, force_refresh=force_refresh
+                )
                 is_updated = True
+                logger.debug("ESI response Status: %s", response.status_code)
             except HTTPNotModified:
                 continue
 
@@ -216,7 +249,7 @@ class CorporationWalletManagerBase(models.Manager):
     def _update_or_create_objs(
         self,
         division: "CorporationWalletDivision",
-        objs: list["JournalItem"],
+        objs: list[CorporationJournalContext],
     ) -> None:
         """Update or Create wallet journal entries from objs data."""
         _new_names = []
@@ -313,7 +346,11 @@ class CorporationDivisionManagerBase(models.Manager):
             corporation_id=audit.corporation.corporation_id,
             token=token,
         )
-        division_items = operation.results(force_refresh=force_refresh)
+        division_items, response = operation.results(
+            return_response=True, force_refresh=force_refresh
+        )
+
+        logger.debug("ESI response Status: %s", response.status_code)
 
         self._update_or_create_objs(corporation=audit, objs=division_items)
 
@@ -343,7 +380,11 @@ class CorporationDivisionManagerBase(models.Manager):
             corporation_id=audit.corporation.corporation_id,
             token=token,
         )
-        division_items = operation.results(force_refresh=force_refresh)
+        division_items, response = operation.results(
+            return_response=True, force_refresh=force_refresh
+        )
+
+        logger.debug("ESI response Status: %s", response.status_code)
 
         self._update_or_create_objs_division(corporation=audit, objs=division_items)
 
@@ -351,7 +392,7 @@ class CorporationDivisionManagerBase(models.Manager):
     def _update_or_create_objs_division(
         self,
         corporation: "CorporationAudit",
-        objs: list["DivisionItem"],
+        objs: list[CorporationDivisionContext],
     ) -> None:
         """Update or Create division entries from objs data."""
         for division in objs:  # list (hanger, wallet)

ledger/models/general.py

@@ -9,7 +9,8 @@ from dataclasses import dataclass
 from typing import Any, NamedTuple
 
 # Third Party
-from aiopenapi3.errors import ContentTypeError, HTTPClientError, HTTPServerError
+from aiopenapi3.errors import ContentTypeError
+from bravado.exception import HTTPInternalServerError
 
 # Django
 from django.core.validators import MinValueValidator
@@ -33,6 +34,7 @@ from app_utils.logging import LoggerAddTag
 
 # AA Ledger
 from ledger import __title__, app_settings
+from ledger.errors import HTTPGatewayTimeoutError
 from ledger.managers.general_manager import EveEntityManager
 
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
@@ -145,8 +147,6 @@ class UpdateSectionResult(NamedTuple):
 
     is_changed: bool | None
     is_updated: bool
-    has_token_error: bool = False
-    error_message: str | None = None
     data: Any = None
 
 
@@ -231,27 +231,19 @@ class AuditBase(models.Model):
         try:
             data = fetch_func(audit=self, force_refresh=force_refresh)
             logger.debug("%s: Update has changed, section: %s", self, section.label)
-        except HTTPServerError as exc:
+        except HTTPInternalServerError as exc:
             logger.debug("%s: Update has an HTTP internal server error: %s", self, exc)
             return UpdateSectionResult(is_changed=False, is_updated=False)
-        except HTTPClientError as exc:
-            error_message = f"{type(exc).__name__}: {str(exc)}"
-            # TODO ADD DISCORD/AUTH NOTIFICATION?
-            logger.error(
-                "%s: %s: Update has Client Error: %s %s",
+        except HTTPNotModified:
+            logger.debug("%s: Update has not changed, section: %s", self, section.label)
+            return UpdateSectionResult(is_changed=False, is_updated=False)
+        except HTTPGatewayTimeoutError as exc:
+            logger.debug(
+                "%s: Update has a gateway timeout error, section: %s: %s",
                 self,
                 section.label,
-                error_message,
-                exc.status_code,
-            )
-            return UpdateSectionResult(
-                is_changed=False,
-                is_updated=False,
-                has_token_error=True,
-                error_message=error_message,
+                exc,
             )
-        except HTTPNotModified:
-            logger.debug("%s: Update has not changed, section: %s", self, section.label)
             return UpdateSectionResult(is_changed=False, is_updated=False)
         except (OSError, ContentTypeError) as exc:
             logger.info(
@@ -294,6 +286,7 @@ class AuditBase(models.Model):
         try:
             result = method(*args, **kwargs)
         except Exception as exc:
+            # TODO ADD DISCORD/AUTH NOTIFICATION?
             error_message = f"{type(exc).__name__}: {str(exc)}"
             is_token_error = isinstance(exc, (TokenError))
             logger.error(
@@ -319,23 +312,24 @@ class AuditBase(models.Model):
 
     def update_section_log(
         self,
-        section: models.TextChoices,
-        result: UpdateSectionResult,
+        section,
+        is_success: bool,
+        is_updated: bool = False,
+        error_message: str = None,
     ) -> None:
         """Update the status of a specific section."""
-        error_message = result.error_message if result.error_message else ""
-        is_success = not result.has_token_error
+        error_message = error_message if error_message else ""
         defaults = {
             "is_success": is_success,
             "error_message": error_message,
-            "has_token_error": result.has_token_error,
+            "has_token_error": False,
             "last_run_finished_at": timezone.now(),
         }
-        obj: UpdateStatus = self.update_status.update_or_create(
+        obj = self.update_status.update_or_create(
             section=section,
             defaults=defaults,
         )[0]
-        if result.is_updated:
+        if is_updated:
             obj.last_update_at = obj.last_run_at
             obj.last_update_finished_at = timezone.now()
             obj.save()
@@ -347,7 +341,7 @@ class AuditBase(models.Model):
         sections_needs_update = {
             section: True for section in self.UpdateSection.get_sections()
         }
-        existing_sections: models.QuerySet[UpdateStatus] = self.update_status.all()
+        existing_sections = self.update_status.all()
         needs_update = {
             obj.section: obj.need_update()
             for obj in existing_sections

ledger/tasks.py

@@ -269,7 +269,7 @@ def _update_character_section(character_pk: int, section: str, force_refresh: bo
     else:
         kwargs = {}
     result = character.perform_update_status(section, method, **kwargs)
-    character.update_section_log(section, result)
+    character.update_section_log(section, is_success=True, is_updated=result.is_updated)
 
 
 # Corporation Audit - Tasks
@@ -420,7 +420,9 @@ def _update_corporation_section(corporation_pk: int, section: str, force_refresh
         kwargs = {}
 
     result = corporation.perform_update_status(section, method, **kwargs)
-    corporation.update_section_log(section, result)
+    corporation.update_section_log(
+        section, is_success=True, is_updated=result.is_updated
+    )
 
 
 @shared_task(**TASK_DEFAULTS_ONCE)

ledger/tests/testdata/esi_stub.py

@@ -47,48 +47,56 @@ _endpoints = [
         "GetCharactersCharacterIdWalletJournal",
         "character_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Wallet",
         "GetCharactersCharacterIdWallet",
         "character_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Corporation",
         "GetCorporationsCorporationIdDivisions",
         "corporation_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Wallet",
         "GetCorporationsCorporationIdWallets",
         "corporation_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Wallet",
         "GetCorporationsCorporationIdWalletsDivisionJournal",
         "corporation_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Industry",
         "GetCharactersCharacterIdMining",
         "character_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Planetary_Interaction",
         "GetCharactersCharacterIdPlanets",
         "character_id",
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Planetary_Interaction",
         "GetCharactersCharacterIdPlanetsPlanetId",
         ("character_id", "planet_id"),
         needs_token=False,
+        return_response=True,
     ),
     EsiEndpoint(
         "Universe",

ledger/urls.py

@@ -15,7 +15,7 @@ from ledger.views.corporation.add_corp import add_corp
 # AA Example App
 from ledger.views.index import admin, index
 
-app_name: str = "ledger"  # pylint: disable=invalid-name
+app_name: str = "ledger"
 
 urlpatterns = [
     path("", index, name="index"),