adding faction and simpleregionview

Author: CrosswaveOmega

pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 keywords=['helldivers2','api']
 requires-python = ">=3.8.1"
 
-version = '0.0.1.18.3.2'
+version = '0.0.1.18.4'
 dependencies= [
 "pydantic>=2.9.2",
 "httpx>=0.27.2"

src/hd2api/builders/campaign_builder.py

@@ -22,6 +22,7 @@ def build_campaign(planets: Dict[int, Optional[Planet]], campaign: Campaign):
         planet=planet,
         count=campaign.count,
         type=campaign.type,
+        faction=campaign.faction,
     )
     return camp2
 

src/hd2api/builders/planet_builder.py

@@ -57,7 +57,9 @@ def build_planet_basic(
     weather = [gstatic.environmentals.get(e, None) for e in planet_base.weather_effects]
     env.extend(weather)
     # Build Statistics
-    stats_new = statistics_builder(stats, planetStatus.players, planetStatus.retrieved_at)
+    stats_new = statistics_builder(
+        stats, planetStatus.players, planetStatus.retrieved_at
+    )
     # Position can come from planetInfo OR planetStatus
     pos = planetInfo.position
     if planetStatus.position is not None:
@@ -93,7 +95,9 @@ def check_compare_value(key, value, target: List[Dict[str, Any]]):
     return None
 
 
-def check_compare_value_list(keys: List[str], values: List[Any], target: List[Dict[str, Any]]):
+def check_compare_value_list(
+    keys: List[str], values: List[Any], target: List[Dict[str, Any]]
+):
     values = []
     for s in target:
         if all(s[key] == value for key, value in zip(keys, values)):
@@ -106,12 +110,14 @@ def get_time(status: WarStatus, info: WarInfo) -> dt.datetime:
 
     # Get datetime diveharder object was retrieved at
     now = status.retrieved_at
-    gametime = dt.datetime.fromtimestamp(info.startDate, tz=dt.timezone.utc) + dt.timedelta(
-        seconds=status.time
-    )
+    gametime = dt.datetime.fromtimestamp(
+        info.startDate, tz=dt.timezone.utc
+    ) + dt.timedelta(seconds=status.time)
     deviation = now - gametime
     # print(deviation)
-    relative_game_start = dt.datetime.fromtimestamp(info.startDate, tz=dt.timezone.utc) + deviation
+    relative_game_start = (
+        dt.datetime.fromtimestamp(info.startDate, tz=dt.timezone.utc) + deviation
+    )
     return relative_game_start
 
 
@@ -234,7 +240,9 @@ def build_planet_2(planetIndex: int, warall: DiveharderAll, statics: StaticAll):
     summary: Optional[WarSummary] = warall.planet_stats
 
     regions = build_all_regions(warall, statics)
-    planet = build_planet_full(planetIndex, status, info, summary, statics, regions=regions)
+    planet = build_planet_full(
+        planetIndex, status, info, summary, statics, regions=regions
+    )
     return planet
 
 

src/hd2api/builders/region_builder.py

@@ -6,6 +6,7 @@
     DiveharderAll,
     Event,
     GalaxyStatic,
+    PlanetStatic,
     Planet,
     PlanetEvent,
     PlanetInfo,
@@ -43,7 +44,9 @@ def build_region(
     if statics.galaxystatic is None or statics.galaxystatic.planetRegion is None:
         return None
     index = region_info.planetIndex if region_info.planetIndex is not None else -1
-    planet_base = statics.galaxystatic.planets.get(index, None)
+    planet_base = statics.galaxystatic.planets.get(
+        index, PlanetStatic(name="UNKNOWN PLANET")
+    )
     if not planet_base:
         return None
     if region_info.settingsHash in statics.galaxystatic.planetRegion:
@@ -101,7 +104,8 @@ def build_all_regions(warall: DiveharderAll, statics: StaticAll) -> List[Region]
 
     # Index PlanetRegionInfo by (planetIndex, regionIndex)
     info_lookup = {
-        f"{info.planetIndex}_{info.regionIndex}": info for info in warall.war_info.planetRegions
+        f"{info.planetIndex}_{info.regionIndex}": info
+        for info in warall.war_info.planetRegions
     }
 
     for region in warall.status.planetRegions:

src/hd2api/models/Base/Campaign.py

@@ -32,3 +32,9 @@ class Campaign(BaseApiModel):
         default=None,
         description="A numerical count, the amount of campaigns the planet has seen.",
     )
+
+    faction: Optional[int] = Field(
+        alias="faction",
+        default=None,
+        description="Optional Faction ID.",
+    )

src/hd2api/models/Campaign2.py

@@ -33,13 +33,19 @@ class Campaign2(BaseApiModel):
         default=None,
         description="Indicates how many campaigns have already been fought on this Planet.",
     )
+    faction: Optional[int] = Field(
+        alias="faction",
+        default=None,
+        description="Optional Faction ID.",
+    )
 
     def __sub__(self, other: "Campaign2") -> "Campaign2":
         camp = Campaign2(
             id=self.id,
             planet=self.planet - other.planet,  # type: ignore
             type=self.type,
             count=self.count,
+            faction=self.faction,
             time_delta=self.retrieved_at - other.retrieved_at,  # type: ignore
         )
         # camp.retrieved_at = self.retrieved_at - other.retrieved_at
@@ -49,4 +55,10 @@ def __sub__(self, other: "Campaign2") -> "Campaign2":
     def average(changes: List["Campaign2"]) -> "Campaign2":
         first = changes[0]
         avg = Planet.average([c.planet for c in changes])
-        return Campaign2(id=first.id, planet=avg, type=first.type, count=first.count)
+        return Campaign2(
+            id=first.id,
+            planet=avg,
+            type=first.type,
+            count=first.count,
+            faction=first.faction,
+        )

src/hd2api/models/Planet.py

@@ -231,7 +231,9 @@ def calculate_timeval(self, change: float, is_positive: bool) -> datetime.dateti
 
     def format_estimated_time_string(self, change: float, esttime: datetime.datetime):
         change_str = f"{round(change, 5)}"
-        timeval_str = f"Est.Loss {fdt(esttime,'R')}" if change > 0 else f"{fdt(esttime,'R')}"
+        timeval_str = (
+            f"Est.Loss {fdt(esttime,'R')}" if change > 0 else f"{fdt(esttime,'R')}"
+        )
 
         return f"`[{change_str} dps]`, {timeval_str}"
 
@@ -275,7 +277,8 @@ def average(planets_list: List["Planet"]) -> "Planet":
             return Planet()
 
         avg_health = (
-            sum(planet.health for planet in planets_list if planet.health is not None) // count
+            sum(planet.health for planet in planets_list if planet.health is not None)
+            // count
         )
 
         stats = []
@@ -357,9 +360,7 @@ def simple_planet_view(
         faction = emj(self.currentOwner.lower())
 
         name = f"{faction}P#{self.index}: {self.name}"
-        players = (
-            f"{emj('hdi')}: `{self.statistics.playerCount} {cfi(diff.statistics.playerCount)}`"
-        )
+        players = f"{emj('hdi')}: `{self.statistics.playerCount} {cfi(diff.statistics.playerCount)}`"
         outlist = [f"{players}"]
         if (not self.event) or show_hp_without_event:
             outlist.append(
@@ -384,6 +385,8 @@ def simple_planet_view(
             outlist.append(f"Deadline: [{timev}]")
             if avg:
                 if avg.event:
-                    outlist.append(f"{self.event.estimate_remaining_lib_time(avg.event)}")
+                    outlist.append(
+                        f"{self.event.estimate_remaining_lib_time(avg.event)}"
+                    )
 
         return name, outlist

src/hd2api/models/Region.py

@@ -23,10 +23,14 @@ class Region(BaseApiModel, HealthMixin):
     )
     # From PlanetRegionInfo (static/config)
     keyCombo: str = Field(
-        alias="keyCombo", default="NOKEY", description="Unique key of planetIndex_regionIndex"
+        alias="keyCombo",
+        default="NOKEY",
+        description="Unique key of planetIndex_regionIndex",
     )
     id: Optional[int] = Field(
-        alias="id", default=None, description="The identifier of this campaign, hash of key_combo."
+        alias="id",
+        default=None,
+        description="The identifier of this campaign, hash of key_combo.",
     )
     # From PlanetRegionInfo (static/config)
     planetName: Optional[str] = Field(
@@ -45,7 +49,9 @@ class Region(BaseApiModel, HealthMixin):
         description="Hash for the internal region settings.",
     )
 
-    name: Optional[str] = Field(alias="name", default=None, description="The name of the region.")
+    name: Optional[str] = Field(
+        alias="name", default=None, description="The name of the region."
+    )
 
     description: Optional[str] = Field(
         alias="description",
@@ -139,6 +145,45 @@ def calculate_change(self, diff: "Region") -> float:
             return 0.0
         return diff.health / diff.time_delta.total_seconds()
 
+    def simple_region_view(
+        self, prev: Optional["Region"] = None, avg: Optional["Region"] = None
+    ) -> Tuple[str, List[str]]:
+        """Return a string containing the formated state of the planet.
+
+        Args:
+            prev (Optional['Planet'], optional):
+            avg (Optional['Planet'], optional):Average stats for the past X planets
+
+        Returns:
+            Tuple[str,str]: _description_
+        """
+        diff = self - self
+        if prev is not None:
+            diff = prev
+
+        name = f"P#{self.planetIndex}:{self.planetName}-{self.name}"
+        players = f"{emj('hdi')}: `{self.players} {cfi(diff.players)}`"
+
+        outlist = [
+            self.description,
+            f"{players}, Owner: {self.owner}, Is available {self.isAvailable}",
+        ]
+        outlist.append(f"availabilityFactor {self.availabilityFactor}")
+        outlist.append(f"Region Size: {self.regionSize}")
+
+        outlist.append(
+            f"HP: {self.get_health_percent(self.health)}%({self.health}) {cfi(self.get_health_percent(diff.health))}`"
+        )
+        outlist.append(
+            f"Regen:`{round((100*(self.regenPerSecond/self.maxHealth))*60*60,2)}`"  # type: ignore
+        )  # type: ignore
+        if avg:
+            remaining_time = self.estimate_remaining_lib_time(avg)
+            if remaining_time:
+                outlist.append(remaining_time)
+
+        return name, outlist
+
     def calculate_timeval(self, change: float, is_positive: bool) -> datetime.datetime:
         if self.health is None or self.maxHealth is None:
             return self.retrieved_at
@@ -149,9 +194,13 @@ def calculate_timeval(self, change: float, is_positive: bool) -> datetime.dateti
             seconds = abs(self.health / change)
         return self.retrieved_at + datetime.timedelta(seconds=seconds)
 
-    def format_estimated_time_string(self, change: float, esttime: datetime.datetime) -> str:
+    def format_estimated_time_string(
+        self, change: float, esttime: datetime.datetime
+    ) -> str:
         change_str = f"{round(change, 5)}"
-        timeval_str = f"Est.Loss {fdt(esttime, 'R')}" if change > 0 else f"{fdt(esttime, 'R')}"
+        timeval_str = (
+            f"Est.Loss {fdt(esttime, 'R')}" if change > 0 else f"{fdt(esttime, 'R')}"
+        )
         return f"`[{change_str} dps]`, {timeval_str}"
 
     def estimate_remaining_lib_time(self, diff: "Region") -> str:
@@ -173,7 +222,9 @@ def average(regions: List["Region"]) -> "Region":
 
         avg_health = sum(r.health for r in regions if r.health is not None) // count
         avg_players = sum(r.players for r in regions if r.players is not None) // count
-        avg_time = sum(r.time_delta.total_seconds() for r in regions if r.time_delta) // count
+        avg_time = (
+            sum(r.time_delta.total_seconds() for r in regions if r.time_delta) // count
+        )
 
         return Region(
             planetIndex=regions[0].planetIndex,