First Pass Logic Audit

.gitignore

@@ -1,8 +1,18 @@
+# Ignore version file
 .gitversion
+
+# Ignore macOS DS_Store files
 .DS_Store
+
+# Ignore build artifacts
 build
-ChangeLog.html
+dist.win32/
 dist.*
+
+# Ignore generated ChangeLog.html file
+ChangeLog.html
+
+# Ignore files
 dump
 *.bak
 *.pyc
@@ -11,20 +21,36 @@ dump
 *.pdb
 *.msi
 *.wixobj
+*.zip
+
+# Ignore Update Things
 EDMarketConnector_Installer_*.exe
 appcast_win_*.xml
 appcast_mac_*.xml
-EDMarketConnector.VisualElementsManifest.xml
-*.zip
 EDMC_Installer_Config.iss
+EDMarketConnector.wxs
+wix/components.wxs
 
+# Ignore Visual Elements Manifest file for Windows
+EDMarketConnector.VisualElementsManifest.xml
+
+# Ignore IDE and editor configuration files
 .idea
 .vscode
+
+# Ignore virtual environments
 .venv/
 venv/
+
+# Ignore workspace file for Visual Studio Code
 *.code-workspace
+
+# Ignore coverage reports
 htmlcov/
 .ignored
 .coverage
-EDMarketConnector.wxs
-wix/components.wxs
+pylintrc
+pylint.txt
+
+# Ignore Submodule data directory
+coriolis-data/

EDMC.py

@@ -1,19 +1,22 @@
-#!/usr/bin/env python3
-"""Command-line interface. Requires prior setup through the GUI."""
-
+"""
+EDMC.py - Command-line interface. Requires prior setup through the GUI.
 
+Copyright (c) EDCD, All Rights Reserved
+Licensed under the GNU General Public License.
+See LICENSE file.
+"""
 import argparse
 import json
 import locale
 import os
 import queue
 import sys
 from os.path import getmtime
+from pathlib import Path
 from time import sleep, time
-from typing import TYPE_CHECKING, Any, List, Optional
+from typing import TYPE_CHECKING, Any, List, Optional, Union
 
 # isort: off
-
 os.environ["EDMC_NO_UI"] = "1"
 
 # See EDMCLogging.py docs.
@@ -25,7 +28,6 @@
 edmclogger.set_channels_loglevel(logging.INFO)
 
 # isort: on
-
 import collate
 import commodity
 import companion
@@ -60,7 +62,6 @@ def log_locale(prefix: str) -> None:
 
 
 l10n.Translations.install_dummy()
-
 SERVER_RETRY = 5  # retry pause for Companion servers [s]
 EXIT_SUCCESS, EXIT_SERVER, EXIT_CREDENTIALS, EXIT_VERIFICATION, EXIT_LAGGING, EXIT_SYS_ERR, EXIT_ARGS, \
     EXIT_JOURNAL_READ_ERR, EXIT_COMMANDER_UNKNOWN = range(9)
@@ -71,12 +72,11 @@ def versioncmp(versionstring) -> List:
     return list(map(int, versionstring.split('.')))
 
 
-def deep_get(target: dict | companion.CAPIData, *args: str, default=None) -> Any:
+def deep_get(target: Union[dict, companion.CAPIData], *args: str, default=None) -> Any:
     """
     Walk into a dict and return the specified deep value.
 
     Example usage:
-
         >>> thing = {'a': {'b': {'c': 'foo'} } }
         >>> deep_get(thing, ('a', 'b', 'c'), None)
         'foo'
@@ -98,9 +98,7 @@ def deep_get(target: dict | companion.CAPIData, *args: str, default=None) -> Any
         res = current.get(arg)
         if res is None:
             return default
-
         current = res
-
     return current
 
 
@@ -155,7 +153,7 @@ def main():  # noqa: C901, CCR001
         args = parser.parse_args()
 
         if args.version:
-            updater = Updater(provider='internal')
+            updater = Updater()
             newversion: Optional[EDMCVersion] = updater.check_appcast()
             if newversion:
                 print(f'{appversion()} ({newversion.title!r} is available)')
@@ -204,13 +202,16 @@ def main():  # noqa: C901, CCR001
             # Import and collate from JSON dump
             #
             # Try twice, once with the system locale and once enforcing utf-8. If the file was made on the current
-            # system, chances are its the current locale, and not utf-8. Otherwise if it was copied, its probably
+            # system, chances are it's the current locale, and not utf-8. Otherwise, if it was copied, its probably
             # utf8. Either way, try the system FIRST because reading something like cp1251 in UTF-8 results in garbage
             # but the reverse results in an exception.
+            json_file = Path(args.j)
             try:
-                data = json.load(open(args.j))
+                with open(json_file) as file_handle:
+                    data = json.load(file_handle)
             except UnicodeDecodeError:
-                data = json.load(open(args.j, encoding='utf-8'))
+                with open(json_file, encoding='utf-8') as file_handle:
+                    data = json.load(file_handle)
 
             config.set('querytime', int(getmtime(args.j)))
 
@@ -293,8 +294,7 @@ def main():  # noqa: C901, CCR001
                 if capi_response.exception:
                     raise capi_response.exception
 
-                else:
-                    raise ValueError(capi_response.message)
+                raise ValueError(capi_response.message)
 
             logger.trace_if('capi.worker', 'Answer is not a Failure')
             if not isinstance(capi_response, companion.EDMCCAPIResponse):
@@ -366,17 +366,17 @@ def main():  # noqa: C901, CCR001
         else:
             print(deep_get(data, 'lastSystem', 'name', default='Unknown'))
 
-        if (args.m or args.o or args.s or args.n or args.j):
+        if args.m or args.o or args.s or args.n or args.j:
             if not data['commander'].get('docked'):
                 logger.error("Can't use -m, -o, -s, -n or -j because you're not currently docked!")
                 return
 
-            elif not deep_get(data, 'lastStarport', 'name'):
+            if not deep_get(data, 'lastStarport', 'name'):
                 logger.error("No data['lastStarport']['name'] from CAPI")
                 sys.exit(EXIT_LAGGING)
 
             # Ignore possibly missing shipyard info
-            elif not (data['lastStarport'].get('commodities') or data['lastStarport'].get('modules')):
+            if not (data['lastStarport'].get('commodities') or data['lastStarport'].get('modules')):
                 logger.error("No commodities or outfitting (modules) in CAPI data")
                 return
 
@@ -462,14 +462,14 @@ def main():  # noqa: C901, CCR001
             except Exception:
                 logger.exception('Failed to send data to EDDN')
 
-    except companion.ServerError:
-        logger.exception('Frontier CAPI Server returned an error')
-        sys.exit(EXIT_SERVER)
-
     except companion.ServerConnectionError:
         logger.exception('Exception while contacting server')
         sys.exit(EXIT_SERVER)
 
+    except companion.ServerError:
+        logger.exception('Frontier CAPI Server returned an error')
+        sys.exit(EXIT_SERVER)
+
     except companion.CredentialsError:
         logger.error('Frontier CAPI Server: Invalid Credentials')
         sys.exit(EXIT_CREDENTIALS)

EDMCLogging.py

@@ -34,7 +34,6 @@
     # See, plug.py:load_plugins()
     logger = logging.getLogger(f'{appname}.{plugin_name}')
 """
-
 import inspect
 import logging
 import logging.handlers
@@ -48,7 +47,7 @@
 from threading import get_native_id as thread_native_id
 from time import gmtime
 from traceback import print_exc
-from typing import TYPE_CHECKING, Tuple, cast
+from typing import TYPE_CHECKING, Tuple, cast, Union
 
 import config as config_mod
 from config import appcmdname, appname, config
@@ -145,7 +144,7 @@ class Logger:
     logging.Logger instance.
     """
 
-    def __init__(self, logger_name: str, loglevel: int | str = _default_loglevel):
+    def __init__(self, logger_name: str, loglevel: Union[int, str] = _default_loglevel):
         """
         Set up a `logging.Logger` with our preferred configuration.
 
@@ -183,18 +182,12 @@ def __init__(self, logger_name: str, loglevel: int | str = _default_loglevel):
         # rotated versions.
         # This is {logger_name} so that EDMC.py logs to a different file.
         logfile_rotating = pathlib.Path(tempfile.gettempdir())
-        logfile_rotating = logfile_rotating / f'{appname}'
+        logfile_rotating /= f'{appname}'
         logfile_rotating.mkdir(exist_ok=True)
-        logfile_rotating = logfile_rotating / f'{logger_name}-debug.log'
-
-        self.logger_channel_rotating = logging.handlers.RotatingFileHandler(
-            logfile_rotating,
-            mode='a',
-            maxBytes=1024 * 1024,  # 1MiB
-            backupCount=10,
-            encoding='utf-8',
-            delay=False
-        )
+        logfile_rotating /= f'{logger_name}-debug.log'
+
+        self.logger_channel_rotating = logging.handlers.RotatingFileHandler(logfile_rotating, maxBytes=1024 * 1024,
+                                                                            backupCount=10, encoding='utf-8')
         # Yes, we always want these rotated files to be at TRACE level
         self.logger_channel_rotating.setLevel(logging.TRACE)  # type: ignore
         self.logger_channel_rotating.setFormatter(self.logger_formatter)
@@ -216,7 +209,7 @@ def get_streamhandler(self) -> logging.Handler:
         """
         return self.logger_channel
 
-    def set_channels_loglevel(self, level: int | str) -> None:
+    def set_channels_loglevel(self, level: Union[int, str]) -> None:
         """
         Set the specified log level on the channels.
 
@@ -226,7 +219,7 @@ def set_channels_loglevel(self, level: int | str) -> None:
         self.logger_channel.setLevel(level)
         self.logger_channel_rotating.setLevel(level)
 
-    def set_console_loglevel(self, level: int | str) -> None:
+    def set_console_loglevel(self, level: Union[int, str]) -> None:
         """
         Set the specified log level on the console channel.
 
@@ -535,13 +528,12 @@ def get_main_logger(sublogger_name: str = '') -> 'LoggerMixin':
     if not os.getenv("EDMC_NO_UI"):
         # GUI app being run
         return cast('LoggerMixin', logging.getLogger(appname))
-    else:
-        # Must be the CLI
-        return cast('LoggerMixin', logging.getLogger(appcmdname))
+    # Must be the CLI
+    return cast('LoggerMixin', logging.getLogger(appcmdname))
 
 
 # Singleton
-loglevel: str | int = config.get_str('loglevel')
+loglevel: Union[str, int] = config.get_str('loglevel')
 if not loglevel:
     loglevel = logging.INFO