tradedangerous 11.5.3__py3-none-any.whl → 12.0.0__py3-none-any.whl

tradedangerous/commands/update_gui.py

@@ -1,721 +0,0 @@
-# Deprecated
-import tkinter as tk
-import tkinter.messagebox as mbox
-import sqlite3
-import re
-
-"""
-This is a crude attempt at a GUI for updating trade prices.
-It needs a lot of love to be less... Shitty.
-
-TODO:
-. Add a way to add a new line,
-. Add a way to reorder lines,
-. Add a Save button,
-. Add pre-exit validation (and don't exit if there's a problem),
-
-Thanks to Bryan Okler for solving the focus tracking issue:
-http://stackoverflow.com/questions/27055936/python3-tk-scrollbar-and-focus
-
-"""
-
-updateUiHelp = (
-"ABOUT THE EDITOR:\n"
-"The columns shown here represent the columns in the "
-"in-game Commodites Market UI and are in the same order.\n"
-"\n"
-"WHAT TO ENTER:\n"
-"Leave items blank if they are NOT listed in the game UI.\n"
-"\n"
-"'Demand' is disabled unless you use '--use-demand'.\n"
-"\n"
-"'Supply' should be:\n"
-"  '-' or '0' if no units are available,\n"
-"  empty or '?' if the level is unknown,\n"
-"  or the amount of supply followed by L, M or H.\n"
-"E.g.\n"
-"  1L, 50M, 3000H.\n"
-"\n"
-"SAVING:\n"
-"To save your data, click one of the window's close buttons.\n"
-"\n"
-"NAVIGATION:\n"
-"- Use Tab, Shift-Tab, Up/Down Arrow and Enter to navigate.\n"
-)
-
-class Item:
-    """ Describe a listed, tradeable item """
-    
-    def __init__(self, ID, catID, name, displayNo):
-        self.ID, self.catID, self.name = ID, catID, name
-        self.displayNo = displayNo
-
-
-class ScrollingCanvas(tk.Frame):
-    """
-        Tk.Canvas with scrollbar.
-    """
-    
-    def __init__(self, parent):
-        super().__init__(parent)
-        self.parent = parent
-        
-        self.canvas = canvas = tk.Canvas(self, borderwidth=0)
-        canvas.grid(row=0, column=0)
-        canvas.grid_rowconfigure(0, weight=1)
-        canvas.grid_columnconfigure(0, weight=1)
-        
-        vsb = tk.Scrollbar(parent,
-                    orient=tk.VERTICAL,
-                    command=canvas.yview)
-        vsb.grid(row=0, column=1)
-        vsb.pack(side="right", fill=tk.BOTH, expand=False)
-        
-        canvas.configure(yscrollcommand=vsb.set)
-        canvas.configure(yscrollincrement=4)
-        
-        self.interior = interior = tk.Frame(canvas)
-        canvas.create_window(0, 0, window=interior, anchor="nw", tags="interior")
-        canvas.bind("<Configure>", self.onConfigure)
-        interior.rowconfigure(0, weight=1)
-        interior.columnconfigure(0, weight=1)
-        interior.columnconfigure(1, weight=1)
-        interior.columnconfigure(2, weight=1)
-        interior.columnconfigure(3, weight=1)
-        interior.columnconfigure(4, weight=1)
-        
-        canvas.grid(row=0, column=0)
-        canvas.pack(side="left", fill=tk.BOTH, expand=True)
-        
-        self.bind_all("<MouseWheel>", self.onMouseWheel)
-        canvas.bind_all("<FocusIn>", self.scrollIntoView)
-        
-        self.pack(side="left", fill=tk.BOTH, expand=True)
-
-
-    def onConfigure(self, event):
-        """ Handle resizing """
-        
-        self.canvas.configure(scrollregion=self.interior.bbox("all"))
-
-
-    def onMouseWheel(self, event):
-        """ Translate mouse wheel inputs to scroll bar motions """
-        
-        self.canvas.yview_scroll(int(-1 * (event.delta/4)), "units")
-
-
-    def scrollIntoView(self, event):
-        """ Scroll so that a given widget is in focus """
-        
-        canvas = self.canvas
-        widget_top = event.widget.winfo_y()
-        widget_bottom = widget_top + event.widget.winfo_height()
-        canvas_top = canvas.canvasy(0)
-        canvas_bottom = canvas_top + canvas.winfo_height()
-        
-        if widget_bottom >= canvas_bottom:
-            delta = int(canvas_bottom - widget_bottom)
-            canvas.yview_scroll(-delta, "units")
-        elif widget_top < canvas_top:
-            delta = int(widget_top - canvas_top)
-            canvas.yview_scroll(delta, "units")
-
-
-class UpdateGUI(ScrollingCanvas):
-    """
-        Implements a tk canvas which displays an editor
-        for TradeDangerous Price Updates
-    """
-    
-    def __init__(self, parent, tdb, tdenv):
-        super().__init__(parent)
-        
-        width = tdenv.width or 640
-        height = tdenv.height or 640
-        sticky = 1 if tdenv.alwaysOnTop else 0
-        
-        self.tdb = tdb
-        self.tdenv = tdenv
-        
-        self.rowNo = 0
-        self.colNo = 0
-        self.items = {}
-        self.categories = []
-        self.itemList = []
-        self.itemDisplays = []
-        self.results = None
-        self.headings = []
-        
-        self.createWidgets()
-        
-        self.focusOn(0, 0)
-        
-        parent.geometry("{}x{}{:+n}{:+n}".format(
-                    width+16, height,
-                    tdenv.windowX,
-                    tdenv.windowY,
-                ))
-        
-        # Allow the window to be always-on-top
-        parent.wm_attributes("-topmost", sticky)
-
-
-    def selectWidget(self, widget, newValue=None):
-        if newValue is not None:
-            widget.val.set(newValue)
-        widget.focus_set()
-        widget.selection_range(0, tk.END)
-
-
-    def focusOn(self, displayNo, pos):
-        """ Set focus to a widget and select the text in it """
-        
-        row = self.itemDisplays[displayNo]
-        widget = row[pos][0]
-        self.selectWidget(widget)
-
-
-    def setValue(self, row, pos, value):
-        row[pos][1].set(value)
-        return value
-
-
-    def getValue(self, row, pos):
-        return row[pos][1].get()
-
-
-    def validateRow(self, row):
-        paying = row[0][1].get()
-        if not paying or paying == "0":
-            paying = ""
-            for col in row:
-                col[1].set("")
-            row[1][0].configure(state=tk.DISABLED)
-            row[2][0].configure(state=tk.DISABLED)
-        else:
-            row[1][0].configure(state=tk.NORMAL)
-            if self.tdenv.useDemand:
-                row[2][0].configure(state=tk.NORMAL)
-            else:
-                row[2][0].configure(state=tk.DISABLED)
-                row[2][1].set("")
-        
-        asking = row[1][1].get()
-        if asking == "0":
-            row[1][1].set("")
-            asking = ""
-        if not asking:
-            row[3][0].configure(state=tk.DISABLED)
-            row[3][1].set("")
-        else:
-            row[3][0].configure(state=tk.NORMAL)
-            if not row[3][1].get():
-                row[3][1].set("?")
-
-
-    def checkValueAgainstStats(self, widget, stats):
-        widget.configure(bg = 'white')
-        minCr, avgCr, maxCr = stats
-        if not avgCr:
-            return True
-        
-        cr = int(widget.val.get())
-        
-        if cr < int(minCr / 1.01) and cr < int(avgCr * 0.7):
-            widget.bell()
-            ok = mbox.askokcancel(
-                    "Very low price",
-                    "The price you entered is very low.\n"
-                    "\n"
-                    "Your input was: {}\n"
-                    "Previous low..: {}\n"
-                    "\n"
-                    "Is it correct?".format(
-                        cr, minCr,
-            ))
-            if not ok:
-                self.selectWidget(widget, "")
-                return False
-            widget.configure(bg = '#ff8080')
-        
-        if cr >= (maxCr * 1.01) and int(cr * 0.7) > avgCr:
-            widget.bell()
-            ok = mbox.askokcancel(
-                    "Very high price",
-                    "The price you entered is very high.\n"
-                    "\n"
-                    "Your input was..: {}\n"
-                    "Previous highest: {}\n"
-                    "\n"
-                    "Is it correct?".format(
-                        cr, maxCr,
-            ))
-            if not ok:
-                self.selectWidget(widget, "")
-                return False
-            widget.configure(bg = '#8080ff')
-        
-        return True
-
-
-    def validate(self, widget):
-        """ For checking the contents of a widget. """
-        item, row, pos = widget.item, widget.row, widget.pos
-        
-        value = widget.val.get()
-        re.sub(" +", "", value)
-        re.sub(",", "", value)
-        widget.val.set(value)
-        
-        self.validateRow(row)
-        
-        if pos == 0:
-            if not value or value == "0":
-                widget.val.set("")
-                return True
-            
-            if not re.match(r'^\d+$', value):
-                mbox.showerror(
-                        "Invalid Paying price",
-                        "Price must be an numeric value (e.g. 1234)"
-                        )
-                return False
-            
-            # is it lower than the value?
-            demandStats = self.demandStats[item.ID]
-            if not self.checkValueAgainstStats(widget, demandStats):
-                return False
-        
-        if pos <= 1:
-            if not value or value == "0":
-                widget.val.set("")
-                return True
-            
-            if not re.match(r'^\d+$', value):
-                mbox.showerror(
-                        "Invalid Paying price",
-                        "Price must be an numeric value (e.g. 1234)"
-                        )
-                return False
-        
-        if pos == 1:
-            # Don't allow crazy difference between prices
-            paying = int(row[0][1].get())
-            asking = int(row[1][1].get())
-            
-            if asking < paying:
-                widget.bell()
-                mbox.showerror(
-                        "I DOUBT THAT!",
-                        "Stations never pay more for an item than "
-                        "they sell it for.",
-                        )
-                return False
-            
-            supplyStats = self.supplyStats[item.ID]
-            if not self.checkValueAgainstStats(widget, supplyStats):
-                return False
-            
-            # https://forums.frontier.co.uk/showthread.php?t=34986&p=1162429&viewfull=1#post1162429
-            # It seems that stations usually pay within 25% of the
-            # asking price as a buy-back price. If the user gives
-            # us something out of those bounds, check with them.
-            if paying < int(asking * 0.70) or \
-                    paying < asking - 250:
-                widget.bell()
-                ok = mbox.askokcancel(
-                        "Are you sure about that?",
-                        "You've indicated that the station is:\n"
-                        "  PAYING: {:>10n}cr\n"
-                        "  ASKING: {:>10n}cr\n"
-                        "for {}.\n"
-                        "\n"
-                        "This is outside of expected tolerances, "
-                        "please check the numbers.\n"
-                        "\n"
-                        "If the numbers are correct, click OK and "
-                        "please post a screenshot of the market UI "
-                        "to the TD thread "
-                        "(http://kfs.org/td/thread)."
-                        .format(
-                                paying, asking,
-                                widget.item.name
-                                ),
-                        default=mbox.CANCEL,
-                        parent=widget,
-                        )
-                if not ok:
-                    self.selectWidget(widget, "")
-                    return False
-            
-            return True
-        
-        if pos == 3:
-            value = widget.val.get()
-            if value == "0":
-                value = "-"
-            if value == "":
-                value = "?"
-            re.sub(",", "", value)
-            widget.val.set(value)
-            if re.match(r'^(-|\?|\d+[LlMmHh\?])$', value):
-                return True
-            mbox.showerror(
-                        "Invalid supply value",
-                        "If the item is in-supply, this field should "
-                        "be the number of units followed by one of 'L', "
-                        "'M' or 'H'.\n"
-                        "\n"
-                        "If the item is out-of-supply, use '-' or '0'.\n"
-                        "\n"
-                        "EXAMPLE: If the UI says '2341 LOW', type '2341L'.\n"
-                    )
-            widget.val.set("?")
-            self.selectWidget(widget)
-            return False
-        
-        return True
-
-
-    def onShiftTab(self, event):
-        """ Process user pressing Shift+TAB """
-        
-        widget = event.widget
-        if not self.validate(widget):
-            return "break"
-        if widget.pos > 0 or widget.item.displayNo > 0:
-            # Natural flow
-            return
-        
-        self.parent.bell()
-        return "break"
-
-
-    def onTab(self, event):
-        """ Process user pressing TAB """
-        
-        widget = event.widget
-        if not self.validate(widget):
-            return "break"
-        if widget.pos + 1 < len(widget.row):
-            return
-        if widget.item.displayNo + 1 < len(self.itemDisplays):
-            return
-        self.parent.bell()
-        return "break"
-
-
-    def onReturn(self, event):
-        """
-            When the user hits <Return>, advance to
-            the first cell on the next line, or if
-            we are at the bottom of the list, beep.
-        """
-        
-        widget = event.widget
-        if not self.validate(widget):
-            return "break"
-        # advance to the first entry on the next row
-        newDisplayNo = widget.item.displayNo + 1
-        if newDisplayNo >= len(self.itemDisplays):
-            self.parent.bell()
-            return "break"
-        
-        self.focusOn(newDisplayNo, 0)
-
-
-    def onUp(self, event):
-        """ Handle the user pressing up, go up a row """
-        
-        widget = event.widget
-        if not self.validate(widget):
-            return "break"
-        # can we go up a line?
-        if widget.item.displayNo <= 0:
-            self.parent.bell()
-            return "break"
-        
-        self.focusOn(widget.item.displayNo - 1, widget.pos)
-
-
-    def onDown(self, event):
-        """ Handle the user pressing down, go down a row """
-        
-        widget = event.widget
-        if not self.validate(widget):
-            return "break"
-        # can we go up a line?
-        newDisplayNo = widget.item.displayNo + 1
-        if newDisplayNo >= len(self.itemDisplays):
-            self.parent.bell()
-            return "break"
-        
-        self.focusOn(newDisplayNo, widget.pos)
-
-
-    def endRow(self):
-        self.rowNo += 1
-        self.colNo = 0
-
-
-    def addWidget(self, widget, **kwargs):
-        widget.grid(row=self.rowNo, column=self.colNo, **kwargs)
-        self.colNo += 1
-        return widget
-
-
-    def addLabel(self, text):
-        lab = tk.Label(self.interior, text=text)
-        return self.addWidget(lab, sticky='W', padx=16)
-
-
-    def addSection(self, text):
-        widget = tk.Label(self.interior, text=text, fg='blue')
-        widget.grid(row=self.rowNo, column=0, columnspan=5, sticky='W')
-        self.endRow()
-        return widget
-
-
-    def addInput(self, item, defValue, row):
-        pos = len(row)
-        
-        inputVal = tk.StringVar()
-        inputVal.set(str(defValue))
-        
-        inputEl = tk.Entry(self.interior,
-                width=10,
-                justify=tk.RIGHT,
-                textvariable=inputVal)
-        inputEl.item = item
-        inputEl.row = row
-        inputEl.pos = pos
-        inputEl.val = inputVal
-        
-        inputEl.bind('<Shift-Key-Tab>', self.onShiftTab)
-        inputEl.bind('<Key-Tab>', self.onTab)
-        inputEl.bind('<Key-Return>', self.onReturn)
-        inputEl.bind('<Key-Down>', self.onDown)
-        inputEl.bind('<Key-Up>', self.onUp)
-        inputEl.bind('<FocusOut>', lambda evt: self.validateRow(evt.widget.row))
-        self.addWidget(inputEl, sticky='E')
-        row.append((inputEl, inputVal))
-
-
-    def addHeadings(self):
-        def addHeading(text):
-            self.headings.append(text)
-            lab = tk.Label(self.interior, text=text, fg='blue')
-            self.addWidget(lab, sticky='W', padx=16)
-        addHeading("Item")
-        addHeading("Paying")
-        addHeading("Asking")
-        addHeading("Demand")
-        addHeading("Supply")
-        addHeading("AvgPay")
-        addHeading("AvgAsk")
-        self.endRow()
-
-
-    def addItemRow(self, ID, catID, itemName, paying, asking, demand, supply):
-        row = []
-        
-        displayNo = len(self.itemDisplays)
-        item = Item(ID, catID, itemName, displayNo)
-        self.items[itemName] = item
-        self.itemList.append(item)
-        
-        demandStats = self.demandStats[item.ID]
-        supplyStats = self.supplyStats[item.ID]
-        
-        self.addLabel(item.name.upper())
-        self.addInput(item, paying, row)
-        self.addInput(item, asking, row)
-        self.addInput(item, demand, row)
-        self.addInput(item, supply, row)
-        self.addLabel(demandStats[1])
-        self.addLabel(supplyStats[1])
-        
-        self.itemDisplays.append(row)
-        
-        self.endRow()
-
-
-    def createWidgets(self):
-        self.addHeadings()
-        
-        tdb, tdenv = self.tdb, self.tdenv
-        station = tdenv.startStation
-        self.parent.title(station.name())
-        
-        db = tdb.getDB()
-        db.row_factory = sqlite3.Row
-        cur = db.cursor()
-        
-        self.categories = self.tdb.categoryByID
-        
-        # Do we have entries for this station?
-        cur.execute("""
-            SELECT  COUNT(*)
-              FROM  StationItem
-             WHERE  station_id = ?
-        """, [station.ID])
-        self.newStation = False if int(cur.fetchone()[0]) else True
-        
-        cur.execute("""
-            SELECT  item.item_id,
-                    IFNULL(MIN(demand_price), 0),
-                    IFNULL(AVG(demand_price), 0),
-                    IFNULL(MAX(demand_price), 0)
-              FROM  Item
-                    LEFT OUTER JOIN StationItem AS si
-                        ON (
-                            item.item_id = si.item_id
-                            AND si.demand_price > 0
-                        )
-             GROUP  BY 1
-        """)
-        self.demandStats = {
-            ID: [ minCr, int(avgCr), maxCr ]
-            for ID, minCr, avgCr, maxCr in cur
-        }
-        cur.execute("""
-            SELECT  item.item_id,
-                    IFNULL(MIN(supply_price), 0),
-                    IFNULL(AVG(supply_price), 0),
-                    IFNULL(MAX(supply_price), 0)
-              FROM  Item
-                    LEFT OUTER JOIN StationItem AS si
-                        ON (
-                            item.item_id = si.item_id
-                            AND si.supply_price > 0
-                        )
-             GROUP  BY 1
-        """)
-        self.supplyStats = {
-            ID: [ minCr, int(avgCr), maxCr ]
-            for ID, minCr, avgCr, maxCr in cur
-        }
-        
-        if self.newStation and not tdenv.all:
-            def splashScreen():
-                mbox.showinfo(
-                        "New Station!",
-                        "There is currently no price data for this station "
-                        "in the database!\n\n" + updateUiHelp,
-                        parent=self,
-                        )
-                self.itemDisplays[0][0][0].focus_set()
-            self.parent.after(750, splashScreen)
-        
-        # if the user specified "--all", force listing of all items
-        fetchAll = (self.newStation or tdenv.all)
-        siJoin = "LEFT OUTER" if fetchAll else "INNER"
-        stmt = """
-            SELECT  item.category_id AS catID,
-                    item.item_id AS ID,
-                    item.name AS name,
-                    IFNULL(si.demand_price, '') AS paying,
-                    IFNULL(si.supply_price, '') AS asking,
-                    IFNULL(si.demand_units, 0) AS demandUnits,
-                    IFNULL(si.demand_level, 0) AS demandLevel,
-                    IFNULL(si.supply_units, 0) AS supplyUnits,
-                    IFNULL(si.supply_level, 0) AS supplyLevel
-              FROM  (
-                        Category AS cat
-                            INNER JOIN Item item
-                                USING (category_id)
-                    ) {siJoin} JOIN
-                        StationItem si ON (
-                            si.item_id = item.item_id AND si.station_id = ?
-                        )
-             ORDER  BY cat.name, item.ui_order
-        """.format(siJoin=siJoin)
-        tdenv.DEBUG1("sql: {}; bind: {}", stmt, station.ID)
-        cur.execute(stmt, [station.ID])
-        
-        def describeSupply(units, level):
-            if not level:
-                return ""
-            if units == -1 and level == -1:
-                return "?"
-            if level == -1:
-                return "{}?".format(units)
-            return "{}{}".format(units, ['L', 'M', 'H'][level-1])
-        
-        lastCat = None
-        for row in cur:
-            cat = row["catID"]
-            if cat != lastCat:
-                self.addSection(self.categories[cat].name())
-                lastCat = cat
-            itemName = row["name"]
-            paying, asking = row["paying"], row["asking"]
-            demand = describeSupply(row["demandUnits"], row["demandLevel"])
-            supply = describeSupply(row["supplyUnits"], row["supplyLevel"])
-            self.addItemRow(row["ID"], cat, itemName, paying, asking, demand, supply)
-
-
-        for row in self.itemDisplays:
-            self.validateRow(row)
-
-
-    def getResults(self):
-        lastCat = None
-        
-        txt = (
-                "# Generated by TDGUI\n"
-                "\n"
-                "@ {stn}\n".format(
-                    stn=self.tdenv.startStation.name(),
-                )
-            )
-        for item in self.itemList:
-            if item.catID != lastCat:
-                lastCat = item.catID
-                txt += (" + {}\n".format(self.categories[lastCat].dbname))
-            
-            row = self.itemDisplays[item.displayNo]
-            rowvals = [ val[1].get() for val in row ]
-            
-            itemName = item.name
-            paying = int(rowvals[0] or 0)
-            asking = int(rowvals[1] or 0)
-            demand = rowvals[2]
-            supply = rowvals[3]
-            
-            if not paying and not asking:
-                demand, supply = "-", "-"
-            else:
-                if paying and not demand:
-                    demand = "?"
-                
-                if asking == 0:
-                    supply = "-"
-                elif not supply:
-                    supply = "?"
-                elif re.match(r"^\d+$", supply):
-                    if int(supply) != 0:
-                        supply += '?'
-            
-            txt += ("     {item:<30s} "
-                    "{paying:>10} "
-                    "{asking:>10} "
-                    "{demand:>10} "
-                    "{supply:>10}\n".format(
-                        item=itemName,
-                        paying=paying,
-                        asking=asking,
-                        demand=demand,
-                        supply=supply
-                        ))
-        self.results = txt
-
-
-def render(tdb, tdenv, tmpPath):
-    parent = tk.Tk()
-    gui = UpdateGUI(parent, tdb, tdenv)
-    gui.mainloop()
-    gui.getResults()
-    with tmpPath.open("w", encoding="utf-8") as fh:
-        print(gui.results, file=fh)