tradedangerous 10.17.0__py3-none-any.whl → 11.0.1__py3-none-any.whl

tradedangerous/formatting.py

@@ -1,13 +1,22 @@
-from __future__ import absolute_import, with_statement, print_function, division, unicode_literals
+"""
+Provides a library of mechanisms for formatting output text to ensure consistency across
+TradeDangerous and plugin tools,
+"""
+from __future__ import annotations
+
 import itertools
+import typing
+
+if typing.TYPE_CHECKING:
+    from typing import Any, Callable, Optional
 
-class ColumnFormat(object):
+class ColumnFormat:
     """
         Describes formatting of a column to be populated with data.
         
         Member Functions:
             
-            str()
+            text()
                 Applies all formatting (except qualifier) to the name to
                 produce a correctly sized title field.
             
@@ -47,7 +56,7 @@ class ColumnFormat(object):
             ]
             rows = [ {'name':'Bob', 'dist':1.5}, {'name':'John', 'dist':23}]
             # print titles
-            print(*[col.str() for col in cols])
+            print(*[col.text() for col in cols])
             for row in rows:
                 print(*[col.format(row) for col in cols])
         Produces:
@@ -56,6 +65,15 @@ class ColumnFormat(object):
             John   [23.00]
     
     """
+    name:       str                 # name of the column
+    align:      str                 # format's alignment specifier
+    width:      int                 # width specifier
+    qualifier:  Optional[str]       # optional format type specifier e.g. '.2f', 's', 'n'
+    pre:        Optional[str]       # prefix to the column
+    post:       Optional[str]       # postfix to the column
+    key:        Callable            # function to retrieve the printable name of the item
+    pred:       Callable            # predicate: return False to leave this column blank
+    
     def __init__(
             self,
             name,
@@ -66,7 +84,7 @@ class ColumnFormat(object):
             post=None,
             key=lambda item: item,
             pred=lambda item: True,
-            ):
+            ) -> None:
         self.name = name
         self.align = align
         self.width = max(int(width), len(name))
@@ -76,29 +94,17 @@ class ColumnFormat(object):
         self.post = post or ''
         self.pred = pred
     
-    def str(self):
-        return '{pre}{title:{align}{width}}{post}'.format(
-                title=self.name,
-                align=self.align, width=self.width,
-                pre=self.pre, post=self.post,
-            )
-    
-    def format(self, value):
-        if self.pred(value):
-            return '{pre}{value:{align}{width}{qual}}{post}'.format(
-                    value=self.key(value),
-                    align=self.align, width=self.width,
-                    qual=self.qualifier,
-                    pre=self.pre, post=self.post,
-                )
-        else:
-            return '{pre}{value:{align}{width}}{post}'.format(
-                value="",
-                align=self.align, width=self.width,
-                pre=self.pre, post=self.post,
-            )
+    def __str__(self) -> str:
+        return f'{self.pre}{self.name:{self.align}{self.width}}{self.post}'
+    text = __str__
+    
+    def format(self, value: str) -> str:
+        """ Returns the string formatted with a specific value"""
+        if not self.pred(value):
+            return f'{self.pre}{"":{self.align}{self.width}}{self.post}'
+        return f'{self.pre}{self.key(value):{self.align}{self.width}{self.qualifier}}{self.post}'
 
-class RowFormat(object):
+class RowFormat:
     """
         Describes an ordered collection of ColumnFormats
         for dispay data from rows, such that calling
@@ -117,7 +123,7 @@ class RowFormat(object):
             insert(pos, newCol)
                 Inserts a ColumnFormatter at position pos in the list
             
-            str()
+            text()
                 Returns a list of all the column headings
             
             format(rowData):
@@ -125,14 +131,17 @@ class RowFormat(object):
                 of the columns
     
     """
-    def __init__(self, prefix=None):
+    columns:        list[ColumnFormat]
+    prefix:         str
+    
+    def __init__(self, prefix: Optional[str] = None):
         self.columns = []
         self.prefix = prefix or ""
     
-    def addColumn(self, *args, **kwargs):
+    def addColumn(self, *args, **kwargs) -> None:
         self.append(ColumnFormat(*args, **kwargs))
     
-    def append(self, column, after=None):
+    def append(self, column: ColumnFormat, after: Optional[str] = None) -> 'RowFormat':
         columns = self.columns
         if after:
             for idx, col in enumerate(columns, 1):
@@ -142,19 +151,22 @@ class RowFormat(object):
         columns.append(column)
         return self
     
-    def insert(self, pos, column):
+    def insert(self, pos: int, column: Optional[ColumnFormat]) -> None:
         if column is not None:
             self.columns.insert(pos, column)
     
-    def str(self):
-        return self.prefix + ' '.join(col.str() for col in self.columns)
+    def __str__(self) -> str:
+        return f"{self.prefix} {' '.join(str(col) for col in self.columns)}"
+    
+    text = __str__  # alias
     
-    def heading(self):
-        headline = self.str()
+    def heading(self) -> tuple[str, str]:
+        """ Returns a title and the appropriate underline for that text. """
+        headline = f"{self}"
         return headline, '-' * len(headline)
     
-    def format(self, rowData):
-        return self.prefix + ' '.join(col.format(rowData) for col in self.columns)
+    def format(self, row_data: Optional[Any]) -> str:
+        return f"{self.prefix} {' '.join(col.format(row_data) for col in self.columns)}"
 
 def max_len(iterable, key=lambda item: item):
     iterable, readahead = itertools.tee(iter(iterable))
@@ -164,6 +176,7 @@ def max_len(iterable, key=lambda item: item):
         return 0
     return max(len(key(item)) for item in iterable)
 
+
 if __name__ == '__main__':
     rowFmt = RowFormat(). \
                 append(ColumnFormat("Name", '<', '8', key=lambda row: row['name'])). \
@@ -175,7 +188,7 @@ if __name__ == '__main__':
     ]
     
     def present():
-        rowTitle = rowFmt.str()
+        rowTitle = rowFmt.text()
         print(rowTitle)
         print('-' * len(rowTitle))
         for row in rows:
@@ -188,4 +201,4 @@ if __name__ == '__main__':
     print("Adding age ColumnFormat:")
     
     rowFmt.append(after='Name', col=ColumnFormat("Age", '>', 3, pre='|', post='|', key=lambda row: row['age']))
-    present()
+    present()

tradedangerous/fs.py

@@ -1,7 +1,7 @@
 """This module should handle filesystem related operations
 """
 from shutil import copy as shcopy
-from os import makedirs, path, utime
+from os import makedirs
 from pathlib import Path
 
 __all__ = ['copy', 'copyallfiles', 'touch', 'ensurefolder']
@@ -25,7 +25,7 @@ def copy(src, dst):
 
 def copy_if_newer(src, dst):
     """
-    copy src to dst if src is newer 
+    copy src to dst if src is newer
     takes string or Path object as input
     returns Path(dst) on success
     returns Path(src) if not newer
@@ -33,11 +33,11 @@ def copy_if_newer(src, dst):
     """
     srcPath = pathify(src).resolve()
     dstPath = pathify(dst)
-    if dstPath.exists() and not (dstPath.stat().st_mtime < srcPath.stat().st_mtime):
+    if dstPath.exists() and dstPath.stat().st_mtime >= srcPath.stat().st_mtime:
         return srcPath
-    else:
-        shcopy(str(srcPath), str(dstPath))
-        return dstPath
+
+    shcopy(str(srcPath), str(dstPath))
+    return dstPath
 
 def copyallfiles(srcdir, dstdir):
     """

tradedangerous/gui.py

@@ -31,12 +31,6 @@
 # individual always-on-top for every window
 # Data retrieval from CMDR's journal
 
-from __future__ import absolute_import
-from __future__ import with_statement
-from __future__ import print_function
-from __future__ import division
-from __future__ import unicode_literals
-from pkg_resources import resource_filename
 import os
 import sys
 import traceback
@@ -47,7 +41,6 @@ from pathlib import Path
 from appJar import gui
 import appJar
 
-
 # from tkinter import *
 # import tkinter.font as font
 # import tkinter.scrolledtext as scrolledtext
@@ -60,8 +53,6 @@ from .version import __version__
 
 from . import tradedb
 from .plugins import PluginException
-from pycparser.ply.yacc import MAXINT
-from pkg_resources import _sset_none
 
 # ==================
 # BEGIN appJar fixes
@@ -96,8 +87,9 @@ def setSpinBoxPos(self, title, pos, callFunction = True):
     vals = self._getSpinBoxValsAsList(vals)
     pos = int(pos)
     if pos < 0 or pos >= len(vals):
-        raise Exception("Invalid position: " + str(pos) + ". No position in SpinBox: " + 
-                    title + "=" + str(vals))
+        raise RuntimeError(
+            f"Invalid position: {pos}. No position in SpinBox: {title}={vals}"
+        )
     #    pos = len(vals) - 1 - pos
     val = vals[pos]
     self._setSpinBoxVal(spin, val, callFunction)
@@ -140,10 +132,10 @@ def _configOptionBoxList(self, title, options, kind):
     # get the longest string length
     try:
         maxSize = len(str(max(options, key = len)))
-    except:
+    except:  # noqa: E722
         try:
             maxSize = len(str(max(options)))
-        except:
+        except:  # noqa: E722
             maxSize = 0
     
     # increase if ticks
@@ -220,9 +212,9 @@ def changeCWD():
     """
     Opens a folder select dialog for choosing the current working directory.
     """
-    cwd = filedialog.askdirectory(title = "Select the top-level folder for TD to work in...", 
+    cwd = filedialog.askdirectory(title = "Select the top-level folder for TD to work in...",
                                   initialdir = argVals['--cwd'])
-    #cwd = win.directoryBox("Select the top-level folder for TD to work in...", dirName = argVals['--cwd'])
+    # cwd = win.directoryBox("Select the top-level folder for TD to work in...", dirName = argVals['--cwd'])
     if cwd:
         argVals['--cwd'] = str(Path(cwd))
     widgets['cwd']['text'] = argVals['--cwd']
@@ -231,13 +223,14 @@ def changeDB():
     """
     Opens a file select dialog for choosing the database file.
     """
-    db = filedialog.askopenfilename(title = "Select the TD database file to use...", 
+    db = filedialog.askopenfilename(title = "Select the TD database file to use...",
                                     initialdir = str(Path(argVals['--db']).parent),
                                     filetypes = [('Data Base File', '*.db')])
     if db:
         argVals['--db'] = str(Path(db))
     widgets['db']['text'] = argVals['--db']        
 
+
 # A dict of all arguments in TD (mostly auto-generated)
 # Manually add the global arguments for now, maybe figure out how to auto-populate them as well.
 allArgs = {
@@ -300,16 +293,16 @@ def buildArgDicts():
                 # print(arg.args[0])
                 argVals[arg.args[0]] = arg.kwargs.get('default') or None
                 
-                allArgs[cmd]['req'][arg.args[0]] = {kwarg : arg.kwargs[kwarg] for kwarg in arg.kwargs}
+                allArgs[cmd]['req'][arg.args[0]] = {kwarg: arg.kwargs[kwarg] for kwarg in arg.kwargs}
                 allArgs[cmd]['req'][arg.args[0]]['widget'] = chooseType(arg)
         # print(allArgs[cmd]['req'])
         
         if index.switches:
             for arg in index.switches:
                 try:
-                    argVals[arg.args[0]] = value = arg.kwargs.get('default') or None
+                    argVals[arg.args[0]] = arg.kwargs.get('default') or None
                     
-                    allArgs[cmd]['opt'][arg.args[0]] = {kwarg : arg.kwargs[kwarg] for kwarg in arg.kwargs}
+                    allArgs[cmd]['opt'][arg.args[0]] = {kwarg: arg.kwargs[kwarg] for kwarg in arg.kwargs}
                     allArgs[cmd]['opt'][arg.args[0]]['widget'] = chooseType(arg)
                     
                     if arg.args[0] == '--option':
@@ -324,51 +317,49 @@ def buildArgDicts():
                 
                 except AttributeError:
                     for argGrp in arg.arguments:
-                        argVals[argGrp.args[0]] = value = argGrp.kwargs.get('default') or None
+                        argVals[argGrp.args[0]] = argGrp.kwargs.get('default') or None
                         
-                        allArgs[cmd]['opt'][argGrp.args[0]] = {kwarg : argGrp.kwargs[kwarg] for kwarg in argGrp.kwargs}
+                        allArgs[cmd]['opt'][argGrp.args[0]] = {kwarg: argGrp.kwargs[kwarg] for kwarg in argGrp.kwargs}
                         allArgs[cmd]['opt'][argGrp.args[0]]['widget'] = chooseType(argGrp)
                         
                         allArgs[cmd]['opt'][argGrp.args[0]]['excludes'] = [excl.args[0] for excl in arg.arguments 
                                                                    if excl.args[0] != argGrp.args[0]]
                         if argGrp.args[0] == '--plug':
                             # Currently only the 'import' cmd has the '--plug' option,
-                            # but this could no longer be the case in future.
+                            # but this could no longer be the case in the future.
                             if cmd == 'import':
                                 allArgs[cmd]['opt'][argGrp.args[0]]['plugins'] = importPlugs
-        # print(allArgs[cmd]['opt'])
-    # print(allArgs)
-    # print(argVals)
+
 
 def optWindow():
     """
     Opens a window listing all of the options for the currently selected plugin.
     """
     # with win.subWindow("Plugin Options", modal = True) as sw:
-        # win.emptyCurrentContainer()
-        # optDict = {}
-        # if argVals['--option']:
-            # for option in enumerate(argVals['--option'].split(',')):
-                # if '=' in option[1]:
-                    # optDict[option[1].split('=')[0]] = option[1].split('=')[1]
-                # else:
-                    # if option[1] != '':
-                        # optDict[option[1]] = True
-        # # print(optDict)
-        # if not win.combo('--plug'):
-            # win.message('No import plugin chosen.', width = 170, colspan = 10)
-        # else:
-            # plugOpts = allArgs['import']['opt']['--option']['options'][win.combo('--plug')]
-            # for option in plugOpts:
-                # # print(option + ': ' + plugOpts[option])
-                # if '=' in plugOpts[option]:
-                    # win.entry(option, optDict.get(option) or '', label = True, sticky = 'ew', colspan = 10, tooltip = plugOpts[option])
-                # else:
-                    # win.check(option, optDict.get(option) or False, sticky = 'ew', colspan = 10, tooltip = plugOpts[option])
-            # # print(plugOpts)
-        # win.button("Done", setOpts, column = 8)
-        # win.button("Cancel", sw.hide, row = 'p', column = 9)
-        # sw.show()
+    #     win.emptyCurrentContainer()
+    #     optDict = {}
+    #     if argVals['--option']:
+    #         for option in enumerate(argVals['--option'].split(',')):
+    #             if '=' in option[1]:
+    #                 optDict[option[1].split('=')[0]] = option[1].split('=')[1]
+    #             else:
+    #                 if option[1] != '':
+    #                     optDict[option[1]] = True
+    #     # print(optDict)
+    #     if not win.combo('--plug'):
+    #         win.message('No import plugin chosen.', width = 170, colspan = 10)
+    #     else:
+    #         plugOpts = allArgs['import']['opt']['--option']['options'][win.combo('--plug')]
+    #         for option in plugOpts:
+    #             # print(option + ': ' + plugOpts[option])
+    #             if '=' in plugOpts[option]:
+    #                 win.entry(option, optDict.get(option) or '', label = True, sticky = 'ew', colspan = 10, tooltip = plugOpts[option])
+    #             else:
+    #                 win.check(option, optDict.get(option) or False, sticky = 'ew', colspan = 10, tooltip = plugOpts[option])
+    #         # print(plugOpts)
+    #     win.button("Done", setOpts, column = 8)
+    #     win.button("Cancel", sw.hide, row = 'p', column = 9)
+    #     sw.show()
 
 def chooseType(arg):
     """
@@ -637,7 +628,7 @@ def updateCommandBox(args = None):
 # Setup the CLI interface and build the main window
 def main(argv = None):
     
-    class IORedirector(object):
+    class IORedirector:
         
         def __init__(self, TEXT_INFO):
             self.TEXT_INFO = TEXT_INFO
@@ -672,7 +663,7 @@ def main(argv = None):
             argStr = argStr.rsplit(',', 1)[0]
             win.entry('--option', argStr)
         sw.hide()
-
+    
     #TODO: Implement in tk
     def optionsWin():
         """
@@ -703,7 +694,7 @@ def main(argv = None):
             win.button("Done", setOpts, column = 8)
             win.button("Cancel", sw.hide, row = 'p', column = 9)
             sw.show()
-
+    
     #TODO: Implement in tk
     def updArgs(name):
         """
@@ -749,7 +740,7 @@ def main(argv = None):
                     win.setEntry(exclude, '', callFunction = False)
                 elif widgetType == 'check':
                     win.check(exclude, False, callFunction = False)
-
+    
     #TODO: REMOVE
     def updCmd():
         """
@@ -774,7 +765,7 @@ def main(argv = None):
                 win.label('Optional:', sticky = 'w')
                 for key in allArgs[cmd]['opt']:
                     makeWidgets(key, allArgs[cmd]['opt'][key])
-
+    
     def runTD():
         """
         Executes the TD command selected in the GUI.
@@ -881,7 +872,7 @@ def main(argv = None):
         
         win.message('outputText', '')
         threading.Thread(target = runTrade, name = "TDThread", daemon = True).start()
-
+    
     # TODO: replace
     def makeWidgets(name, arg, sticky = 'ew', label = True, **kwargs):
         kwargs['sticky'] = sticky
@@ -961,7 +952,7 @@ def main(argv = None):
     
     
     buildArgDicts()
-    
+
 #    window = Tk()
 #    window.title('Trade Dangerous GUI (Beta), TD v.%s' % (__version__,))
 #    window.iconbitmap(resource_filename(__name__, "../tradedangerouscrest.ico"))
@@ -1007,23 +998,23 @@ def main(argv = None):
                   stretch = 'none', sticky = 'ew', width = 10, row = 0, column = 0, colspan = 5)
         with win.scrollPane('req', disabled = 'horizontal', row = 1, column = 0, colspan = 10) as pane:
             pane.configure(width = 200, height = 75)
-            
+        
         with win.scrollPane('opt', disabled = 'horizontal', row = 2, column = 0, colspan = 10) as pane:
             pane.configure(width = 200, height = 345)
-            
+        
         with win.tabbedFrame('tabFrame', disabled = 'horizontal', row = 1, column = 10, rowspan = 2, colspan = 40) as tabFrame:
             with win.tab('Help'):
                 with win.scrollPane('helpPane', disabled = 'horizontal') as pane:
                     pane.configure(width = 560, height = 420)
                     win.message('helpText', cmdHelp['help'])
                     win.widgetManager.get(WIDGET_NAMES.Message, 'helpText').config(width = 560)
-                    
+            
             with win.tab('Output'):
                 with win.scrollPane('outPane', disabled = 'horizontal') as pane:
                     pane.configure(width = 560, height = 420)
                     win.message('outputText', '')
                     win.widgetManager.get(WIDGET_NAMES.Message, 'outputText').config(width = 560)
-                    
+        
         makeWidgets('--link-ly', allArgs['--link-ly'], sticky = 'w', width = 4, row = 3, column = 2)
         
         makeWidgets('--quiet', allArgs['--quiet'], sticky = 'e', disabled = ':', width = 1, row = 3, column = 46)
@@ -1034,12 +1025,12 @@ def main(argv = None):
         
         win.button('Run', runTD, tooltip = 'Execute the selected command.',
                    sticky = 'w', row = 3, column = 49)
-                   
+        
         makeWidgets('--cwd', allArgs['--cwd'], width = 4, row = 4, column = 0)
         with win.scrollPane('CWD', disabled = 'vertical', row = 4, column = 1, colspan = 49) as pane:
             pane.configure(width = 500, height = 20)
             widgets['cwd'] = win.label('cwd', argVals['--cwd'], sticky = 'w')
-            
+        
         makeWidgets('--db', allArgs['--db'], width = 4, row = 5, column = 0)
         with win.scrollPane('DB', disabled = 'vertical', row = 5, column = 1, colspan = 49) as pane:
             pane.configure(width = 500, height = 20)

tradedangerous/jsonprices.py

@@ -24,7 +24,7 @@ def lookup_system(tdb, tdenv, name, x, y, z):
             pass
     
     if system:
-        if (system.posX != x or system.posY != y or system.posZ != z):
+        if system.posX != x or system.posY != y or system.posZ != z:
             raise Exception("System {} position mismatch: "
                     "Got {},{},{} expected {},{},{}".format(
                         name,
@@ -33,16 +33,9 @@ def lookup_system(tdb, tdenv, name, x, y, z):
             ))
         return system
     
-    newSystem = "@{} [{}, {}, {}]".format(
-            name, x, y, z
-    )
-    
     candidates = []
     for candidate in tdb.systemByID.values():
-        if (candidate.posX == x and
-                candidate.posY == y and
-                candidate.posZ == z
-                ):
+        if candidate.posX == x and candidate.posY == y and candidate.posZ == z:
             candidates.append(candidate)
     
     if len(candidates) == 1:
@@ -61,10 +54,9 @@ def lookup_system(tdb, tdenv, name, x, y, z):
                 ))
         return candidates[0]
     
-    if len(candidates):
-        raise Exception("System {} matches co-ordinates for systems: {}" +
-                ','.join([system.name for system in candidates])
-                )
+    if candidates:
+        options = ', '.join([s.name for s in candidates])
+        raise RuntimeError(f"System {system.name} matches co-ordinates for systems: {options}")
     
     if tdenv.addUnknown:
         return tdb.addLocalSystem(name, x, y, z)
@@ -91,7 +83,7 @@ def lookup_station(
     
     # Now set the parameters
     tdb.updateLocalStation(
-            stn, lsFromStar, blackMarket, maxPadSize
+            station, lsFromStar, blackMarket, maxPadSize
     )
     return station
 
@@ -116,7 +108,7 @@ def load_prices_json(
     
     try:
         blackMarket = stnData['bm'].upper()
-        if not blackMarket in [ 'Y', 'N' ]:
+        if blackMarket not in [ 'Y', 'N' ]:
             blackMarket = '?'
     except KeyError:
         blackMarket = '?'
@@ -137,7 +129,7 @@ def load_prices_json(
         return
     if system.dbname != sysName and tdenv.detail:
         print("NOTE: Treating '{}' as '{}'".format(
-                name, system.dbname
+                sysName, system.dbname
         ))
     tdenv.DEBUG1("- System: {}", system.dbname)
     

tradedangerous/mapping.py

@@ -2,7 +2,7 @@
 # Mapping class for FDEV-IDs to TD names
 #
 
-class FDEVMappingBase(object):
+class FDEVMappingBase:
     """
     Base class to map FDEV-IDs to TD names, do not use directly.
     
@@ -67,7 +67,8 @@ class FDEVMappingBase(object):
             else:
                 entries[ID] = {}
                 for i, val in enumerate(line[1:], start=1):
-                    if val: entries[ID][self.colNames[i]] = val
+                    if val:
+                        entries[ID][self.colNames[i]] = val
             self.tdenv.DEBUG2("{}: {}".format(ID, str(entries[ID]).replace("{", "{{").replace("}", "}}")))
         self.entries = entries
         self.tdenv.DEBUG1("Loaded {:n} {}-Mappings".format(len(entries), self.tableName))
@@ -126,6 +127,6 @@ class FDEVMappingOutfitting(FDEVMappingBase):
         Maps ID to EDDN outfitting
     """
     tableName = "FDevOutfitting"
-    colNames  = [ 'id', 'category' , 'name', 'mount',
+    colNames  = [ 'id', 'category', 'name', 'mount',
                   'guidance', 'ship', 'class', 'rating'
                 ]

tradedangerous/mfd/__init__.py

@@ -2,13 +2,11 @@
 #  You are free to use, redistribute, or even print and eat a copy of
 #  this software so long as you include this copyright notice.
 #  I guarantee there is at least one bug neither of us knew about.
-#---------------------------------------------------------------------
+# ---------------------------------------------------------------------
 # TradeDangerous :: Modules :: Multi-function display wrapper
 #
 #   Multi-Function Display wrappers
 
-from __future__ import absolute_import, with_statement, print_function, division, unicode_literals
-
 ######################################################################
 # imports
 
@@ -28,7 +26,7 @@ class MissingDeviceError(Exception):
 ######################################################################
 # classes
 
-class DummyMFD(object):
+class DummyMFD:
     """
         Base class for the MFD drivers, implemented as no-ops so that
         you can always use all MFD functions without conditionals.

tradedangerous/mfd/saitek/__init__.py

@@ -1,4 +1,3 @@
 # Saitek MFD wrappers
 
 __all__ = [ "DirectOutput", "X52Pro" ]
-