aprsd 3.4.4__py3-none-any.whl → 4.0.1__py3-none-any.whl

aprsd/threads/{keep_alive.py → keepalive.py}

@@ -5,14 +5,12 @@ import tracemalloc
 
 from loguru import logger
 from oslo_config import cfg
-import timeago
 
 from aprsd import packets, utils
-from aprsd.client import client_factory
 from aprsd.log import log as aprsd_log
 from aprsd.stats import collector
 from aprsd.threads import APRSDThread, APRSDThreadList
-
+from aprsd.utils import keepalive_collector
 
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
@@ -36,18 +34,14 @@ class KeepAliveThread(APRSDThread):
             thread_list = APRSDThreadList()
             now = datetime.datetime.now()
 
-            if "EmailStats" in stats_json:
-                email_stats = stats_json["EmailStats"]
-                if email_stats.get("last_check_time"):
-                    email_thread_time = utils.strfdelta(now - email_stats["last_check_time"])
-                else:
-                    email_thread_time = "N/A"
-            else:
-                email_thread_time = "N/A"
-
-            if "APRSClientStats" in stats_json and stats_json["APRSClientStats"].get("transport") == "aprsis":
+            if (
+                "APRSClientStats" in stats_json
+                and stats_json["APRSClientStats"].get("transport") == "aprsis"
+            ):
                 if stats_json["APRSClientStats"].get("server_keepalive"):
-                    last_msg_time = utils.strfdelta(now - stats_json["APRSClientStats"]["server_keepalive"])
+                    last_msg_time = utils.strfdelta(
+                        now - stats_json["APRSClientStats"]["server_keepalive"]
+                    )
                 else:
                     last_msg_time = "N/A"
             else:
@@ -64,7 +58,7 @@ class KeepAliveThread(APRSDThread):
 
             keepalive = (
                 "{} - Uptime {} RX:{} TX:{} Tracker:{} Msgs TX:{} RX:{} "
-                "Last:{} Email: {} - RAM Current:{} Peak:{} Threads:{} LoggingQueue:{}"
+                "Last:{} - RAM Current:{} Peak:{} Threads:{} LoggingQueue:{}"
             ).format(
                 stats_json["APRSDStats"]["callsign"],
                 stats_json["APRSDStats"]["uptime"],
@@ -74,7 +68,6 @@ class KeepAliveThread(APRSDThread):
                 tx_msg,
                 rx_msg,
                 last_msg_time,
-                email_thread_time,
                 stats_json["APRSDStats"]["memory_current_str"],
                 stats_json["APRSDStats"]["memory_peak_str"],
                 len(thread_list),
@@ -97,35 +90,11 @@ class KeepAliveThread(APRSDThread):
                     LOGU.opt(colors=True).info(thread_msg)
                     # LOG.info(f"{key: <15} Alive? {str(alive): <5} {str(age): <20}")
 
-            # check the APRS connection
-            cl = client_factory.create()
-            cl_stats = cl.stats()
-            ka = cl_stats.get("connection_keepalive", None)
-            if ka:
-                keepalive = timeago.format(ka)
-            else:
-                keepalive = "N/A"
-            LOGU.opt(colors=True).info(f"<green>Client keepalive {keepalive}</green>")
-            # Reset the connection if it's dead and this isn't our
-            # First time through the loop.
-            # The first time through the loop can happen at startup where
-            # The keepalive thread starts before the client has a chance
-            # to make it's connection the first time.
-            if not cl.is_alive() and self.cntr > 0:
-                LOG.error(f"{cl.__class__.__name__} is not alive!!! Resetting")
-                client_factory.create().reset()
-            # else:
-            #     # See if we should reset the aprs-is client
-            #     # Due to losing a keepalive from them
-            #     delta_dict = utils.parse_delta_str(last_msg_time)
-            #     delta = datetime.timedelta(**delta_dict)
-            #
-            #     if delta > self.max_delta:
-            #         #  We haven't gotten a keepalive from aprs-is in a while
-            #         # reset the connection.a
-            #         if not client.KISSClient.is_enabled():
-            #             LOG.warning(f"Resetting connection to APRS-IS {delta}")
-            #             client.factory.create().reset()
+            # Go through the registered keepalive collectors
+            # and check them as well as call log.
+            collect = keepalive_collector.KeepAliveCollector()
+            collect.check()
+            collect.log()
 
             # Check version every day
             delta = now - self.checker_time

aprsd/threads/registry.py

@@ -1,19 +1,19 @@
 import logging
 import time
 
-from oslo_config import cfg
 import requests
+from oslo_config import cfg
 
 import aprsd
 from aprsd import threads as aprsd_threads
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
 
 
 class APRSRegistryThread(aprsd_threads.APRSDThread):
     """This sends service information to the configured APRS Registry."""
+
     _loop_cnt: int = 1
 
     def __init__(self):
@@ -41,7 +41,7 @@ class APRSRegistryThread(aprsd_threads.APRSDThread):
                 "description": CONF.aprs_registry.description,
                 "service_website": CONF.aprs_registry.service_website,
                 "software": f"APRSD version {aprsd.__version__} "
-                            "https://github.com/craigerl/aprsd",
+                "https://github.com/craigerl/aprsd",
             }
             try:
                 requests.post(

aprsd/threads/rx.py

@@ -13,7 +13,6 @@ from aprsd.packets import log as packet_log
 from aprsd.threads import APRSDThread, tx
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
 
@@ -53,7 +52,9 @@ class APRSDRXThread(APRSDThread):
             # kwargs.  :(
             # https://github.com/rossengeorgiev/aprs-python/pull/56
             self._client.consumer(
-                self._process_packet, raw=False, blocking=False,
+                self._process_packet,
+                raw=False,
+                blocking=False,
             )
         except (
             aprslib.exceptions.ConnectionDrop,
@@ -138,7 +139,9 @@ class APRSDDupeRXThread(APRSDRXThread):
             elif packet.timestamp - found.timestamp < CONF.packet_dupe_timeout:
                 # If the packet came in within N seconds of the
                 # Last time seeing the packet, then we drop it as a dupe.
-                LOG.warning(f"Packet {packet.from_call}:{packet.msgNo} already tracked, dropping.")
+                LOG.warning(
+                    f"Packet {packet.from_call}:{packet.msgNo} already tracked, dropping."
+                )
             else:
                 LOG.warning(
                     f"Packet {packet.from_call}:{packet.msgNo} already tracked "
@@ -149,7 +152,7 @@ class APRSDDupeRXThread(APRSDRXThread):
 
 
 class APRSDPluginRXThread(APRSDDupeRXThread):
-    """"Process received packets.
+    """ "Process received packets.
 
     For backwards compatibility, we keep the APRSDPluginRXThread.
     """
@@ -249,7 +252,8 @@ class APRSDProcessPacketThread(APRSDThread):
                     self.process_other_packet(packet, for_us=False)
             else:
                 self.process_other_packet(
-                    packet, for_us=(to_call.lower() == our_call),
+                    packet,
+                    for_us=(to_call.lower() == our_call),
                 )
         LOG.debug(f"Packet processing complete for pkt '{packet.key}'")
         return False
@@ -349,7 +353,6 @@ class APRSDPluginProcessPacketThread(APRSDProcessPacketThread):
             # If the message was for us and we didn't have a
             # response, then we send a usage statement.
             if to_call == CONF.callsign and not replied:
-
                 # Tailor the messages accordingly
                 if CONF.load_help_plugin:
                     LOG.warning("Sending help!")

aprsd/threads/stats.py

@@ -2,20 +2,20 @@ import logging
 import threading
 import time
 
-from oslo_config import cfg
 import wrapt
+from oslo_config import cfg
 
 from aprsd.stats import collector
 from aprsd.threads import APRSDThread
 from aprsd.utils import objectstore
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
 
 
 class StatsStore(objectstore.ObjectStoreMixin):
     """Container to save the stats from the collector."""
+
     lock = threading.Lock()
     data = {}
 

aprsd/threads/tx.py

@@ -2,20 +2,18 @@ import logging
 import threading
 import time
 
+import wrapt
 from oslo_config import cfg
 from rush import quota, throttle
 from rush.contrib import decorator
 from rush.limiters import periodic
 from rush.stores import dictionary
-import wrapt
 
 from aprsd import conf  # noqa
 from aprsd import threads as aprsd_threads
 from aprsd.client import client_factory
-from aprsd.packets import collector, core
+from aprsd.packets import collector, core, tracker
 from aprsd.packets import log as packet_log
-from aprsd.packets import tracker
-
 
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
@@ -238,6 +236,7 @@ class BeaconSendThread(aprsd_threads.APRSDThread):
 
     Settings are in the [DEFAULT] section of the config file.
     """
+
     _loop_cnt: int = 1
 
     def __init__(self):

aprsd/utils/__init__.py

@@ -13,11 +13,11 @@ import update_checker
 import aprsd
 
 from .fuzzyclock import fuzzy  # noqa: F401
+
 # Make these available by anyone importing
 # aprsd.utils
 from .ring_buffer import RingBuffer  # noqa: F401
 
-
 if sys.version_info.major == 3 and sys.version_info.minor >= 3:
     from collections.abc import MutableMapping
 else:
@@ -26,11 +26,13 @@ else:
 
 def singleton(cls):
     """Make a class a Singleton class (only one instance)"""
+
     @functools.wraps(cls)
     def wrapper_singleton(*args, **kwargs):
         if wrapper_singleton.instance is None:
             wrapper_singleton.instance = cls(*args, **kwargs)
         return wrapper_singleton.instance
+
     wrapper_singleton.instance = None
     return wrapper_singleton
 
@@ -170,7 +172,10 @@ def load_entry_points(group):
         try:
             ep.load()
         except Exception as e:
-            print(f"Extension {ep.name} of group {group} failed to load with {e}", file=sys.stderr)
+            print(
+                f"Extension {ep.name} of group {group} failed to load with {e}",
+                file=sys.stderr,
+            )
             print(traceback.format_exc(), file=sys.stderr)
 
 
@@ -200,8 +205,7 @@ def calculate_initial_compass_bearing(point_a, point_b):
 
     x = math.sin(diff_long) * math.cos(lat2)
     y = math.cos(lat1) * math.sin(lat2) - (
-        math.sin(lat1)
-        * math.cos(lat2) * math.cos(diff_long)
+        math.sin(lat1) * math.cos(lat2) * math.cos(diff_long)
     )
 
     initial_bearing = math.atan2(x, y)
@@ -218,15 +222,43 @@ def calculate_initial_compass_bearing(point_a, point_b):
 def degrees_to_cardinal(bearing, full_string=False):
     if full_string:
         directions = [
-            "North", "North-Northeast", "Northeast", "East-Northeast", "East", "East-Southeast",
-            "Southeast", "South-Southeast", "South", "South-Southwest", "Southwest", "West-Southwest",
-            "West", "West-Northwest", "Northwest", "North-Northwest", "North",
+            "North",
+            "North-Northeast",
+            "Northeast",
+            "East-Northeast",
+            "East",
+            "East-Southeast",
+            "Southeast",
+            "South-Southeast",
+            "South",
+            "South-Southwest",
+            "Southwest",
+            "West-Southwest",
+            "West",
+            "West-Northwest",
+            "Northwest",
+            "North-Northwest",
+            "North",
         ]
     else:
         directions = [
-            "N", "NNE", "NE", "ENE", "E", "ESE",
-            "SE", "SSE", "S", "SSW", "SW", "WSW",
-            "W", "WNW", "NW", "NNW", "N",
+            "N",
+            "NNE",
+            "NE",
+            "ENE",
+            "E",
+            "ESE",
+            "SE",
+            "SSE",
+            "S",
+            "SSW",
+            "SW",
+            "WSW",
+            "W",
+            "WNW",
+            "NW",
+            "NNW",
+            "N",
         ]
 
     cardinal = directions[round(bearing / 22.5)]

aprsd/utils/json.py

@@ -10,8 +10,13 @@ class EnhancedJSONEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, datetime.datetime):
             args = (
-                "year", "month", "day", "hour", "minute",
-                "second", "microsecond",
+                "year",
+                "month",
+                "day",
+                "hour",
+                "minute",
+                "second",
+                "microsecond",
             )
             return {
                 "__type__": "datetime.datetime",
@@ -63,10 +68,10 @@ class SimpleJSONEncoder(json.JSONEncoder):
 
 
 class EnhancedJSONDecoder(json.JSONDecoder):
-
     def __init__(self, *args, **kwargs):
         super().__init__(
-            *args, object_hook=self.object_hook,
+            *args,
+            object_hook=self.object_hook,
             **kwargs,
         )
 

aprsd/utils/keepalive_collector.py

@@ -0,0 +1,55 @@
+import logging
+from typing import Callable, Protocol, runtime_checkable
+
+from aprsd.utils import singleton
+
+LOG = logging.getLogger("APRSD")
+
+
+@runtime_checkable
+class KeepAliveProducer(Protocol):
+    """The KeepAliveProducer protocol is used to define the interface for running Keepalive checks."""
+
+    def keepalive_check(self) -> dict:
+        """Check for keepalive."""
+        ...
+
+    def keepalive_log(self):
+        """Log any keepalive information."""
+        ...
+
+
+@singleton
+class KeepAliveCollector:
+    """The Collector class is used to collect stats from multiple StatsProducer instances."""
+
+    def __init__(self):
+        self.producers: list[Callable] = []
+
+    def check(self) -> None:
+        """Do any keepalive checks."""
+        for name in self.producers:
+            cls = name()
+            try:
+                cls.keepalive_check()
+            except Exception as e:
+                LOG.error(f"Error in producer {name} (check): {e}")
+
+    def log(self) -> None:
+        """Log any relevant information during a KeepAlive check"""
+        for name in self.producers:
+            cls = name()
+            try:
+                cls.keepalive_log()
+            except Exception as e:
+                LOG.error(f"Error in producer {name} (check): {e}")
+
+    def register(self, producer_name: Callable):
+        if not isinstance(producer_name, KeepAliveProducer):
+            raise TypeError(f"Producer {producer_name} is not a KeepAliveProducer")
+        self.producers.append(producer_name)
+
+    def unregister(self, producer_name: Callable):
+        if not isinstance(producer_name, KeepAliveProducer):
+            raise TypeError(f"Producer {producer_name} is not a KeepAliveProducer")
+        self.producers.remove(producer_name)

aprsd/utils/trace.py

@@ -5,7 +5,6 @@ import logging
 import time
 import types
 
-
 VALID_TRACE_FLAGS = {"method", "api"}
 TRACE_API = False
 TRACE_METHOD = False
@@ -27,7 +26,6 @@ def trace(*dec_args, **dec_kwargs):
     """
 
     def _decorator(f):
-
         func_name = f.__qualname__
         func_file = "/".join(f.__code__.co_filename.split("/")[-4:])
 

aprsd-4.0.1.dist-info/AUTHORS

@@ -0,0 +1 @@
+waboring@hemna.com : 1