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

aprsd/cli_helper.py

@@ -1,7 +1,7 @@
-from functools import update_wrapper
 import logging
-from pathlib import Path
 import typing as t
+from functools import update_wrapper
+from pathlib import Path
 
 import click
 from oslo_config import cfg
@@ -11,7 +11,6 @@ from aprsd import conf  # noqa: F401
 from aprsd.log import log
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
 home = str(Path.home())
 DEFAULT_CONFIG_DIR = f"{home}/.config/aprsd/"
@@ -58,6 +57,7 @@ class AliasedGroup(click.Group):
         calling into :meth:`add_command`.
         Copied from `click` and extended for `aliases`.
         """
+
         def decorator(f):
             aliases = kwargs.pop("aliases", [])
             cmd = click.decorators.command(*args, **kwargs)(f)
@@ -65,6 +65,7 @@ class AliasedGroup(click.Group):
             for alias in aliases:
                 self.add_command(cmd, name=alias)
             return cmd
+
         return decorator
 
     def group(self, *args, **kwargs):
@@ -74,6 +75,7 @@ class AliasedGroup(click.Group):
         calling into :meth:`add_command`.
         Copied from `click` and extended for `aliases`.
         """
+
         def decorator(f):
             aliases = kwargs.pop("aliases", [])
             cmd = click.decorators.group(*args, **kwargs)(f)
@@ -81,6 +83,7 @@ class AliasedGroup(click.Group):
             for alias in aliases:
                 self.add_command(cmd, name=alias)
             return cmd
+
         return decorator
 
 
@@ -89,6 +92,7 @@ def add_options(options):
         for option in reversed(options):
             func = option(func)
         return func
+
     return _add_options
 
 
@@ -103,7 +107,9 @@ def process_standard_options(f: F) -> F:
             default_config_files = None
         try:
             CONF(
-                [], project="aprsd", version=aprsd.__version__,
+                [],
+                project="aprsd",
+                version=aprsd.__version__,
                 default_config_files=default_config_files,
             )
         except cfg.ConfigFilesNotFoundError:
@@ -119,7 +125,7 @@ def process_standard_options(f: F) -> F:
             trace.setup_tracing(["method", "api"])
 
         if not config_file_found:
-            LOG = logging.getLogger("APRSD")   # noqa: N806
+            LOG = logging.getLogger("APRSD")  # noqa: N806
             LOG.error("No config file found!! run 'aprsd sample-config'")
 
         del kwargs["loglevel"]
@@ -132,6 +138,7 @@ def process_standard_options(f: F) -> F:
 
 def process_standard_options_no_config(f: F) -> F:
     """Use this as a decorator when config isn't needed."""
+
     def new_func(*args, **kwargs):
         ctx = args[0]
         ctx.ensure_object(dict)

aprsd/client/aprsis.py

@@ -2,7 +2,9 @@ import datetime
 import logging
 import time
 
+import timeago
 from aprslib.exceptions import LoginError
+from loguru import logger
 from oslo_config import cfg
 
 from aprsd import client, exception
@@ -10,14 +12,14 @@ from aprsd.client import base
 from aprsd.client.drivers import aprsis
 from aprsd.packets import core
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
+LOGU = logger
 
 
 class APRSISClient(base.APRSClient):
-
     _client = None
+    _checks = False
 
     def __init__(self):
         max_timeout = {"hours": 0.0, "minutes": 2, "seconds": 0}
@@ -45,6 +47,20 @@ class APRSISClient(base.APRSClient):
 
         return stats
 
+    def keepalive_check(self):
+        # Don't check the first time through.
+        if not self.is_alive() and self._checks:
+            LOG.warning("Resetting client.  It's not alive.")
+            self.reset()
+        self._checks = True
+
+    def keepalive_log(self):
+        if ka := self._client.aprsd_keepalive:
+            keepalive = timeago.format(ka)
+        else:
+            keepalive = "N/A"
+        LOGU.opt(colors=True).info(f"<green>Client keepalive {keepalive}</green>")
+
     @staticmethod
     def is_enabled():
         # Defaults to True if the enabled flag is non existent
@@ -81,13 +97,13 @@ class APRSISClient(base.APRSClient):
         if delta > self.max_delta:
             LOG.error(f"Connection is stale, last heard {delta} ago.")
             return True
+        return False
 
     def is_alive(self):
-        if self._client:
-            return self._client.is_alive() and not self._is_stale_connection()
-        else:
+        if not self._client:
             LOG.warning(f"APRS_CLIENT {self._client} alive? NO!!!")
             return False
+        return self._client.is_alive() and not self._is_stale_connection()
 
     def close(self):
         if self._client:
@@ -117,8 +133,12 @@ class APRSISClient(base.APRSClient):
             if retry_count >= retries:
                 break
             try:
-                LOG.info(f"Creating aprslib client({host}:{port}) and logging in {user}.")
-                aprs_client = aprsis.Aprsdis(user, passwd=password, host=host, port=port)
+                LOG.info(
+                    f"Creating aprslib client({host}:{port}) and logging in {user}."
+                )
+                aprs_client = aprsis.Aprsdis(
+                    user, passwd=password, host=host, port=port
+                )
                 # Force the log to be the same
                 aprs_client.logger = LOG
                 aprs_client.connect()
@@ -149,8 +169,10 @@ class APRSISClient(base.APRSClient):
         if self._client:
             try:
                 self._client.consumer(
-                    callback, blocking=blocking,
-                    immortal=immortal, raw=raw,
+                    callback,
+                    blocking=blocking,
+                    immortal=immortal,
+                    raw=raw,
                 )
             except Exception as e:
                 LOG.error(e)

aprsd/client/base.py

@@ -2,11 +2,11 @@ import abc
 import logging
 import threading
 
-from oslo_config import cfg
 import wrapt
+from oslo_config import cfg
 
 from aprsd.packets import core
-
+from aprsd.utils import keepalive_collector
 
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
@@ -30,6 +30,7 @@ class APRSClient:
         """This magic turns this into a singleton."""
         if cls._instance is None:
             cls._instance = super().__new__(cls)
+            keepalive_collector.KeepAliveCollector().register(cls)
             # Put any initialization here.
             cls._instance._create_client()
         return cls._instance
@@ -42,6 +43,16 @@ class APRSClient:
             dict: Statistics about the connection and packet handling
         """
 
+    @abc.abstractmethod
+    def keepalive_check(self) -> None:
+        """Called during keepalive run to check status."""
+        ...
+
+    @abc.abstractmethod
+    def keepalive_log(self) -> None:
+        """Log any keepalive information."""
+        ...
+
     @property
     def is_connected(self):
         return self.connected

aprsd/client/drivers/aprsis.py

@@ -4,17 +4,20 @@ import select
 import threading
 
 import aprslib
+import wrapt
 from aprslib import is_py3
 from aprslib.exceptions import (
-    ConnectionDrop, ConnectionError, GenericError, LoginError, ParseError,
+    ConnectionDrop,
+    ConnectionError,
+    GenericError,
+    LoginError,
+    ParseError,
     UnknownFormat,
 )
-import wrapt
 
 import aprsd
 from aprsd.packets import core
 
-
 LOG = logging.getLogger("APRSD")
 
 

aprsd/client/drivers/fake.py

@@ -3,20 +3,19 @@ import threading
 import time
 
 import aprslib
-from oslo_config import cfg
 import wrapt
+from oslo_config import cfg
 
 from aprsd import conf  # noqa
 from aprsd.packets import core
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 
 
 class APRSDFakeClient(metaclass=trace.TraceWrapperMetaclass):
-    '''Fake client for testing.'''
+    """Fake client for testing."""
 
     # flag to tell us to stop
     thread_stop = False
@@ -25,12 +24,12 @@ class APRSDFakeClient(metaclass=trace.TraceWrapperMetaclass):
     path = []
 
     def __init__(self):
-        LOG.info("Starting APRSDFakeClient client.")
-        self.path = ["WIDE1-1", "WIDE2-1"]
+        LOG.info('Starting APRSDFakeClient client.')
+        self.path = ['WIDE1-1', 'WIDE2-1']
 
     def stop(self):
         self.thread_stop = True
-        LOG.info("Shutdown APRSDFakeClient client.")
+        LOG.info('Shutdown APRSDFakeClient client.')
 
     def is_alive(self):
         """If the connection is alive or not."""
@@ -39,35 +38,31 @@ class APRSDFakeClient(metaclass=trace.TraceWrapperMetaclass):
     @wrapt.synchronized(lock)
     def send(self, packet: core.Packet):
         """Send an APRS Message object."""
-        LOG.info(f"Sending packet: {packet}")
+        LOG.info(f'Sending packet: {packet}')
         payload = None
         if isinstance(packet, core.Packet):
             packet.prepare()
-            payload = packet.payload.encode("US-ASCII")
-            if packet.path:
-                packet.path
-            else:
-                self.path
+            payload = packet.payload.encode('US-ASCII')
         else:
-            msg_payload = f"{packet.raw}{{{str(packet.msgNo)}"
+            msg_payload = f'{packet.raw}{{{str(packet.msgNo)}'
             payload = (
-                ":{:<9}:{}".format(
+                ':{:<9}:{}'.format(
                     packet.to_call,
                     msg_payload,
                 )
-            ).encode("US-ASCII")
+            ).encode('US-ASCII')
 
         LOG.debug(
             f"FAKE::Send '{payload}' TO '{packet.to_call}' From "
-            f"'{packet.from_call}' with PATH \"{self.path}\"",
+            f'\'{packet.from_call}\' with PATH "{self.path}"',
         )
 
     def consumer(self, callback, blocking=False, immortal=False, raw=False):
-        LOG.debug("Start non blocking FAKE consumer")
+        LOG.debug('Start non blocking FAKE consumer')
         # Generate packets here?
-        raw = "GTOWN>APDW16,WIDE1-1,WIDE2-1:}KM6LYW-9>APZ100,TCPIP,GTOWN*::KM6LYW   :KM6LYW: 19 Miles SW"
+        raw = 'GTOWN>APDW16,WIDE1-1,WIDE2-1:}KM6LYW-9>APZ100,TCPIP,GTOWN*::KM6LYW   :KM6LYW: 19 Miles SW'
         pkt_raw = aprslib.parse(raw)
         pkt = core.factory(pkt_raw)
         callback(packet=pkt)
-        LOG.debug(f"END blocking FAKE consumer {self}")
+        LOG.debug(f'END blocking FAKE consumer {self}')
         time.sleep(8)

aprsd/client/factory.py

@@ -4,13 +4,11 @@ from typing import Callable, Protocol, runtime_checkable
 from aprsd import exception
 from aprsd.packets import core
 
-
 LOG = logging.getLogger("APRSD")
 
 
 @runtime_checkable
 class Client(Protocol):
-
     def __init__(self):
         pass
 

aprsd/client/fake.py

@@ -7,13 +7,11 @@ from aprsd.client import base
 from aprsd.client.drivers import fake as fake_driver
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
 
 
 class APRSDFakeClient(base.APRSClient, metaclass=trace.TraceWrapperMetaclass):
-
     def stats(self, serializable=False) -> dict:
         return {
             "transport": "Fake",

aprsd/client/kiss.py

@@ -2,6 +2,8 @@ import datetime
 import logging
 
 import aprslib
+import timeago
+from loguru import logger
 from oslo_config import cfg
 
 from aprsd import client, exception
@@ -9,13 +11,12 @@ from aprsd.client import base
 from aprsd.client.drivers import kiss
 from aprsd.packets import core
 
-
 CONF = cfg.CONF
 LOG = logging.getLogger("APRSD")
+LOGU = logger
 
 
 class KISSClient(base.APRSClient):
-
     _client = None
     keepalive = datetime.datetime.now()
 
@@ -79,6 +80,20 @@ class KISSClient(base.APRSClient):
         if self._client:
             self._client.stop()
 
+    def keepalive_check(self):
+        # Don't check the first time through.
+        if not self.is_alive() and self._checks:
+            LOG.warning("Resetting client.  It's not alive.")
+            self.reset()
+        self._checks = True
+
+    def keepalive_log(self):
+        if ka := self._client.aprsd_keepalive:
+            keepalive = timeago.format(ka)
+        else:
+            keepalive = "N/A"
+        LOGU.opt(colors=True).info(f"<green>Client keepalive {keepalive}</green>")
+
     @staticmethod
     def transport():
         if CONF.kiss_serial.enabled:

aprsd/client/stats.py

@@ -1,18 +1,16 @@
 import threading
 
-from oslo_config import cfg
 import wrapt
+from oslo_config import cfg
 
 from aprsd import client
 from aprsd.utils import singleton
 
-
 CONF = cfg.CONF
 
 
 @singleton
 class APRSClientStats:
-
     lock = threading.Lock()
 
     @wrapt.synchronized(lock)

aprsd/cmds/completion.py

@@ -3,12 +3,13 @@ import click.shell_completion
 
 from aprsd.main import cli
 
-
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
 
 @cli.command()
-@click.argument("shell", type=click.Choice(list(click.shell_completion._available_shells)))
+@click.argument(
+    "shell", type=click.Choice(list(click.shell_completion._available_shells))
+)
 def completion(shell):
     """Show the shell completion code"""
     from click.utils import _detect_program_name
@@ -17,6 +18,8 @@ def completion(shell):
     prog_name = _detect_program_name()
     complete_var = f"_{prog_name}_COMPLETE".replace("-", "_").upper()
     print(cls(cli, {}, prog_name, complete_var).source())
-    print("# Add the following line to your shell configuration file to have aprsd command line completion")
+    print(
+        "# Add the following line to your shell configuration file to have aprsd command line completion"
+    )
     print("# but remove the leading '#' character.")
-    print(f"# eval \"$(aprsd completion {shell})\"")
+    print(f'# eval "$(aprsd completion {shell})"')

aprsd/cmds/dev.py

@@ -9,18 +9,18 @@ import click
 from oslo_config import cfg
 
 from aprsd import cli_helper, conf, packets, plugin
+
 # local imports here
 from aprsd.client import base
 from aprsd.main import cli
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
-CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+LOG = logging.getLogger('APRSD')
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
 
-@cli.group(help="Development type subcommands", context_settings=CONTEXT_SETTINGS)
+@cli.group(help='Development type subcommands', context_settings=CONTEXT_SETTINGS)
 @click.pass_context
 def dev(ctx):
     pass
@@ -29,37 +29,37 @@ def dev(ctx):
 @dev.command()
 @cli_helper.add_options(cli_helper.common_options)
 @click.option(
-    "--aprs-login",
-    envvar="APRS_LOGIN",
+    '--aprs-login',
+    envvar='APRS_LOGIN',
     show_envvar=True,
-    help="What callsign to send the message from.",
+    help='What callsign to send the message from.',
 )
 @click.option(
-    "-p",
-    "--plugin",
-    "plugin_path",
+    '-p',
+    '--plugin',
+    'plugin_path',
     show_default=True,
     default=None,
-    help="The plugin to run.  Ex: aprsd.plugins.ping.PingPlugin",
+    help='The plugin to run.  Ex: aprsd.plugins.ping.PingPlugin',
 )
 @click.option(
-    "-a",
-    "--all",
-    "load_all",
+    '-a',
+    '--all',
+    'load_all',
     show_default=True,
     is_flag=True,
     default=False,
-    help="Load all the plugins in config?",
+    help='Load all the plugins in config?',
 )
 @click.option(
-    "-n",
-    "--num",
-    "number",
+    '-n',
+    '--num',
+    'number',
     show_default=True,
     default=1,
-    help="Number of times to call the plugin",
+    help='Number of times to call the plugin',
 )
-@click.argument("message", nargs=-1, required=True)
+@click.argument('message', nargs=-1, required=True)
 @click.pass_context
 @cli_helper.process_standard_options
 def test_plugin(
@@ -76,7 +76,7 @@ def test_plugin(
 
     if not aprs_login:
         if CONF.aprs_network.login == conf.client.DEFAULT_LOGIN:
-            click.echo("Must set --aprs_login or APRS_LOGIN")
+            click.echo('Must set --aprs_login or APRS_LOGIN')
             ctx.exit(-1)
             return
         else:
@@ -86,16 +86,16 @@ def test_plugin(
 
     if not plugin_path:
         click.echo(ctx.get_help())
-        click.echo("")
-        click.echo("Failed to provide -p option to test a plugin")
+        click.echo('')
+        click.echo('Failed to provide -p option to test a plugin')
         ctx.exit(-1)
         return
 
     if type(message) is tuple:
-        message = " ".join(message)
+        message = ' '.join(message)
 
     if CONF.trace_enabled:
-        trace.setup_tracing(["method", "api"])
+        trace.setup_tracing(['method', 'api'])
 
     base.APRSClient()
 
@@ -105,14 +105,15 @@ def test_plugin(
     obj = pm._create_class(plugin_path, plugin.APRSDPluginBase)
     if not obj:
         click.echo(ctx.get_help())
-        click.echo("")
+        click.echo('')
         ctx.fail(f"Failed to create object from plugin path '{plugin_path}'")
         ctx.exit()
 
     # Register the plugin they wanted tested.
     LOG.info(
-        "Testing plugin {} Version {}".format(
-            obj.__class__, obj.version,
+        'Testing plugin {} Version {}'.format(
+            obj.__class__,
+            obj.version,
         ),
     )
     pm.register_msg(obj)
@@ -125,7 +126,7 @@ def test_plugin(
     )
     LOG.info(f"P'{plugin_path}'  F'{fromcall}'   C'{message}'")
 
-    for x in range(number):
+    for _ in range(number):
         replies = pm.run(packet)
         # Plugin might have threads, so lets stop them so we can exit.
         # obj.stop_threads()
@@ -146,17 +147,12 @@ def test_plugin(
             elif isinstance(reply, packets.Packet):
                 # We have a message based object.
                 LOG.info(reply)
-            else:
-                # A plugin can return a null message flag which signals
-                # us that they processed the message correctly, but have
-                # nothing to reply with, so we avoid replying with a
-                # usage string
-                if reply is not packets.NULL_MESSAGE:
-                    LOG.info(
-                        packets.MessagePacket(
-                            from_call=CONF.callsign,
-                            to_call=fromcall,
-                            message_text=reply,
-                        ),
-                    )
+            elif reply is not packets.NULL_MESSAGE:
+                LOG.info(
+                    packets.MessagePacket(
+                        from_call=CONF.callsign,
+                        to_call=fromcall,
+                        message_text=reply,
+                    ),
+                )
     pm.stop()