aprsd 4.1.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

aprsd/cli_helper.py

@@ -13,35 +13,35 @@ from aprsd.utils import trace
 
 CONF = cfg.CONF
 home = str(Path.home())
-DEFAULT_CONFIG_DIR = f"{home}/.config/aprsd/"
-DEFAULT_SAVE_FILE = f"{home}/.config/aprsd/aprsd.p"
-DEFAULT_CONFIG_FILE = f"{home}/.config/aprsd/aprsd.conf"
+DEFAULT_CONFIG_DIR = f'{home}/.config/aprsd/'
+DEFAULT_SAVE_FILE = f'{home}/.config/aprsd/aprsd.p'
+DEFAULT_CONFIG_FILE = f'{home}/.config/aprsd/aprsd.conf'
 
 
-F = t.TypeVar("F", bound=t.Callable[..., t.Any])
+F = t.TypeVar('F', bound=t.Callable[..., t.Any])
 
 common_options = [
     click.option(
-        "--loglevel",
-        default="INFO",
+        '--loglevel',
+        default='INFO',
         show_default=True,
         type=click.Choice(
-            ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"],
+            ['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'],
             case_sensitive=False,
         ),
         show_choices=True,
-        help="The log level to use for aprsd.log",
+        help='The log level to use for aprsd.log',
     ),
     click.option(
-        "-c",
-        "--config",
-        "config_file",
+        '-c',
+        '--config',
+        'config_file',
         show_default=True,
         default=DEFAULT_CONFIG_FILE,
-        help="The aprsd config file to use for options.",
+        help='The aprsd config file to use for options.',
     ),
     click.option(
-        "--quiet",
+        '--quiet',
         is_flag=True,
         default=False,
         help="Don't log to stdout",
@@ -59,7 +59,7 @@ class AliasedGroup(click.Group):
         """
 
         def decorator(f):
-            aliases = kwargs.pop("aliases", [])
+            aliases = kwargs.pop('aliases', [])
             cmd = click.decorators.command(*args, **kwargs)(f)
             self.add_command(cmd)
             for alias in aliases:
@@ -77,7 +77,7 @@ class AliasedGroup(click.Group):
         """
 
         def decorator(f):
-            aliases = kwargs.pop("aliases", [])
+            aliases = kwargs.pop('aliases', [])
             cmd = click.decorators.group(*args, **kwargs)(f)
             self.add_command(cmd)
             for alias in aliases:
@@ -101,36 +101,37 @@ def process_standard_options(f: F) -> F:
         ctx = args[0]
         ctx.ensure_object(dict)
         config_file_found = True
-        if kwargs["config_file"]:
-            default_config_files = [kwargs["config_file"]]
+        if kwargs['config_file']:
+            default_config_files = [kwargs['config_file']]
         else:
             default_config_files = None
+
         try:
             CONF(
                 [],
-                project="aprsd",
+                project='aprsd',
                 version=aprsd.__version__,
                 default_config_files=default_config_files,
             )
         except cfg.ConfigFilesNotFoundError:
             config_file_found = False
-        ctx.obj["loglevel"] = kwargs["loglevel"]
+        ctx.obj['loglevel'] = kwargs['loglevel']
         # ctx.obj["config_file"] = kwargs["config_file"]
-        ctx.obj["quiet"] = kwargs["quiet"]
+        ctx.obj['quiet'] = kwargs['quiet']
         log.setup_logging(
-            ctx.obj["loglevel"],
-            ctx.obj["quiet"],
+            ctx.obj['loglevel'],
+            ctx.obj['quiet'],
         )
         if CONF.trace_enabled:
-            trace.setup_tracing(["method", "api"])
+            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"]
-        del kwargs["config_file"]
-        del kwargs["quiet"]
+        del kwargs['loglevel']
+        del kwargs['config_file']
+        del kwargs['quiet']
         return f(*args, **kwargs)
 
     return update_wrapper(t.cast(F, new_func), f)
@@ -142,17 +143,17 @@ def process_standard_options_no_config(f: F) -> F:
     def new_func(*args, **kwargs):
         ctx = args[0]
         ctx.ensure_object(dict)
-        ctx.obj["loglevel"] = kwargs["loglevel"]
-        ctx.obj["config_file"] = kwargs["config_file"]
-        ctx.obj["quiet"] = kwargs["quiet"]
+        ctx.obj['loglevel'] = kwargs['loglevel']
+        ctx.obj['config_file'] = kwargs['config_file']
+        ctx.obj['quiet'] = kwargs['quiet']
         log.setup_logging(
-            ctx.obj["loglevel"],
-            ctx.obj["quiet"],
+            ctx.obj['loglevel'],
+            ctx.obj['quiet'],
         )
 
-        del kwargs["loglevel"]
-        del kwargs["config_file"]
-        del kwargs["quiet"]
+        del kwargs['loglevel']
+        del kwargs['config_file']
+        del kwargs['quiet']
         return f(*args, **kwargs)
 
     return update_wrapper(t.cast(F, new_func), f)

aprsd/client/base.py

@@ -9,7 +9,7 @@ from aprsd.packets import core
 from aprsd.utils import keepalive_collector
 
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 
 
 class APRSClient:
@@ -20,8 +20,8 @@ class APRSClient:
 
     connected = False
     login_status = {
-        "success": False,
-        "message": None,
+        'success': False,
+        'message': None,
     }
     filter = None
     lock = threading.Lock()
@@ -59,17 +59,20 @@ class APRSClient:
 
     @property
     def login_success(self):
-        return self.login_status.get("success", False)
+        return self.login_status.get('success', False)
 
     @property
     def login_failure(self):
-        return self.login_status["message"]
+        return self.login_status['message']
 
     def set_filter(self, filter):
         self.filter = filter
         if self._client:
             self._client.set_filter(filter)
 
+    def get_filter(self):
+        return self.filter
+
     @property
     def client(self):
         if not self._client:
@@ -80,16 +83,16 @@ class APRSClient:
         try:
             self._client = self.setup_connection()
             if self.filter:
-                LOG.info("Creating APRS client filter")
+                LOG.info('Creating APRS client filter')
                 self._client.set_filter(self.filter)
         except Exception as e:
-            LOG.error(f"Failed to create APRS client: {e}")
+            LOG.error(f'Failed to create APRS client: {e}')
             self._client = None
             raise
 
     def stop(self):
         if self._client:
-            LOG.info("Stopping client connection.")
+            LOG.info('Stopping client connection.')
             self._client.stop()
 
     def send(self, packet: core.Packet) -> None:
@@ -103,16 +106,16 @@ class APRSClient:
     @wrapt.synchronized(lock)
     def reset(self) -> None:
         """Call this to force a rebuild/reconnect."""
-        LOG.info("Resetting client connection.")
+        LOG.info('Resetting client connection.')
         if self._client:
             self._client.close()
             del self._client
             self._create_client()
         else:
-            LOG.warning("Client not initialized, nothing to reset.")
+            LOG.warning('Client not initialized, nothing to reset.')
 
         # Recreate the client
-        LOG.info(f"Creating new client {self.client}")
+        LOG.info(f'Creating new client {self.client}')
 
     @abc.abstractmethod
     def setup_connection(self):

aprsd/cmds/send_message.py

@@ -3,58 +3,60 @@ import sys
 import time
 
 import aprslib
-from aprslib.exceptions import LoginError
 import click
+from aprslib.exceptions import LoginError
 from oslo_config import cfg
 
 import aprsd
-from aprsd import cli_helper, packets
-from aprsd import conf  # noqa : F401
+import aprsd.packets  # noqa : F401
+from aprsd import (
+    cli_helper,
+    conf,  # noqa : F401
+    packets,
+)
 from aprsd.client import client_factory
 from aprsd.main import cli
-import aprsd.packets  # noqa : F401
 from aprsd.packets import collector
 from aprsd.packets import log as packet_log
 from aprsd.threads import tx
 
-
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 
 
 @cli.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. Defaults to config entry.",
+    help='What callsign to send the message from. Defaults to config entry.',
 )
 @click.option(
-    "--aprs-password",
-    envvar="APRS_PASSWORD",
+    '--aprs-password',
+    envvar='APRS_PASSWORD',
     show_envvar=True,
-    help="the APRS-IS password for APRS_LOGIN. Defaults to config entry.",
+    help='the APRS-IS password for APRS_LOGIN. Defaults to config entry.',
 )
 @click.option(
-    "--no-ack",
-    "-n",
+    '--no-ack',
+    '-n',
     is_flag=True,
     show_default=True,
     default=False,
     help="Don't wait for an ack, just sent it to APRS-IS and bail.",
 )
 @click.option(
-    "--wait-response",
-    "-w",
+    '--wait-response',
+    '-w',
     is_flag=True,
     show_default=True,
     default=False,
-    help="Wait for a response to the message?",
+    help='Wait for a response to the message?',
 )
-@click.option("--raw", default=None, help="Send a raw message.  Implies --no-ack")
-@click.argument("tocallsign", required=True)
-@click.argument("command", nargs=-1, required=True)
+@click.option('--raw', default=None, help='Send a raw message.  Implies --no-ack')
+@click.argument('tocallsign', required=True)
+@click.argument('command', nargs=-1, required=True)
 @click.pass_context
 @cli_helper.process_standard_options
 def send_message(
@@ -69,11 +71,11 @@ def send_message(
 ):
     """Send a message to a callsign via APRS_IS."""
     global got_ack, got_response
-    quiet = ctx.obj["quiet"]
+    quiet = ctx.obj['quiet']
 
     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:
@@ -81,15 +83,15 @@ def send_message(
 
     if not aprs_password:
         if not CONF.aprs_network.password:
-            click.echo("Must set --aprs-password or APRS_PASSWORD")
+            click.echo('Must set --aprs-password or APRS_PASSWORD')
             ctx.exit(-1)
             return
         else:
             aprs_password = CONF.aprs_network.password
 
-    LOG.info(f"APRSD LISTEN Started version: {aprsd.__version__}")
+    LOG.info(f'APRSD LISTEN Started version: {aprsd.__version__}')
     if type(command) is tuple:
-        command = " ".join(command)
+        command = ' '.join(command)
     if not quiet:
         if raw:
             LOG.info(f"L'{aprs_login}' R'{raw}'")
@@ -129,7 +131,7 @@ def send_message(
                 sys.exit(0)
 
     try:
-        client_factory.create().client
+        client_factory.create().client  # noqa: B018
     except LoginError:
         sys.exit(-1)
 
@@ -140,7 +142,7 @@ def send_message(
     # message
     if raw:
         tx.send(
-            packets.Packet(from_call="", to_call="", raw=raw),
+            packets.Packet(from_call='', to_call='', raw=raw),
             direct=True,
         )
         sys.exit(0)
@@ -164,7 +166,7 @@ def send_message(
         aprs_client = client_factory.create().client
         aprs_client.consumer(rx_packet, raw=False)
     except aprslib.exceptions.ConnectionDrop:
-        LOG.error("Connection dropped, reconnecting")
+        LOG.error('Connection dropped, reconnecting')
         time.sleep(5)
         # Force the deletion of the client object connected to aprs
         # This will cause a reconnect, next time client.get_client()

aprsd/cmds/server.py

@@ -12,59 +12,24 @@ from aprsd.client import client_factory
 from aprsd.main import cli
 from aprsd.packets import collector as packet_collector
 from aprsd.packets import seen_list
-from aprsd.threads import aprsd as aprsd_threads
-from aprsd.threads import keepalive, registry, rx, tx
+from aprsd.threads import keepalive, registry, rx, service, tx
 from aprsd.threads import stats as stats_thread
-from aprsd.utils import singleton
 
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
-
-
-@singleton
-class ServerThreads:
-    """Registry for threads that the server command runs.
-
-    This enables extensions to register a thread to run during
-    the server command.
-
-    """
-
-    def __init__(self):
-        self.threads: list[aprsd_threads.APRSDThread] = []
-
-    def register(self, thread: aprsd_threads.APRSDThread):
-        if not isinstance(thread, aprsd_threads.APRSDThread):
-            raise TypeError(f"Thread {thread} is not an APRSDThread")
-        self.threads.append(thread)
-
-    def unregister(self, thread: aprsd_threads.APRSDThread):
-        if not isinstance(thread, aprsd_threads.APRSDThread):
-            raise TypeError(f"Thread {thread} is not an APRSDThread")
-        self.threads.remove(thread)
-
-    def start(self):
-        """Start all threads in the list."""
-        for thread in self.threads:
-            thread.start()
-
-    def join(self):
-        """Join all the threads in the list"""
-        for thread in self.threads:
-            thread.join()
+LOG = logging.getLogger('APRSD')
 
 
 # main() ###
 @cli.command()
 @cli_helper.add_options(cli_helper.common_options)
 @click.option(
-    "-f",
-    "--flush",
-    "flush",
+    '-f',
+    '--flush',
+    'flush',
     is_flag=True,
     show_default=True,
     default=False,
-    help="Flush out all old aged messages on disk.",
+    help='Flush out all old aged messages on disk.',
 )
 @click.pass_context
 @cli_helper.process_standard_options
@@ -73,37 +38,37 @@ def server(ctx, flush):
     signal.signal(signal.SIGINT, aprsd_main.signal_handler)
     signal.signal(signal.SIGTERM, aprsd_main.signal_handler)
 
-    server_threads = ServerThreads()
+    service_threads = service.ServiceThreads()
 
     level, msg = utils._check_version()
     if level:
         LOG.warning(msg)
     else:
         LOG.info(msg)
-    LOG.info(f"APRSD Started version: {aprsd.__version__}")
+    LOG.info(f'APRSD Started version: {aprsd.__version__}')
 
     # Initialize the client factory and create
     # The correct client object ready for use
     if not client_factory.is_client_enabled():
-        LOG.error("No Clients are enabled in config.")
+        LOG.error('No Clients are enabled in config.')
         sys.exit(-1)
 
     # Make sure we have 1 client transport enabled
     if not client_factory.is_client_enabled():
-        LOG.error("No Clients are enabled in config.")
+        LOG.error('No Clients are enabled in config.')
         sys.exit(-1)
 
     if not client_factory.is_client_configured():
-        LOG.error("APRS client is not properly configured in config file.")
+        LOG.error('APRS client is not properly configured in config file.')
         sys.exit(-1)
 
     # Creates the client object
-    LOG.info("Creating client connection")
+    LOG.info('Creating client connection')
     aprs_client = client_factory.create()
     LOG.info(aprs_client)
     if not aprs_client.login_success:
         # We failed to login, will just quit!
-        msg = f"Login Failure: {aprs_client.login_failure}"
+        msg = f'Login Failure: {aprs_client.login_failure}'
         LOG.error(msg)
         print(msg)
         sys.exit(-1)
@@ -114,7 +79,7 @@ def server(ctx, flush):
     # We register plugins first here so we can register each
     # plugins config options, so we can dump them all in the
     # log file output.
-    LOG.info("Loading Plugin Manager and registering plugins")
+    LOG.info('Loading Plugin Manager and registering plugins')
     plugin_manager = plugin.PluginManager()
     plugin_manager.setup_plugins(load_help_plugin=CONF.load_help_plugin)
 
@@ -122,10 +87,10 @@ def server(ctx, flush):
     CONF.log_opt_values(LOG, logging.DEBUG)
     message_plugins = plugin_manager.get_message_plugins()
     watchlist_plugins = plugin_manager.get_watchlist_plugins()
-    LOG.info("Message Plugins enabled and running:")
+    LOG.info('Message Plugins enabled and running:')
     for p in message_plugins:
         LOG.info(p)
-    LOG.info("Watchlist Plugins enabled and running:")
+    LOG.info('Watchlist Plugins enabled and running:')
     for p in watchlist_plugins:
         LOG.info(p)
 
@@ -135,37 +100,37 @@ def server(ctx, flush):
 
     # Now load the msgTrack from disk if any
     if flush:
-        LOG.debug("Flushing All packet tracking objects.")
+        LOG.debug('Flushing All packet tracking objects.')
         packet_collector.PacketCollector().flush()
     else:
         # Try and load saved MsgTrack list
-        LOG.debug("Loading saved packet tracking data.")
+        LOG.debug('Loading saved packet tracking data.')
         packet_collector.PacketCollector().load()
 
     # Now start all the main processing threads.
 
-    server_threads.register(keepalive.KeepAliveThread())
-    server_threads.register(stats_thread.APRSDStatsStoreThread())
-    server_threads.register(
+    service_threads.register(keepalive.KeepAliveThread())
+    service_threads.register(stats_thread.APRSDStatsStoreThread())
+    service_threads.register(
         rx.APRSDRXThread(
             packet_queue=threads.packet_queue,
         ),
     )
-    server_threads.register(
+    service_threads.register(
         rx.APRSDPluginProcessPacketThread(
             packet_queue=threads.packet_queue,
         ),
     )
 
     if CONF.enable_beacon:
-        LOG.info("Beacon Enabled.  Starting Beacon thread.")
-        server_threads.register(tx.BeaconSendThread())
+        LOG.info('Beacon Enabled.  Starting Beacon thread.')
+        service_threads.register(tx.BeaconSendThread())
 
     if CONF.aprs_registry.enabled:
-        LOG.info("Registry Enabled.  Starting Registry thread.")
-        server_threads.register(registry.APRSRegistryThread())
+        LOG.info('Registry Enabled.  Starting Registry thread.')
+        service_threads.register(registry.APRSRegistryThread())
 
-    server_threads.start()
-    server_threads.join()
+    service_threads.start()
+    service_threads.join()
 
     return 0

aprsd/conf/log.py

@@ -54,6 +54,11 @@ logging_opts = [
         default=True,
         help='Enable ANSI color codes in logging',
     ),
+    cfg.BoolOpt(
+        'enable_console_stdout',
+        default=True,
+        help='Enable logging to the console/stdout.',
+    ),
 ]
 
 

aprsd/log/log.py

@@ -84,15 +84,18 @@ def setup_logging(loglevel=None, quiet=False):
         logging.getLogger(name).handlers = []
         logging.getLogger(name).propagate = name not in disable_list
 
-    handlers = [
-        {
-            'sink': sys.stdout,
-            'serialize': False,
-            'format': CONF.logging.logformat,
-            'colorize': CONF.logging.enable_color,
-            'level': log_level,
-        },
-    ]
+    handlers = []
+    if CONF.logging.enable_console_stdout:
+        handlers.append(
+            {
+                'sink': sys.stdout,
+                'serialize': False,
+                'format': CONF.logging.logformat,
+                'colorize': CONF.logging.enable_color,
+                'level': log_level,
+            },
+        )
+
     if CONF.logging.logfile:
         handlers.append(
             {