serverwatcher 5.8.dev5__py3-none-any.whl → 5.8.dev7__py3-none-any.whl

serverwatcher/configclasses/config.py

@@ -6,6 +6,7 @@ def yaml_key(path: str, default=None):
 @dataclass
 class GlobalConfig:
     watch_interval: int = yaml_key("watch_interval")
+    timezone: str = yaml_key("timezone")
 
     panel_name: str = yaml_key("panel.name")
     panel_url: str = yaml_key("panel.url")
@@ -25,7 +26,6 @@ class GlobalConfig:
     enable_logging: bool = yaml_key("logger.enabled")
     logger_name: str = yaml_key("logger.name")
     log_path: str = yaml_key("logger.log_path")
-    timezone: str = yaml_key("logger.timezone")
 
     console_backspaces: int = yaml_key("terminal.backspaces")
     clear_terminal: bool = yaml_key("terminal.enable_clearing")

serverwatcher/configclasses/messages.py

@@ -19,16 +19,16 @@ class MessagesConfig:
     minute_1: str = yaml_key("broadcast_minutes.1")
 
     # second messages
-    second_10: str = yaml_key("broadcast_seconds.10")
-    second_9: str = yaml_key("broadcast_seconds.9")
-    second_8: str = yaml_key("broadcast_seconds.8")
-    second_7: str = yaml_key("broadcast_seconds.7")
-    second_6: str = yaml_key("broadcast_seconds.6")
-    second_5: str = yaml_key("broadcast_seconds.5")
-    second_4: str = yaml_key("broadcast_seconds.4")
-    second_3: str = yaml_key("broadcast_seconds.3")
-    second_2: str = yaml_key("broadcast_seconds.2")
-    second_1: str = yaml_key("broadcast_seconds.1")
+    second_10: str = yaml_key("broadcast_seconds.10", default="{prefix} Restart in 10 seconds!")
+    second_9:  str = yaml_key("broadcast_seconds.9",  default="{prefix} Restart in 9 seconds!")
+    second_8:  str = yaml_key("broadcast_seconds.8",  default="{prefix} Restart in 8 seconds!")
+    second_7:  str = yaml_key("broadcast_seconds.7",  default="{prefix} Restart in 7 seconds!")
+    second_6:  str = yaml_key("broadcast_seconds.6",  default="{prefix} Restart in 6 seconds!")
+    second_5:  str = yaml_key("broadcast_seconds.5",  default="{prefix} Restart in 5 seconds!")
+    second_4:  str = yaml_key("broadcast_seconds.4",  default="{prefix} Restart in 4 seconds!")
+    second_3:  str = yaml_key("broadcast_seconds.3",  default="{prefix} Restart in 3 seconds!")
+    second_2:  str = yaml_key("broadcast_seconds.2",  default="{prefix} Restart in 2 seconds!")
+    second_1:  str = yaml_key("broadcast_seconds.1",  default="{prefix} Restart in 1 second!")
 
     # logging
     startup: str = yaml_key("logging.startup")

serverwatcher/defaultconfigs/config.yaml

@@ -1,4 +1,5 @@
 watch_interval: 300
+timezone: 'America/Chicago'
 
 panel:
   name: 'My Panel'
@@ -21,7 +22,6 @@ logger:
   enabled: True
   name: 'Server Watcher'
   log_path: '/home/container/logs/'
-  timezone: 'America/Chicago'
 
 terminal:
   backspaces: 8

serverwatcher/defaultconfigs/messages.yaml

@@ -46,7 +46,7 @@ reasons:
   uptime: 'Uptime {uptime} exceeds {threshold}h'
   tps: 'TPS {tps} is lower than {threshold}'
   low_uptime: 'Uptime {uptime} is shorter than 30m'
-  players: 'There {verb} {count} {plural} online'
+  players: 'There {verb} {count} {plural} online'         # produces: "There are 2 players online" or "There is 1 player online"
 
   pro_restart_number: 'Pro-restart: '
   anti_restart_number: 'Anti-restart:'

serverwatcher/watcher.py

@@ -1,4 +1,3 @@
-# serverwatcher.py
 import os
 import time
 import re
@@ -27,6 +26,7 @@ validate_all()
 _T_EXPR = re.compile(r"{([^{}]+)}")
 
 def t_eval(template: str, /, **ctx):
+    # evaluate inline expressions inside message templates
     def repl(match):
         expr = match.group(1).strip()
         try:
@@ -37,7 +37,6 @@ def t_eval(template: str, /, **ctx):
 
 class ServerWatcher:
     def __init__(self):
-
         self.config = loadConfig(
             "config/config.yaml",
             "/defaultconfigs/config.yaml",
@@ -79,10 +78,12 @@ class ServerWatcher:
             tpsCommand=self.config.tps_command,
         )
 
+        # formatted logger name
         logger_name = self.config.logger_name.format(
             server_name=self.config.server_name
         )
 
+        # initialize message router
         self.router = MessageRouter(
             name=logger_name,
             server=self.server,
@@ -91,44 +92,67 @@ class ServerWatcher:
             console_backspaces=self.config.console_backspaces,
         )
 
+        # timezone for scheduling
         self.tz = ZoneInfo(self.config.timezone)
 
     def fmt(self, template: str, **fmt):
+        # apply t-eval formatting to templates
         return t_eval(template, self=self, **fmt)
+    
+    def say(self, template, level="info", **fmt):
+        if not template:
+            return
+        self.router.say(
+            template,
+            level=level,
+            log=self.config.enable_logging,
+            **fmt
+        )
+
+
 
     def shutdown(self):
-        self.router.say(self.messages.shutdown)
+        self.say(self.messages.shutdown)
         raise SystemExit
 
     def restart_and_wait(self):
+        # disable schedule if configured
         if self.watcherconfig.schedule_control:
             self.origin.disableSchedule(self.watcherconfig.restart_soon_id)
+
+        # send restart command
         self.server.restart()
-        self.router.say(self.messages.restart_action_sent)
+        self.say(self.messages.restart_action_sent)
         time.sleep(self.watcherconfig.restart_wait_seconds)
 
-        self.router.say(self.messages.status_check, level="warn")
+        # check server status
+        self.say(self.messages.status_check, level="warn")
         alive = waitForOnline(
             self.server,
             timeout=self.watcherconfig.restart_timeout,
             interval=self.watcherconfig.restart_online_interval,
         )
 
+        # handle restart result
         if alive:
-            self.router.say(self.messages.server_back_online)
-            self.router.say(self.messages.server_back_online_broadcast, broadcast=True)
+            self.say(self.messages.server_back_online)
+            self.say(self.messages.server_back_online_broadcast, broadcast=True)
         else:
-            self.router.say(self.messages.server_failed_restart, level="error")
+            self.say(self.messages.server_failed_restart, level="error")
 
     def schedule_restart(self, minutes):
+        # compute scheduled restart time
         info = snapSchedule(minimumMinutes=minutes)
         scheduled = info["scheduled"]
 
+        # format local time
         local_time = scheduled.astimezone(self.tz)
         time_str = local_time.strftime("%I:%M %p")
 
+        # broadcast restart time
         self.router.broadcast(self.fmt(self.messages.broadcast_restart_at, time=time_str))
 
+        # build minute callbacks
         minute_callbacks = {
             int(k.split("_")[1]): (
                 lambda msg=self.fmt(getattr(self.messages, k)):
@@ -138,6 +162,7 @@ class ServerWatcher:
             if k.startswith("minute_")
         }
 
+        # build second callbacks
         second_callbacks = {
             int(k.split("_")[1]): (
                 lambda msg=self.fmt(getattr(self.messages, k)):
@@ -147,6 +172,7 @@ class ServerWatcher:
             if k.startswith("second_")
         }
 
+        # run countdown events
         runCountdownEvents(
             target_time=scheduled,
             minute_callbacks=minute_callbacks,
@@ -154,32 +180,40 @@ class ServerWatcher:
         )
 
     def evaluate(self):
-        self.router.say(self.messages.startup)
+        # announce evaluation start
+        self.say(self.messages.startup)
 
+        # validate panel and server
         if not validateAll(self.panel, self.server):
-            self.router.say(self.messages.validation_fail, level="error")
+            self.say(self.messages.validation_fail, level="error")
             self.shutdown()
 
+        # refresh server state
         self.server.refresh()
         snap = Snapshot(self.server, 2, True)
 
+        # scoring variables
         pro = 0
         anti = 0
         restart_reasons = []
         no_restart_reasons = []
 
+        # check schedule flag
         if self.watcherconfig.schedule_control and self.server.getSchedule(self.watcherconfig.restart_soon_id)["is_active"]:
             restart_reasons.append(self.messages.reason_restart_soon)
             pro += self.watcherconfig.weight_restart_soon
 
+        # check RAM threshold
         if snap.ram >= self.watcherconfig.threshold_ram:
             restart_reasons.append(self.fmt(self.messages.reason_ram, ram=snap.ram, threshold=self.watcherconfig.threshold_ram))
             pro += int(round(snap.ram, 0) - (self.watcherconfig.threshold_ram - 1))
 
+        # check CPU threshold
         if snap.cpu >= self.watcherconfig.threshold_cpu:
             restart_reasons.append(self.fmt(self.messages.reason_cpu, cpu=snap.cpu, threshold=self.watcherconfig.threshold_cpu))
             pro += self.watcherconfig.weight_cpu
 
+        # check uptime threshold
         if snap.uptime // 3600 >= self.watcherconfig.threshold_uptime:
             restart_reasons.append(
                 self.fmt(self.messages.reason_uptime, uptime=snap.uptime_formatted,
@@ -187,55 +221,69 @@ class ServerWatcher:
             )
             pro += self.watcherconfig.weight_uptime
 
+        # check TPS threshold
         if (snap.tps if snap.tps is not None else 20) <= self.watcherconfig.threshold_tps:
             restart_reasons.append(self.fmt(self.messages.reason_tps, tps=snap.tps, threshold=self.watcherconfig.threshold_tps))
             pro += self.watcherconfig.weight_tps
 
+        # check low uptime penalty
         if snap.uptime // 60 < 30:
             no_restart_reasons.append(self.fmt(self.messages.reason_low_uptime, uptime=snap.uptime_formatted))
             anti += self.watcherconfig.weight_low_uptime
 
+        # check player count penalty
         if snap.players > 0:
             verb = "are" if snap.players != 1 else "is"
             plural = "players" if snap.players != 1 else "player"
             no_restart_reasons.append(self.fmt(self.messages.reason_players, verb=verb, count=snap.players, plural=plural))
             anti += snap.players * self.watcherconfig.weight_per_player
 
+        # output pro-restart reasons
         if restart_reasons:
-            self.router.say(self.messages.pro_restart_splash, level="warn")
+            self.say(self.messages.pro_restart_splash, level="warn")
             for r in restart_reasons:
-                self.router.say(f"{self.messages.bullet} {r}", level="warn")
+                self.say(f"{self.messages.bullet} {r}", level="warn")
 
+        # output anti-restart reasons
         if no_restart_reasons:
-            self.router.say(self.messages.anti_restart_splash, level="warn")
+            self.say(self.messages.anti_restart_splash, level="warn")
             for r in no_restart_reasons:
-                self.router.say(f"{self.messages.bullet} {r}", level="warn")
+                self.say(f"{self.messages.bullet} {r}", level="warn")
 
-        self.router.say(f"{self.messages.pro_restart_number} {pro}", level="warn")
-        self.router.say(f"{self.messages.anti_restart_number} {anti}", level="warn")
+        # output scores
+        self.say(f"{self.messages.pro_restart_number} {pro}", level="warn")
+        self.say(f"{self.messages.anti_restart_number} {anti}", level="warn")
 
+        # compute gap
         gap = abs(pro - anti)
 
+        # no restart case
         if pro == 0:
-            self.router.say(self.messages.no_restart)
+            self.say(self.messages.no_restart)
             return
 
+        # immediate restart case
         if pro > anti and snap.players == 0:
-            self.router.say(self.messages.immediate_restart)
+            self.say(self.messages.immediate_restart)
             self.restart_and_wait()
             return
 
-        self.router.say(self.messages.scheduled)
+        # scheduled restart case
+        self.say(self.messages.scheduled)
 
+        # choose schedule window
         if gap <= 2:
-            self.router.say(self.messages.gap_low, level="warn", gap=gap)
+            self.say(self.messages.gap_low, level="warn", gap=gap)
             self.schedule_restart(self.watcherconfig.low_gap_minutes)
         else:
-            self.router.say(self.messages.gap_high, level="warn", gap=gap)
+            self.say(self.messages.gap_high, level="warn", gap=gap)
             self.schedule_restart(self.watcherconfig.high_gap_minutes)
 
+        # perform restart
         self.restart_and_wait()
 
+
+    # main loop
     def run(self):
         if self.config.clear_terminal:
             clearTerminal()

{serverwatcher-5.8.dev5.dist-info → serverwatcher-5.8.dev7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 5.8.dev5
+Version: 5.8.dev7
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: GPL-3.0

serverwatcher-5.8.dev7.dist-info/RECORD

@@ -0,0 +1,15 @@
+serverwatcher/__init__.py,sha256=Q_afN0XU29n48d6Gf0-LT2lLo3RiTWlHRT6rC_fYbjw,486
+serverwatcher/validator.py,sha256=W1-RX8UQWeO2DKEe3vC1_U6xISe_WnAVXHYT0pf4uWc,4753
+serverwatcher/watcher.py,sha256=t9NJ87eTQn0UUumkjudkwA9Z56G4RGciEpfqddtIYbw,9781
+serverwatcher/configclasses/__init__.py,sha256=YS0KhxtAJGdMcaiFstqTRNxIPLnR7s9v3Tkt5h2uKE4,182
+serverwatcher/configclasses/config.py,sha256=g5QF_QxyQxcKRYagBCoozBYWT70ibpP684bpFg74SGM,1103
+serverwatcher/configclasses/messages.py,sha256=g3Ko1R7I3zTiAm7J58eYnNHEIncRuLWelmLudhW9N6Q,3208
+serverwatcher/configclasses/watcher.py,sha256=urQvRr8b7OjK0sm5eovSg9S3vo0LWZxE0cqpwX6NXbE,1230
+serverwatcher/defaultconfigs/config.yaml,sha256=7jAFWDkC6S68z6co0A_9H8vPYPDKDvDeopaaDHUX_Ks,459
+serverwatcher/defaultconfigs/messages.yaml,sha256=OthW7v-KzORPOUQuhXVjG6n82pW4TM317f4dGLQPDvA,2169
+serverwatcher/defaultconfigs/watcher.yaml,sha256=1XUr7p5qRiaZkSccULVgEAGvHMFOM2IPNBRxdnG86NA,380
+serverwatcher-5.8.dev7.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+serverwatcher-5.8.dev7.dist-info/METADATA,sha256=VV_Yb8GPYBQQLNeW7fVRA-XObIMnVOAj2ro3OjZ-Yvc,1686
+serverwatcher-5.8.dev7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+serverwatcher-5.8.dev7.dist-info/top_level.txt,sha256=8DJAf8WmmglgtZHkp8aoTriRJ2YPcS4F3DfOIkytASo,14
+serverwatcher-5.8.dev7.dist-info/RECORD,,

serverwatcher-5.8.dev5.dist-info/RECORD

@@ -1,15 +0,0 @@
-serverwatcher/__init__.py,sha256=Q_afN0XU29n48d6Gf0-LT2lLo3RiTWlHRT6rC_fYbjw,486
-serverwatcher/validator.py,sha256=W1-RX8UQWeO2DKEe3vC1_U6xISe_WnAVXHYT0pf4uWc,4753
-serverwatcher/watcher.py,sha256=B6Y23pbqqUPtl6a1j1c6XwGJ-EFRv91MoC8YcR6kUUw,8502
-serverwatcher/configclasses/__init__.py,sha256=YS0KhxtAJGdMcaiFstqTRNxIPLnR7s9v3Tkt5h2uKE4,182
-serverwatcher/configclasses/config.py,sha256=cnrRYaJ7W-SuUuVZI2tFgGWtmlLkMNNy51HxTud4tB8,1110
-serverwatcher/configclasses/messages.py,sha256=JZawv8_Kn9rns_bbuw0cuk5DhwinlueCao63NJIttXo,2770
-serverwatcher/configclasses/watcher.py,sha256=urQvRr8b7OjK0sm5eovSg9S3vo0LWZxE0cqpwX6NXbE,1230
-serverwatcher/defaultconfigs/config.yaml,sha256=lq-eTwAG4QQKIJKniMeEj9eD_DG06zMNf-C7Scqa9KI,461
-serverwatcher/defaultconfigs/messages.yaml,sha256=Zft8a1XrZj2YcdVg1njQM55RZTCZdDWzaxi2raIPeOo,2090
-serverwatcher/defaultconfigs/watcher.yaml,sha256=1XUr7p5qRiaZkSccULVgEAGvHMFOM2IPNBRxdnG86NA,380
-serverwatcher-5.8.dev5.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-serverwatcher-5.8.dev5.dist-info/METADATA,sha256=SqQIIAWImbrmG_IaZMY4QOG6dCap7o6SV2gjNjWx4Vw,1686
-serverwatcher-5.8.dev5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-serverwatcher-5.8.dev5.dist-info/top_level.txt,sha256=8DJAf8WmmglgtZHkp8aoTriRJ2YPcS4F3DfOIkytASo,14
-serverwatcher-5.8.dev5.dist-info/RECORD,,