diff --git a/README.md b/README.md
index dab803f..f474088 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ PySpy was born out of frustration over the *death* of [Pirate's Little Helper](h
a great [EVE Online](https://www.eveonline.com/) third-party tool for gathering useful information on character names from the in-game *local chat* window.
PySpy connects to [CCP's ESI API](https://esi.evetech.net/ui/) and the
-[zKillboard API](https://github.com/zKillboard/zKillboard/wiki) and is available on Windows and macOS.
+[zKillboard API](https://github.com/zKillboard/zKillboard/wiki) and is available on Windows, macOS and Linux.
## How to use PySpy
@@ -28,26 +28,33 @@ PySpy connects to [CCP's ESI API](https://esi.evetech.net/ui/) and the
3. Wait until PySpy is done and inspect the results.
4. Double-click a name to open the respective zKillboard in your browser.
-**Note**: PySpy will save its window location, size, column sizes and transparency (slider on bottom right) and any other settings automatically and restore them the next time you launch it. PySpy will stay on top of the EVE client so long as the game runs in *window mode*.
+**Note**: PySpy will save its window location, size, column sizes, sorting order and transparency (slider on bottom right) and any other settings automatically and restore them the next time you launch it. If selected in the _View Menu_, PySpy will stay on top of the EVE client so long as the game runs in *window mode*.
## Information Provided by PySpy
+### New Dark Mode
- 
+ 
+
+
+### Traditional Normal Mode
+
+ 
* **Character**: Character name.
+* **Security**: Concord security status.
* **Corporation**: Corporation of character.
* **Alliance**: Alliance of character's Corporation, if any.
* **Faction**: Faction of character, if any.
+* **Kills**: Total number of kills.
+* **Losses**: Total number of losses.
* **Last Wk**: Number of kills over past 7 days.
-* **K**: Total number of kills.
-* **B**: Number of Black Ops Battleships (BLOPS) killed.
-* **H**: Number of lost Heavy Interdiction Cruisers (HIC).
+* **Solo**: Ratio of solo kills over total kills.
+* **BLOPS**: Number of Black Ops Battleships (BLOPS) killed.
+* **HICs**: Number of lost Heavy Interdiction Cruisers (HIC).
-**Note**: Characters that have killed BLOPS or have lost HICs are high-lighted *orange*. This can now be changed in the *View* menu.
-
-**Current Limitations**: To avoid undue strain on zKillboard's API, PySpy will run the *Last Wk* and *K-B-H* analyses only for the first 30 characters in the list.
+**Current Limitations**: To avoid undue strain on zKillboard's API, PySpy will run the *Kills*, *Losses*, *Last Wk*, *Solo*, *BLOPS* and *HICs* analyses only for the first 30 characters in the list.
## Installation
@@ -55,7 +62,9 @@ You can download the latest release for your operating system [here](https://git
PySpy comes as a single-file executable both in Windows and macOS. On both platforms, you can run PySpy from any folder location you like.
-**Note**: PySpy automatically checks for updates on launch.
+On Linux, you can run PySpy like any other Python3 script. PySpy was developed on Python 3.6.5 but should run on any other Python3 version, so long as you install the required packages listed in [requirements.txt](https://github.com/WhiteRusssian/PySpy/blob/master/requirements.txt).
+
+**Note**: PySpy automatically checks for updates on launch and will notify you if a new version is available.
## Uninstalling PySpy
@@ -63,13 +72,18 @@ Delete the PySpy executable and remove the following files manually:
* **Windows**: PySpy saves preference and log files in a folder called `PySpy` located at `%LocalAppData%`.
* **macOS**: PySpy creates `pyspy.log` under `~/Library/Logs` and `pyspy.cfg` as well as `pyspy.pickle` under `~/Library/Preferences`.
+* **Linux**: PySpy creates `pyspy.log` under `~/Library/Logs` and `pyspy.cfg` as well as `pyspy.pickle` under `~/.config/pyspy`.
## Future Features
Below is a non-exhaustive list of additional features I plan to add to PySpy as and when the ESI and zKillboard APIs support them:
-* **Standings**: Only show characters that are non-blue, i.e. neutral or hostile.
* **Cynos**: Indicate if a character has in the past lost ships fitted with regular or covert cynos. I am currently putting together the underlying database of killmails and expect to add this feature in August.
+* **Average Attackers**: Average number of attackers across all kills a character has been involved in.
+* **Abyssal Losses**: Show number of losses in abyssal sites.
+* **Custom Highlighting**: Choose a list of characters, corproations or alliances to highlight.
+* **Standings**: Only show characters that are non-blue, i.e. neutral or hostile.
+* **Highlight New Pilots**: Highlight any pilots that have entered system since last PySpy run.
* **Improved GUI**: The current GUI is very basic and while it works, I do appreciate that it is not ideal for people who cannot use it on a second screen but actually have to overlay it on-top of their EVE client.
Please feel free to add a [feature request](https://github.com/WhiteRusssian/PySpy/issues/new?template=pyspy-feature-request.md) for any improvements you would like to see in future releases.
@@ -94,3 +108,7 @@ PySpy is licensed under the [MIT](LICENSE.txt) License.
## CCP Copyright Notice
EVE Online and the EVE logo are the registered trademarks of CCP hf. All rights are reserved worldwide. All other trademarks are the property of their respective owners. EVE Online, the EVE logo, EVE and all associated logos and designs are the intellectual property of CCP hf. All artwork, screenshots, characters, vehicles, storylines, world facts or other recognizable features of the intellectual property relating to these trademarks are likewise the intellectual property of CCP hf. CCP is in no way responsible for the content on or functioning of this website, nor can it be liable for any damage arising from the use of this website.
+
+## Collection of Usage Statistics
+
+To help improve PySpy further, PySpy reports usage statistics comprising certain anonymous information such as the number of characters analysed, duration of each analysis, operating system, version of PySpy, and any active GUI features. For full disclosure, a randomly generated identifier is being sent with each data set to allow me to track how many people are actually using PySpy over any given period. If you would like to see for yourself what is being collected, have a look at the source code of module `reportstats.py`.
\ No newline at end of file
diff --git a/VERSION b/VERSION
index e2cfc99..174a3d5 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-v0.2
\ No newline at end of file
+v0.3
\ No newline at end of file
diff --git a/__main__.py b/__main__.py
index 0010207..1ec0926 100644
--- a/__main__.py
+++ b/__main__.py
@@ -60,13 +60,19 @@ def check_name_validity(char_name):
def analyze_chars(char_names):
start_time = time.time()
- wx.CallAfter(app.PySpy.list.DeleteAllItems)
+ wx.CallAfter(app.PySpy.grid.ClearGrid)
try:
outlist = analyze.main(char_names)
duration = round(time.time() - start_time, 1)
reportstats.ReportStats(outlist, duration).start()
if outlist is not None:
- wx.CallAfter(app.PySpy.updateList, outlist, duration)
+ # Need to use keyword args as sortOutlist can also get called
+ # by event handler which would pass event object as first argument.
+ wx.CallAfter(
+ app.PySpy.sortOutlist,
+ outlist=outlist,
+ duration=duration
+ )
else:
statusmsg.push_status(
"No valid character names found. Please try again..."
diff --git a/aboutdialog.py b/aboutdialog.py
index 51d6dee..6cd1b91 100755
--- a/aboutdialog.py
+++ b/aboutdialog.py
@@ -21,7 +21,7 @@
# Example call: Logger.info("Something badhappened", exc_info=True) ****
-def OnAboutBox(e):
+def showAboutBox(parent, event=None):
# __main__.app.PySpy.ToggleWindowStyle(wx.STAY_ON_TOP)
description = """
@@ -43,7 +43,7 @@ def OnAboutBox(e):
info = wx.adv.AboutDialogInfo()
info.SetIcon(wx.Icon(config.ABOUT_ICON, wx.BITMAP_TYPE_PNG))
- info.SetName('PySpy')
+ info.SetName("AboutDialog")
info.SetVersion(config.CURRENT_VER)
info.SetDescription(description)
info.SetCopyright('(C) 2018 White Russsian')
@@ -51,5 +51,3 @@ def OnAboutBox(e):
info.SetLicence(license)
wx.adv.AboutBox(info)
-
- # __main__.app.PySpy.SetWindowStyle(wx.STAY_ON_TOP)
diff --git a/analyze.py b/analyze.py
index 26a10e9..8f03033 100644
--- a/analyze.py
+++ b/analyze.py
@@ -40,7 +40,7 @@ def main(char_names):
zkill_stats = q_main.get()
query_string = (
'''UPDATE characters SET kills=?, blops_kills=?, hic_losses=?,
- week_kills=?
+ week_kills=?, losses=?, solo_ratio=?, sec_status=?
WHERE char_id=?'''
)
db.write_many_to_db(conn, cur, query_string, zkill_stats)
@@ -160,8 +160,14 @@ def run(self):
blops_kills = str(s[1])
hic_losses = str(s[2])
week_kills = str(s[3])
- id = str(s[4])
- zkill_stats.append([kills, blops_kills, hic_losses, week_kills, id])
+ losses = str(s[4])
+ solo_ratio = str(s[5])
+ sec_status = str(s[6])
+ id = str(s[7])
+ zkill_stats.append([
+ kills, blops_kills, hic_losses, week_kills, losses, solo_ratio,
+ sec_status, id
+ ])
self._q_main.put(zkill_stats)
return
@@ -169,8 +175,9 @@ def run(self):
def output_list(cur):
query_string = (
'''SELECT
- ch.char_id, ch.faction_id, ch.char_name, co.name, al.name, fa.name,
- ac.numid, ch.week_kills, ch.kills, ch.blops_kills, hic_losses
+ ch.char_id, ch.faction_id, ch.char_name, co.id, co.name, al.id,
+ al.name, fa.name, ac.numid, ch.week_kills, ch.kills, ch.blops_kills,
+ ch.hic_losses, ch.losses, ch.solo_ratio, ch.sec_status
FROM characters AS ch
LEFT JOIN alliances AS al ON ch.alliance_id = al.id
LEFT JOIN corporations AS co ON ch.corp_id = co.id
diff --git a/apis.py b/apis.py
index 205fad5..17d0c0c 100644
--- a/apis.py
+++ b/apis.py
@@ -95,31 +95,51 @@ def run(self):
hic_losses = 0
self._queue.put([kills, blops_kills, self._char_id])
return
+
try:
- # Number of total kills of this toon.
+ # Number of total kills
kills = r["shipsDestroyed"]
- except KeyError:
+ except (KeyError, TypeError):
kills = 0
try:
- # Number of BLOPS killed by this toon.
+ # Number of BLOPS killed
blops_kills = r["groups"]["898"]["shipsDestroyed"]
- except KeyError:
+ except (KeyError, TypeError):
blops_kills = 0
try:
- # Number of HICs lost by this toon.
+ # Number of HICs lost
hic_losses = r["groups"]["894"]["shipsLost"]
- except KeyError:
+ except (KeyError, TypeError):
hic_losses = 0
try:
# Kills over past 7 days
week_kills = r["activepvp"]["kills"]["count"]
- except KeyError:
+ except (KeyError, TypeError):
week_kills = 0
+ try:
+ # Number of total losses
+ losses = r["shipsLost"]
+ except (KeyError, TypeError):
+ losses = 0
+
+ try:
+ # Ratio of solo kills to total kills
+ solo_ratio = int(r["soloKills"]) / int(r["shipsDestroyed"])
+ except (KeyError, TypeError):
+ solo_ratio = 0
+
+ try:
+ # Security status
+ sec_status = r["info"]["secStatus"]
+ except (KeyError, TypeError):
+ sec_status = 0
+
self._queue.put(
- [kills, blops_kills, hic_losses, week_kills, self._char_id]
+ [kills, blops_kills, hic_losses, week_kills, losses, solo_ratio,
+ sec_status, self._char_id]
)
return
diff --git a/assets/v0.3_dark_screenshot.png b/assets/v0.3_dark_screenshot.png
new file mode 100644
index 0000000..94c1c0b
Binary files /dev/null and b/assets/v0.3_dark_screenshot.png differ
diff --git a/assets/v0.3_light_screenshot.png b/assets/v0.3_light_screenshot.png
new file mode 100644
index 0000000..d0c92dc
Binary files /dev/null and b/assets/v0.3_light_screenshot.png differ
diff --git a/config.py b/config.py
index 103e77d..ebcf10e 100644
--- a/config.py
+++ b/config.py
@@ -7,15 +7,17 @@
import logging.config
import logging
import os
+import platform
import sys
import uuid
import requests
+import wx # required for colour codes in DARK_MODE
import optstore
# cSpell Checker - Correct Words****************************************
# // cSpell:words MEIPASS, datefmt, russsian, pyinstaller, posix, pyspy
-# // cSpell:words zkill, amarr, caldari, gallente, minmatar
+# // cSpell:words zkill, amarr, caldari, gallente, minmatar, isfile
# **********************************************************************
Logger = logging.getLogger(__name__)
# Example call: Logger.info("Something badhappened", exc_info=True) ****
@@ -52,7 +54,10 @@ def resource_path(relative_path):
elif __file__:
ABOUT_ICON = resource_path("assets/pyspy_mid.png")
application_path = os.path.dirname(__file__)
- PREF_PATH = os.path.join(application_path, "tmp")
+ if platform.system() == "Linux":
+ PREF_PATH = os.path.expanduser("~/.config/pyspy")
+ else:
+ PREF_PATH = os.path.join(application_path, "tmp")
if not os.path.exists(PREF_PATH):
os.makedirs(PREF_PATH)
LOG_PATH = PREF_PATH
@@ -72,7 +77,7 @@ def resource_path(relative_path):
with open(resource_path('VERSION'), 'r') as ver_file:
CURRENT_VER = ver_file.read().replace('\n', '')
-# Clean up old GUI_CFG_FILES
+# Clean up old GUI_CFG_FILES and OPTIONS_OBJECT keys
if os.path.isfile(GUI_CFG_FILE) and not os.path.isfile(OPTIONS_FILE):
try:
os.remove(GUI_CFG_FILE)
@@ -83,16 +88,46 @@ def resource_path(relative_path):
os.remove(GUI_CFG_FILE)
except:
pass
+ for key in OPTIONS_OBJECT.ListKeys():
+ if key != "uuid":
+ OPTIONS_OBJECT.Del(key)
# Unique identifier for usage statistics reporting
if OPTIONS_OBJECT.Get("uuid", "not set") == "not set":
OPTIONS_OBJECT.Set("uuid", str(uuid.uuid4()))
+# Store version information
+OPTIONS_OBJECT.Set("version", CURRENT_VER)
+
# Various constants
MAX_NAMES = 500 # The max number of char names to be processed
ZKILL_DELAY = 0.05 # API rate limit is 10/second, pushing it a little...
-ZKILL_CALLS = 30
+ZKILL_CALLS = 40
GUI_TITLE = "PySpy " + CURRENT_VER
+FONT_SCALE_MIN = 7 # 7 equates to 70%
+FONT_SCALE_MAX = 13
+
+
+# Colour Scheme
+DARK_MODE = {
+ "BG": wx.Colour(0, 0, 0),
+ "TXT": wx.Colour(166, 105, 33),
+ "LNE": wx.Colour(15, 15, 15),
+ "LBL": wx.Colour(160, 160, 160),
+ "HL1": wx.Colour(187, 55, 46),
+ "HL2": wx.Colour(38, 104, 166),
+ "HL3": wx.Colour(30, 30, 30)
+ }
+
+NORMAL_MODE = {
+ "BG": wx.Colour(-1, -1, -1),
+ "TXT": wx.Colour(45, 45, 45),
+ "LNE": wx.Colour(240, 240, 240),
+ "LBL": wx.Colour(32, 32, 32),
+ "HL1": wx.Colour(187, 55, 46),
+ "HL2": wx.Colour(0, 170, 0),
+ "HL3": wx.Colour(0, 0, 170)
+ }
# Note, Amarr and Caldari are allied and have IDs ending on uneven integers.
# Likewise, Gallente and Minmatar, also allied, have even IDs.
diff --git a/db.py b/db.py
index 063f7d3..91d2e88 100644
--- a/db.py
+++ b/db.py
@@ -17,8 +17,11 @@
def connect_db():
- '''Create in memory database
- @returns: connection and curser objects as conn and cur'''
+ '''
+ Create in memory database
+
+ @returns: connection and curser objects as conn and cur
+ '''
conn = sqlite3.connect(":memory:")
conn.isolation_level = None
cur = conn.cursor()
@@ -28,13 +31,16 @@ def connect_db():
def prepare_tables(conn, cur):
- '''Create a few tables, unless they already exist. Do not close the
+ '''
+ Create a few tables, unless they already exist. Do not close the
connection as it will continue to be used by the calling
- function.'''
+ function.
+ '''
cur.execute(
'''CREATE TABLE IF NOT EXISTS characters (char_name TEXT, char_id INT,
corp_id INT, alliance_id INT, faction_id INT, kills INT,
- blops_kills INT, hic_losses INT, week_kills INT)'''
+ blops_kills INT, hic_losses INT, week_kills INT, losses INT,
+ solo_ratio NUMERIC, sec_status NUMERIC)'''
)
cur.execute(
'''CREATE TABLE IF NOT EXISTS corporations (id INT, name TEXT)'''
@@ -45,18 +51,22 @@ def prepare_tables(conn, cur):
cur.execute(
'''CREATE TABLE IF NOT EXISTS factions (id INT, name TEXT)'''
)
+ # Populate this table with the 4 faction warfare factions
cur.executemany(
'''INSERT INTO factions (id, name) VALUES (?, ?)''',
config.FACTION_IDS
- )
+ )
conn.commit()
def write_many_to_db(conn, cur, query_string, records, keepalive=True):
- '''Take a database connection and write records to it. Afterwards,
+ '''
+ Take a database connection and write records to it. Afterwards,
leave the connection alive, unless keepalive=False and return the
number of records added to the database.
- @returns: records_added'''
+
+ @returns: records_added
+ '''
try:
cur.executemany(query_string, records)
conn.commit()
diff --git a/gui.py b/gui.py
index 5450aca..39a31e2 100644
--- a/gui.py
+++ b/gui.py
@@ -11,15 +11,18 @@
import webbrowser
import wx
+import wx.grid as WXG
import wx.lib.agw.persist as pm
import aboutdialog
import config
+import ignoredialog
+import sortarray
import statusmsg
# cSpell Checker - Correct Words****************************************
# // cSpell:words wrusssian, wxpython, HRULES, VRULES, ELLIPSIZE, zkill,
# // cSpell:words blops, Unregister, russsian, chkversion, posix,
-# // cSpell:words Gallente, Minmatar, Amarr, Caldari, ontop
+# // cSpell:words Gallente, Minmatar, Amarr, Caldari, ontop, hics
# **********************************************************************
Logger = logging.getLogger(__name__)
# Example call: Logger.info("Something badhappened", exc_info=True) ****
@@ -31,28 +34,51 @@ def __init__(self, *args, **kwds):
# Persistent Options
self.options = config.OPTIONS_OBJECT
- kwds["style"] = kwds.get("style", 0) | wx.DEFAULT_FRAME_STYLE
+ kwds["style"] = kwds.get("style", 0) | wx.DEFAULT_FRAME_STYLE # wx.RESIZE_BORDER
wx.Frame.__init__(self, *args, **kwds)
self.SetName("Main Window")
+ self.Font = self.Font.Scaled(self.options.Get("FontScale", 1))
+
# Set stay on-top unless user deactivated it
if self.options.Get("StayOnTop", True):
self.ToggleWindowStyle(wx.STAY_ON_TOP)
+ # Set parameters for columns
+ self.columns = (
+ # Index, Heading, Format, Default Width, Can Toggle, Default Show, Menu Name, Outlist Column
+ [0, "ID", wx.ALIGN_LEFT, 0, False, False, "", 0],
+ [1, "Faction ID", wx.ALIGN_LEFT, 0, False, False, "", 1],
+ [2, "Character", wx.ALIGN_LEFT, 115, False, True, "", 2],
+ [3, "Security", wx.ALIGN_RIGHT, 50, True, False, "&Security\tCTRL+S", 15],
+ [4, "CorpID", wx.ALIGN_LEFT, 0, False, False, "", 3],
+ [5, "Corporation", wx.ALIGN_LEFT, 115, True, True, "Cor&poration\tCTRL+P", 4],
+ [6, "AllianceID", wx.ALIGN_LEFT, 0, False, False, "-", 5],
+ [7, "Alliance", wx.ALIGN_LEFT, 175, True, True, "All&iance\tCTRL+I", 6],
+ [8, "Faction", wx.ALIGN_LEFT, 60, True, True, "&Faction\tCTRL+F", 7],
+ [9, "Kills", wx.ALIGN_RIGHT, 50, True, True, "&Kills\tCTRL+K", 10],
+ [10, "Losses", wx.ALIGN_RIGHT, 50, True, True, "&Losses\tCTRL+L", 13],
+ [11, "Last Wk", wx.ALIGN_RIGHT, 50, True, True, "Last &Wk\tCTRL+W", 9],
+ [12, "Solo", wx.ALIGN_RIGHT, 50, True, True, "S&olo\tCTRL+O", 14],
+ [13, "BLOPS", wx.ALIGN_RIGHT, 50, True, True, "&BLOPS\tCTRL+B", 11],
+ [14, "HICs", wx.ALIGN_RIGHT, 50, True, False, "&HICs\tCTRL+H", 12],
+ [15, "", None, 1, False, True, ""], # Need for _stretchLastCol()
+ )
+
# Define the menu bar and menu items
self.menubar = wx.MenuBar()
self.menubar.SetName("Menubar")
if os.name == "nt": # For Windows
self.file_menu = wx.Menu()
- self.file_about = self.file_menu.Append(wx.ID_ANY, 'About')
- self.file_menu.Bind(wx.EVT_MENU, aboutdialog.OnAboutBox, self.file_about)
+ self.file_about = self.file_menu.Append(wx.ID_ANY, '&About\tCTRL+A')
+ self.file_menu.Bind(wx.EVT_MENU, self._openAboutDialog, self.file_about)
self.file_quit = self.file_menu.Append(wx.ID_ANY, 'Quit PySpy')
self.file_menu.Bind(wx.EVT_MENU, self.OnQuit, self.file_quit)
self.menubar.Append(self.file_menu, 'File')
if os.name == "posix": # For macOS
self.help_menu = wx.Menu()
- self.help_about = self.help_menu.Append(wx.ID_ANY, 'About')
- self.help_menu.Bind(wx.EVT_MENU, aboutdialog.OnAboutBox, self.help_about)
+ self.help_about = self.help_menu.Append(wx.ID_ANY, '&About\tCTRL+A')
+ self.help_menu.Bind(wx.EVT_MENU, self._openAboutDialog, self.help_about)
self.menubar.Append(self.help_menu, 'Help')
# View menu is platform independent
@@ -60,74 +86,79 @@ def __init__(self, *args, **kwds):
# Toggle highlighting of BLOPS kills and HIC losses
self.hl_blops = self.view_menu.AppendCheckItem(
- wx.ID_ANY, 'Highlight BLOPS Kills and HIC Losses'
+ wx.ID_ANY, '&Highlight BLOPS Kills and HIC Losses\tCTRL+SHIFT+H'
)
- self.view_menu.Bind(wx.EVT_MENU, self.toggleHlBlops, self.hl_blops)
+ self.view_menu.Bind(wx.EVT_MENU, self._toggleHlBlops, self.hl_blops)
+ self.hl_blops.Check(self.options.Get("HlBlops", True))
self.view_menu.AppendSeparator()
- # Show / hide columns
- self.show_corp = self.view_menu.AppendCheckItem(wx.ID_ANY, 'Show Corporation')
- self.view_menu.Bind(wx.EVT_MENU, self.toggleViewCorp, self.show_corp)
-
- self.show_alliance = self.view_menu.AppendCheckItem(wx.ID_ANY, 'Show Alliance')
- self.view_menu.Bind(wx.EVT_MENU, self.toggleViewAlliance, self.show_alliance)
-
- self.show_faction = self.view_menu.AppendCheckItem(wx.ID_ANY, 'Show Faction')
- self.view_menu.Bind(wx.EVT_MENU, self.toggleViewFaction, self.show_faction)
+ self._createShowColMenuItems()
self.view_menu.AppendSeparator()
# Ignore Factions submenu for view menu
- self.view_sub_menu = wx.Menu()
- self.view_menu.Append(wx.ID_ANY, "Ignore Factions", self.view_sub_menu)
+ self.factions_sub = wx.Menu()
+ self.view_menu.Append(wx.ID_ANY, "Ignore Factions", self.factions_sub)
+
+ self.ignore_galmin = self.factions_sub.AppendRadioItem(wx.ID_ANY, "Gallente / Minmatar")
+ self.factions_sub.Bind(wx.EVT_MENU, self._toggleIgnoreFactions, self.ignore_galmin)
+ self.ignore_galmin.Check(self.options.Get("HlGalMin", False))
+
+ self.ignore_amacal = self.factions_sub.AppendRadioItem(wx.ID_ANY, "Amarr / Caldari")
+ self.factions_sub.Bind(wx.EVT_MENU, self._toggleIgnoreFactions, self.ignore_amacal)
+ self.ignore_amacal.Check(self.options.Get("HlAmaCal", False))
- self.ignore_galmin = self.view_sub_menu.AppendRadioItem(wx.ID_ANY, "Gallente / Minmatar")
- self.view_sub_menu.Bind(wx.EVT_MENU, self.toggleIgnoreFactions, self.ignore_galmin)
+ self.ignore_none = self.factions_sub.AppendRadioItem(wx.ID_ANY, "None")
+ self.factions_sub.Bind(wx.EVT_MENU, self._toggleIgnoreFactions, self.ignore_none)
+ self.ignore_none.Check(self.options.Get("HlNone", True))
- self.ignore_amacal = self.view_sub_menu.AppendRadioItem(wx.ID_ANY, "Amarr / Caldari")
- self.view_sub_menu.Bind(wx.EVT_MENU, self.toggleIgnoreFactions, self.ignore_amacal)
+ # Font submenu for font scale
+ self.font_sub = wx.Menu()
+ self.view_menu.Append(wx.ID_ANY, "Font Scale", self.font_sub)
- self.ignore_none = self.view_sub_menu.AppendRadioItem(wx.ID_ANY, "None")
- self.view_sub_menu.Bind(wx.EVT_MENU, self.toggleIgnoreFactions, self.ignore_none)
+ self._fontScaleMenu(config.FONT_SCALE_MIN, config.FONT_SCALE_MAX)
self.view_menu.AppendSeparator()
# Toggle Stay on-top
self.stay_ontop = self.view_menu.AppendCheckItem(
- wx.ID_ANY, 'Stay on-top'
+ wx.ID_ANY, 'Stay on-&top\tCTRL+T'
)
- self.view_menu.Bind(wx.EVT_MENU, self.toggleStayOnTop, self.stay_ontop)
+ self.view_menu.Bind(wx.EVT_MENU, self._toggleStayOnTop, self.stay_ontop)
+ self.stay_ontop.Check(self.options.Get("StayOnTop", True))
- self.menubar.Append(self.view_menu, 'View')
+ # Toggle Dark-Mode
+ self.dark_mode = self.view_menu.AppendCheckItem(
+ wx.ID_ANY, '&Dark Mode\tCTRL+D'
+ )
+ self.dark_mode.Check(self.options.Get("DarkMode", False))
+ self.view_menu.Bind(wx.EVT_MENU, self._toggleDarkMode, self.dark_mode)
+ self.use_dm = self.dark_mode.IsChecked()
- # Menu Defaults, saved with optstore.PersistentOptions
- self.hl_blops.Check(self.options.Get("HlBlops", True))
- self.show_corp.Check(self.options.Get("ShowCorp", True))
- self.show_alliance.Check(self.options.Get("ShowAlliance", True))
- self.show_faction.Check(self.options.Get("ShowFaction", True))
- self.ignore_galmin.Check(self.options.Get("HlGalMin", False))
- self.ignore_amacal.Check(self.options.Get("HlAmaCal", False))
- self.ignore_none.Check(self.options.Get("HlNone", True))
- self.stay_ontop.Check(self.options.Get("StayOnTop", True))
+ self.menubar.Append(self.view_menu, 'View ') # Added space to avoid autogenerated menu items on Mac
- # Define the main list control
- self.list = wx.ListCtrl(self, wx.ID_ANY, style=wx.BORDER_NONE |
- wx.FULL_REPAINT_ON_RESIZE | wx.LC_HRULES | wx.LC_REPORT |
- wx.LC_SINGLE_SEL | wx.LC_VRULES
+ # Options Menubar
+ self.opt_menu = wx.Menu()
+
+ self.review_ignore = self.opt_menu.Append(wx.ID_ANY, "&Review Ignored Entities\tCTRL+R")
+ self.opt_menu.Bind(
+ wx.EVT_MENU,
+ self._openIgnoreDialog,
+ self.review_ignore
)
- self.list.SetName("Output List")
- # Ensure that Persistence Manager saves window location on close
- self.Bind(wx.EVT_CLOSE, self.OnClose)
+ self.menubar.Append(self.opt_menu, 'Options')
- # Bind double click on list item to zKill link.
- self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.goToZKill, self.list)
+ # Set the grid object
+ self.grid = wx.grid.Grid(self, wx.ID_ANY)
+ self.grid.CreateGrid(0, 0)
+ self.grid.SetName("Output List")
# Allow to change window transparency using this slider.
self.alpha_slider = wx.Slider(self, wx.ID_ANY, 250, 50, 255)
self.alpha_slider.SetName("Transparency_Slider")
- self.Bind(wx.EVT_SLIDER, self.setTransparency)
+ self.Bind(wx.EVT_SLIDER, self._setTransparency)
# The status label shows various info and error messages.
self.status_label = wx.StaticText(
@@ -146,30 +177,108 @@ def __init__(self, *args, **kwds):
self._persistMgr.SetPersistenceFile(config.GUI_CFG_FILE)
self._persistMgr.RegisterAndRestoreAll(self)
- self.setTransparency() # Set transparency based off restored slider
+ # Column resize to trigger last column stretch to fill blank canvas.
+ self.Bind(wx.grid.EVT_GRID_COL_SIZE, self._stretchLastCol, self.grid)
+
+ # Window resize to trigger last column stretch to fill blank canvas.
+ self.Bind(wx.EVT_SIZE, self._stretchLastCol, self)
+
+ # Ensure that Persistence Manager saves window location on close
+ self.Bind(wx.EVT_CLOSE, self.OnClose)
+
+ # Bind double click on list item to zKill link.
+ self.Bind(wx.grid.EVT_GRID_CELL_LEFT_DCLICK, self._goToZKill, self.grid)
+
+ # Bind right click on list item to ignore character.
+ self.Bind(wx.grid.EVT_GRID_CELL_RIGHT_CLICK, self._showContextMenu, self.grid)
+
+ # Bind left click on column label to sorting
+ self.Bind(wx.grid.EVT_GRID_COL_SORT, self.sortOutlist, self.grid)
+
+ # Set transparency based off restored slider
+ self._setTransparency()
self.__do_layout()
- def __set_properties(self):
+ def __set_properties(self, dark_toggle=None):
+ '''
+ Set the initial properties for the various widgets.
+ '''
+ # Colour Scheme Dictionaries
+ self.dark_dict = config.DARK_MODE
+ self.normal_dict = config.NORMAL_MODE
+
+ # Colour Scheme
+ if not self.options.Get("DarkMode", False):
+ self.bg_colour = self.normal_dict["BG"]
+ self.txt_colour = self.normal_dict["TXT"]
+ self.lne_colour = self.normal_dict["LNE"]
+ self.lbl_colour = self.normal_dict["LBL"]
+ self.hl1_colour = self.normal_dict["HL1"]
+ else:
+ self.bg_colour = self.dark_dict["BG"]
+ self.txt_colour = self.dark_dict["TXT"]
+ self.lne_colour = self.dark_dict["LNE"]
+ self.lbl_colour = self.dark_dict["LBL"]
+ self.hl1_colour = self.dark_dict["HL1"]
+
+
+ # Set default colors
+ self.SetBackgroundColour(self.bg_colour)
+ self.SetForegroundColour(self.txt_colour)
+ self.grid.SetDefaultCellBackgroundColour(self.bg_colour)
+ self.grid.SetDefaultCellTextColour(self.txt_colour)
+ self.grid.SetGridLineColour(self.lne_colour)
+ self.grid.SetLabelBackgroundColour(self.bg_colour)
+ self.grid.SetLabelTextColour(self.lbl_colour)
+ self.status_label.SetForegroundColour(self.lbl_colour)
+
+ # Do not reset window size etc. if only changing colour scheme.
+ if dark_toggle:
+ return
+
self.SetTitle(config.GUI_TITLE)
- self.SetSize((625, 400))
+ self.SetSize((720, 400))
self.SetMenuBar(self.menubar)
- self.list.AppendColumn("ID", format=wx.LIST_FORMAT_LEFT, width=0)
- self.list.AppendColumn("FactionID", format=wx.LIST_FORMAT_LEFT, width=0)
- self.list.AppendColumn("Character", format=wx.LIST_FORMAT_LEFT, width=115)
- self.lc_corp = self.list.AppendColumn("Corporation", format=wx.LIST_FORMAT_LEFT, width=115)
- self.lc_alliance = self.list.AppendColumn("Alliance", format=wx.LIST_FORMAT_LEFT, width=175)
- self.lc_faction = self.list.AppendColumn("Faction", format=wx.LIST_FORMAT_LEFT, width=60)
- self.list.AppendColumn("Last Wk", format=wx.LIST_FORMAT_CENTER, width=50)
- self.list.AppendColumn("K - B - H", format=wx.LIST_FORMAT_CENTER, width=90)
+ # Insert columns based on parameters provided in col_def
+
+ # self.grid.CreateGrid(0, 0)
+ if self.grid.GetNumberCols() < len(self.columns):
+ self.grid.AppendCols(len(self.columns))
+ self.grid.SetColLabelSize(self.grid.GetDefaultRowSize() + 2)
+ self.grid.SetRowLabelSize(0)
+ self.grid.EnableEditing(0)
+ self.grid.DisableCellEditControl()
+ self.grid.EnableDragRowSize(0)
+ self.grid.EnableDragGridSize(0)
+ self.grid.SetSelectionMode(wx.grid.Grid.SelectRows)
+ self.grid.SetColLabelAlignment(wx.ALIGN_CENTRE, wx.ALIGN_BOTTOM)
+ self.grid.ClipHorzGridLines(False)
+ # self.grid.ClipVertGridLines(False)
+ # Disable visual highlighting of selected cell to look more like listctrl
+ self.grid.SetCellHighlightPenWidth(0)
+ colidx = 0
+ for col in self.columns:
+ self.grid.SetColLabelValue(
+ col[0], # Index
+ col[1], # Heading
+ )
+ # self.grid.SetColSize(colidx, col[3])
+ colidx += 1
+ # Transparency slider
self.alpha_slider.SetMinSize((100, 20))
+ # Window icon
icon = wx.Icon()
icon.CopyFromBitmap(wx.Bitmap(config.ICON_FILE, wx.BITMAP_TYPE_ANY))
self.SetIcon(icon)
def __do_layout(self):
+ '''
+ Assigns the various widgets to sizers and calls a number of helper
+ functions.
+ '''
sizer_main = wx.BoxSizer(wx.VERTICAL)
sizer_bottom = wx.BoxSizer(wx.HORIZONTAL)
- sizer_main.Add(self.list, 1, wx.EXPAND, 0)
+ sizer_main.Add(self.grid, 1, wx.EXPAND, 0)
sizer_bottom.Add(self.status_label, 1, wx.ALIGN_CENTER_VERTICAL, 0)
static_line = wx.StaticLine(self, wx.ID_ANY, style=wx.LI_VERTICAL)
sizer_bottom.Add(static_line, 0, wx.EXPAND, 0)
@@ -177,46 +286,228 @@ def __do_layout(self):
sizer_main.Add(sizer_bottom, 0, wx.ALIGN_BOTTOM | wx.ALL | wx.EXPAND, 1)
self.SetSizer(sizer_main)
self.Layout()
+ self._restoreColWidth()
+ self._stretchLastCol()
+
+ def _fontScaleMenu(self, lower, upper):
+ '''
+ Populates the font scale sub menu with scale percentages
+ based on input bounds.
+
+ :param `lower`: The minimum scale represented as a decimal, e.g. 0.6
+
+ :param `upper`: The maximum scale represented as a decimal, e.g. 1.4
+ '''
+ for scale in range(lower, upper):
+ scale = scale / 10
+ self.font_sub.AppendRadioItem(wx.ID_ANY, "{:.0%}".format(scale))
+ self.font_sub.Bind(
+ wx.EVT_MENU,
+ lambda evt, scale=scale: self._setFontScale(scale, evt),
+ self.font_sub.MenuItems[-1]
+ )
+ if scale == self.options.Get("FontScale", 1):
+ self.font_sub.MenuItems[-1].Check(True)
+
+ def _setFontScale(self, scale, evt=None):
+ '''
+ Changes the font scaling and saves it in the pickle container.
+ '''
+ self.Font = self.Font.Scaled(scale)
+ self.options.Set("FontScale", scale)
+
+ def _createShowColMenuItems(self):
+ '''
+ Populates the View menu with show column toggle menu items for
+ each column that is toggleable. It uses the information provided
+ in self.columns.
+ '''
+ # For each column, create show / hide menu items, if hideable
+ self.col_menu_items = [[] for i in self.columns]
+ for col in self.columns:
+ if not col[4]: # Do not add menu item if column not hideable
+ continue
+ index = col[0]
+ options_key = "Show" + col[1]
+ menu_name = "Show " + col[6]
+ self.col_menu_items[index] = self.view_menu.AppendCheckItem(
+ wx.ID_ANY,
+ menu_name
+ )
+ # Column show / hide, depending on user settings, if any
+ checked = self.options.Get(
+ options_key,
+ self.columns[index][5]
+ )
+ self.col_menu_items[index].Check(
+ self.options.Get(options_key, checked)
+ )
+ # Bind new menu item to toggleColumn method
+ self.view_menu.Bind(
+ wx.EVT_MENU,
+ lambda evt, index=index: self._toggleColumn(index, evt),
+ self.col_menu_items[index]
+ )
+
+ def _toggleColumn(self, index, event=None):
+ '''
+ Depending on the respective menu item state, either reveals or
+ hides a column. If it hides a column, it first stores the old
+ column width in self.options to allow for subsequent restore.
+ '''
+ try:
+ checked = self.col_menu_items[index].IsChecked()
+ except:
+ checked = False
+ col_name = self.columns[index][1]
+ if checked:
+ default_width = self.columns[index][3]
+ col_width = self.options.Get(col_name, default_width)
+ if col_width > 0:
+ self.grid.SetColSize(index, col_width)
+ else:
+ self.grid.SetColSize(index, default_width)
+ else:
+ col_width = self.grid.GetColSize(index)
+ # Only save column status if column is actually hideable
+ if self.columns[index][4]:
+ self.options.Set(col_name, col_width)
+ self.grid.HideCol(index)
+ self._stretchLastCol()
+
+ def _stretchLastCol(self, event=None):
+ '''
+ Makes sure the last column fills any blank space of the
+ grid. For this reason, the last list item of self.columns should
+ describe an empty column.
+ '''
+ grid_width = self.grid.Size.GetWidth()
+ cols_width = 0
+ for index in range(self.columns[-1][0] + 1):
+ cols_width += self.grid.GetColSize(index)
+ stretch_width = grid_width - cols_width
+ last_col_width = max(
+ self.grid.GetColSize(index) + stretch_width,
+ self.columns[index][3]
+ )
+ self.grid.SetColSize(index, last_col_width)
+ self.Layout()
+ if event is not None:
+ event.Skip(True)
def updateList(self, outlist, duration=None):
+ '''
+ `updateList()` takes the output of `output_list()` in `analyze.py` (via
+ `__main__.py`) or a copy thereof stored in self.option, and uses it
+ to populate the list widget. Before it does so, it checks each
+ item in outlist against a list of ignored characters, corporations
+ and alliances. Finally, it highlights certain characters and
+ updates the statusbar message.
+
+ :param `outlist`: A list of rows with character data.
+
+ :param `duration`: Time in seconds taken to query all relevant
+ databases for each character.
+ '''
# If updateList() gets called before outlist has been provided, do nothing
if outlist is None:
return
- self.options.Set("outlist", outlist)
+ if self.grid.GetNumberRows() > 0:
+ self.grid.DeleteRows(numRows=self.grid.GetNumberRows())
+ self.grid.AppendRows(len(outlist))
+ ignored_list = self.options.Get("ignoredList", default=[])
hl_blops = self.options.Get("HlBlops", True)
- self.list.DeleteAllItems()
+ ignore_count = 0
+ rowidx = 0
for r in outlist:
+ ignore = False
+ for rec in ignored_list:
+ if r[0] == rec[0] or r[3] == rec[0] or r[5] == rec[0]:
+ ignore = True
+ if ignore:
+ self.grid.HideRow(rowidx)
+ ignore_count += 1
+
# Schema depending on output_list() in analyze.py
- id = r[0]
- faction_id = r[1]
+ id = r[0] # Hidden, used for zKillboard link
+ faction_id = r[1] # Hidden, used for faction ignoring
name = r[2]
- corp = r[3]
- alliance = str(r[4]) + " (" + str(r[6]) + ")" if r[4] is not None else "-"
- faction = r[5] if r[5] is not None else "-"
- week_kills = r[7]
- zkill = str(r[8]) + " - " + str(r[9]) + " - " + str(r[10]) if r[8] is not None else "n.a."
- out = [id, faction_id, name, corp, alliance, faction, week_kills, zkill]
+ corp_id = r[3]
+ corp_name = r[4]
+ alliance_id = r[5]
+ alliance_name = r[6]
+ faction = r[7] if r[7] is not None else "-"
+ allies = "{:,}".format(int(r[8]))
+
+ # Add number of allies to alliance name
+ if alliance_name is not None:
+ alliance_name = alliance_name + " (" + allies + ")"
+ else:
+ alliance_name = "-"
+
+ # zKillboard data is "n.a." unless available
+ week_kills = kills = blops_kills = hic_losses = "n.a."
+ losses = solo_ratio = sec_status = "n.a."
+
+ if r[13] is not None:
+ week_kills = "{:,}".format(int(r[9]))
+ kills = "{:,}".format(int(r[10]))
+ blops_kills = "{:,}".format(int(r[11]))
+ hic_losses = "{:,}".format(int(r[12]))
+ losses = "{:,}".format(int(r[13]))
+ solo_ratio = "{:.0%}".format(float(r[14]))
+ sec_status = "{:.1f}".format(float(r[15]))
+
+ out = [
+ id,
+ faction_id,
+ name,
+ sec_status,
+ corp_id,
+ corp_name,
+ alliance_id,
+ alliance_name,
+ faction,
+ kills,
+ losses,
+ week_kills,
+ solo_ratio,
+ blops_kills,
+ hic_losses
+ ]
# Check if character belongs to a faction that should be ignored
if faction_id != 0:
if config.IGNORED_FACTIONS == 2 and faction_id % 2 == 0:
- continue
+ self.grid.HideRow(rowidx)
if config.IGNORED_FACTIONS == 1 and faction_id % 2 != 0:
- continue
-
- self.list.Append(out)
+ self.grid.HideRow(rowidx)
+ colidx = 0
+
+ # Cell text formatting
+ for value in out:
+ self.grid.SetCellValue(rowidx, colidx, str(value))
+ self.grid.SetCellAlignment(self.columns[colidx][2], rowidx, colidx)
+ if hl_blops and r[9] is not None and (r[11] > 0 or r[12] > 0): # Highlight BLOPS killer & HIC pilots.
+ self.grid.SetCellTextColour(rowidx, colidx, self.hl1_colour)
+ else:
+ self.grid.SetCellTextColour(rowidx, colidx, self.txt_colour)
+ colidx += 1
+ rowidx += 1
- if hl_blops and r[7] is not None and (r[9] > 0 or r[10] > 0): # Highlight BLOPS killer & HIC pilots.
- self.list.SetItemBackgroundColour(
- self.list.ItemCount - 1,
- wx.Colour(255, 189, 90)
- )
if duration is not None:
statusmsg.push_status(
- str(len(outlist)) +
- " characters analysed in " + str(duration) +
- " seconds. Double click character to go to zKillboard."
+ str(len(outlist) - ignore_count) +
+ " characters analysed, in " + str(duration) +
+ " seconds (" + str(ignore_count) + " ignored). Double click " +
+ "character to go to zKillboard."
+ )
+ else:
+ statusmsg.push_status(
+ str(len(outlist) - ignore_count) + " characters analysed (" +
+ str(ignore_count) + " ignored). Double click character to go " +
+ " to zKillboard."
)
def updateStatusbar(self, msg):
@@ -225,41 +516,137 @@ def updateStatusbar(self, msg):
self.status_label.SetLabel(msg)
self.Layout()
- def goToZKill(self, event):
+ def _goToZKill(self, event):
+ rowidx = event.GetRow()
+ character_id = self.options.Get("outlist")[rowidx][0]
webbrowser.open_new_tab(
"https://zkillboard.com/character/" +
- str(event.GetText())
+ str(character_id) + "/"
)
- def setTransparency(self, event=None):
+ def _showContextMenu(self, event):
+ '''
+ Gets invoked by right click on any list item and produces a
+ context menu that allows the user to add the selected character
+ to PySpy's list of "ignored characters" which will no longer be
+ shown in search results.
+ '''
+ def OnIgnore(id, name, type, e=None):
+ ignored_list = self.options.Get("ignoredList", default=[])
+ ignored_list.append([id, name, type])
+ self.options.Set("ignoredList", ignored_list)
+ self.updateList(self.options.Get("outlist", None))
+
+ rowidx = event.GetRow()
+ character_id = str(self.options.Get("outlist")[rowidx][0])
+ # Only open context menu character item right clicked, not empty line.
+ if len(character_id) > 0:
+ outlist = self.options.Get("outlist")
+ for r in outlist:
+ if str(r[0]) == character_id:
+ character_id = r[0]
+ character_name = r[2]
+ corp_id = r[3]
+ corp_name = r[4]
+ alliance_id = r[5]
+ alliance_name = r[6]
+ break
+ self.menu = wx.Menu()
+ # Context menu to ignore characters, corporations and alliances.
+ item_ig_char = self.menu.Append(
+ wx.ID_ANY, "Ignore character '" + character_name + "'"
+ )
+ self.menu.Bind(
+ wx.EVT_MENU,
+ lambda evt, id=character_id, name=character_name: OnIgnore(id, name, "Character", evt),
+ item_ig_char
+ )
+
+ item_ig_corp = self.menu.Append(
+ wx.ID_ANY, "Ignore corporation: '" + corp_name + "'"
+ )
+ self.menu.Bind(
+ wx.EVT_MENU,
+ lambda evt, id=corp_id, name=corp_name: OnIgnore(id, name, "Corporation", evt),
+ item_ig_corp
+ )
+
+ if alliance_name is not None:
+ item_ig_alliance = self.menu.Append(
+ wx.ID_ANY, "Ignore alliance: '" + alliance_name + "'"
+ )
+ self.menu.Bind(
+ wx.EVT_MENU,
+ lambda evt, id=alliance_id, name=alliance_name: OnIgnore(id, name, "Alliance", evt),
+ item_ig_alliance
+ )
+
+ self.PopupMenu(self.menu, event.GetPosition())
+ self.menu.Destroy()
+
+ def sortOutlist(self, event=None, outlist=None, duration=None):
+ '''
+ If called by event handle, i.e. user
+ '''
+ if event is None:
+ # Default sort by character name ascending.
+ colidx = self.options.Get("SortColumn", self.columns[2][7])
+ sort_desc = self.options.Get("SortDesc", False)
+ else:
+ colidx = event.GetCol()
+ if self.options.Get("SortColumn", -1) == colidx:
+ sort_desc = not self.options.Get("SortDesc")
+ else:
+ sort_desc = True
+
+ # Use unicode characters for sort indicators
+ arrow = u"\u2193" if sort_desc else u"\u2191"
+
+ # Reset all labels
+ for col in self.columns:
+ self.grid.SetColLabelValue(col[0], col[1])
+
+ # Assign sort indicator to sort column
+ self.grid.SetColLabelValue(
+ colidx,
+ self.columns[colidx][1] + " " + arrow
+ )
+ self.options.Set("SortColumn", colidx)
+ self.options.Set("SortDesc", sort_desc)
+ event = None
+ # Sort outlist. Note: outlist columns are not the same as
+ # self.grid columns!!!
+ if outlist is None:
+ outlist = self.options.Get("outlist", False)
+
+ if outlist:
+ outlist = sortarray.sort_array(
+ outlist,
+ self.columns[colidx][7],
+ sec_col=self.columns[2][7], # Secondary sort by name
+ prim_desc=sort_desc,
+ sec_desc=False, # Secondary sort by name always ascending
+ case_sensitive=False
+ )
+ self.options.Set("outlist", outlist)
+ self.updateList(outlist, duration=duration)
+
+ def _setTransparency(self, event=None):
+ '''
+ Sets window transparency based off slider setting and stores
+ value in self.options.
+ '''
alpha = self.alpha_slider.GetValue()
self.SetTransparent(alpha)
self.options.Set("GuiAlpha", alpha)
self.Layout()
- def OnClose(self, event):
- self._persistMgr.SaveAndUnregister()
- # Store check-box values in pickle container
- self.options.Set("HlBlops", self.hl_blops.IsChecked())
- self.options.Set("ShowCorp", self.show_corp.IsChecked())
- self.options.Set("ShowAlliance", self.show_alliance.IsChecked())
- self.options.Set("ShowFaction", self.show_faction.IsChecked())
- self.options.Set("HlGalMin", self.ignore_galmin.IsChecked())
- self.options.Set("HlAmaCal", self.ignore_amacal.IsChecked())
- self.options.Set("HlNone", self.ignore_none.IsChecked())
- # Delete last outlist
- self.options.Set("outlist", None)
- # Store version information
- self.options.Set("version", config.CURRENT_VER)
- # Write pickle container to disk
- self.options.Save()
- event.Skip()
-
- def OnQuit(self, e):
- self.Close()
-
def updateAlert(self, latest_ver, cur_ver):
- '''Gets called by chk_github_update() in chkversion.py.'''
+ '''
+ Simple dialog box to notify user when new version of PySpy is
+ available for download. Gets called by chk_github_update()
+ in chkversion.py.
+ '''
self.ToggleWindowStyle(wx.STAY_ON_TOP)
msgbox = wx.MessageBox(
"PySpy " + str(latest_ver) + " is now available. You are running " +
@@ -273,41 +660,11 @@ def updateAlert(self, latest_ver, cur_ver):
)
self.ToggleWindowStyle(wx.STAY_ON_TOP)
- def toggleHlBlops(self, e):
+ def _toggleHlBlops(self, e):
self.options.Set("HlBlops", self.hl_blops.IsChecked())
self.updateList(self.options.Get("outlist", None))
- def toggleViewCorp(self, e):
- if self.show_corp.IsChecked():
- col_width = self.options.Get("colCorpWidth", 145)
- self.list.SetColumnWidth(self.lc_corp, col_width)
- else:
- col_width = self.list.GetColumnWidth(self.lc_corp)
- self.options.Set("colCorpWidth", col_width)
- self.list.SetColumnWidth(self.lc_corp, 0)
- self.Layout()
-
- def toggleViewAlliance(self, e):
- if self.show_alliance.IsChecked():
- col_width = self.options.Get("colAllianceWidth", 210)
- self.list.SetColumnWidth(self.lc_alliance, col_width)
- else:
- col_width = self.list.GetColumnWidth(self.lc_alliance)
- self.options.Set("colAllianceWidth", col_width)
- self.list.SetColumnWidth(self.lc_alliance, 0)
- self.Layout()
-
- def toggleViewFaction(self, e):
- if self.show_faction.IsChecked():
- col_width = self.options.Get("colFactionWidth", 90)
- self.list.SetColumnWidth(self.lc_faction, col_width)
- else:
- col_width = self.list.GetColumnWidth(self.lc_faction)
- self.options.Set("colFactionWidth", col_width)
- self.list.SetColumnWidth(self.lc_faction, 0)
- self.Layout()
-
- def toggleIgnoreFactions(self, e):
+ def _toggleIgnoreFactions(self, e):
ig_galmin = self.ignore_galmin.IsChecked()
ig_amacal = self.ignore_amacal.IsChecked()
ig_none = self.ignore_none.IsChecked()
@@ -322,10 +679,105 @@ def toggleIgnoreFactions(self, e):
self.options.Set("IgnoredFactions", 0)
self.updateList(self.options.Get("outlist", None))
- def toggleStayOnTop(self, e):
+ def _toggleStayOnTop(self, evt=None):
self.options.Set("StayOnTop", self.stay_ontop.IsChecked())
self.ToggleWindowStyle(wx.STAY_ON_TOP)
+ def _toggleDarkMode(self, evt=None):
+ self.options.Set("DarkMode", self.dark_mode.IsChecked())
+ self.use_dm = self.dark_mode.IsChecked()
+ self.__set_properties(dark_toggle=True)
+ self.Refresh()
+ self.Update()
+ self.updateList(self.options.Get("outlist"))
+
+ def _openAboutDialog(self, evt=None):
+ '''
+ Checks if IgnoreDialog is already open. If not, opens the dialog
+ window, otherwise brings the existing dialog window to the front.
+ '''
+ for c in self.GetChildren():
+ if c.GetName() == "AboutDialog": # Needs to match name in ignoredialog.py
+ c.Raise()
+ return
+ aboutdialog.showAboutBox(self)
+
+ def _openIgnoreDialog(self, evt=None):
+ '''
+ Checks if IgnoreDialog is already open. If not, opens the dialog
+ window, otherwise brings the existing dialog window to the front.
+ '''
+ for c in self.GetChildren():
+ if c.GetName() == "IgnoreDialog": # Needs to match name in ignoredialog.py
+ c.Raise()
+ return
+ ignoredialog.showIgnoreDialog(self)
+
+ def _restoreColWidth(self):
+ '''
+ Restores column width either to default or value stored from
+ previous session.
+ '''
+ for col in self.columns:
+ header = col[1]
+ # Column width is also set in _toggleColumn()
+ width = self.options.Get(header, col[3])
+ menu_item = self.col_menu_items[col[0]]
+ if menu_item == [] or menu_item.IsChecked():
+ self.grid.SetColSize(col[0], width)
+ else:
+ self.grid.SetColSize(col[0], 0)
+ pass
+
+ def _saveColumns(self):
+ '''
+ Saves custom column widths, since wxpython's Persistence Manager
+ is unable to do so for Grid widgets.
+ '''
+ for col in self.columns:
+ is_hideable = col[4]
+ default_show = col[5]
+ header = col[1]
+ options_key = "Show" + header
+ width = self.grid.GetColSize(col[0])
+ try:
+ menu_item_chk = self.col_menu_items[col[0]].IsChecked()
+ except:
+ menu_item_chk = False
+ # Only save column width for columns that are not hidden or
+ # not hideable and shown by default.
+ if menu_item_chk or (not is_hideable and default_show):
+ self.options.Set(header, width)
+ # Do not add menu item if column not hideable
+ if col[4]:
+ self.options.Set(options_key, menu_item_chk)
+ pass
+
+ def OnClose(self, event=None):
+ '''
+ Run a few clean-up tasks on close and save persistent properties.
+ '''
+ self._persistMgr.SaveAndUnregister()
+
+ # Save column toggle menu state and column width in pickle container
+ self._saveColumns()
+
+ # Store check-box values in pickle container
+ self.options.Set("HlBlops", self.hl_blops.IsChecked())
+ self.options.Set("HlGalMin", self.ignore_galmin.IsChecked())
+ self.options.Set("HlAmaCal", self.ignore_amacal.IsChecked())
+ self.options.Set("HlNone", self.ignore_none.IsChecked())
+ self.options.Set("StayOnTop", self.stay_ontop.IsChecked())
+ self.options.Set("DarkMode", self.dark_mode.IsChecked())
+ # Delete last outlist
+ self.options.Set("outlist", None)
+ # Write pickle container to disk
+ self.options.Save()
+ event.Skip() if event else False
+
+ def OnQuit(self, e):
+ self.Close()
+
class App(wx.App):
def OnInit(self):
diff --git a/ignoredialog.py b/ignoredialog.py
new file mode 100644
index 0000000..185f945
--- /dev/null
+++ b/ignoredialog.py
@@ -0,0 +1,153 @@
+# !/usr/local/bin/python3.6
+# MIT licensed
+# Copyright (c) 2018 White Russsian
+# Github: **********************
+''' Dialog to view and remove entities from PySpy's list of ignored
+characters, corporations and alliances.
+'''
+# **********************************************************************
+import logging
+
+import wx
+from wx.lib.mixins.listctrl import CheckListCtrlMixin, ListCtrlAutoWidthMixin
+
+import config
+import sortarray
+import statusmsg
+# cSpell Checker - Correct Words****************************************
+# // cSpell:words russsian, ccp's, pyperclip, chkversion, clpbd, gui
+# **********************************************************************
+Logger = logging.getLogger(__name__)
+# Example call: Logger.info("Something badhappened", exc_info=True) ****
+
+
+class CheckListCtrl(wx.ListCtrl, CheckListCtrlMixin, ListCtrlAutoWidthMixin):
+
+ def __init__(self, parent):
+ wx.ListCtrl.__init__(self, parent, wx.ID_ANY, style=wx.LC_REPORT |
+ wx.SUNKEN_BORDER)
+ CheckListCtrlMixin.__init__(self)
+ ListCtrlAutoWidthMixin.__init__(self)
+
+
+class IgnoreDialog(wx.Frame):
+ def __init__(self, parent, *args, **kwds):
+ kwds["style"] = (kwds.get("style", 0) | wx.CAPTION | wx.CLIP_CHILDREN |
+ wx.CLOSE_BOX | wx.FRAME_FLOAT_ON_PARENT | wx.RESIZE_BORDER)
+ wx.Frame.__init__(self, parent, *args, **kwds)
+
+ self.Font = self.Font.Scaled(config.OPTIONS_OBJECT.Get("FontScale", 1))
+ self.SetName("IgnoreDialog")
+ self.SetSize((400, 300))
+
+ self.ignoredList = CheckListCtrl(self)
+ self.ignoredList.InsertColumn(0, 'Name', width=180)
+ self.ignoredList.InsertColumn(1, 'ID', width=0)
+ self.ignoredList.InsertColumn(2, 'Type')
+ self.buttonPanel = wx.Panel(self, wx.ID_ANY)
+ self.appBtn = wx.Button(self.buttonPanel, wx.ID_OK, "Delete Selected Entries")
+ self.cnclBtn = wx.Button(self.buttonPanel, wx.ID_CANCEL, "Cancel Changes")
+
+ self.Bind(wx.EVT_BUTTON, self.OnApply, id=self.appBtn.GetId())
+ self.Bind(wx.EVT_BUTTON, self.OnCancel, id=self.cnclBtn.GetId())
+ self.Bind(wx.EVT_CHAR_HOOK, self.OnHook)
+
+ self.ignored_entities = config.OPTIONS_OBJECT.Get("ignoredList", default=[])
+ self._populateList()
+
+ self.__set_properties()
+ self.__do_layout()
+
+ if config.OPTIONS_OBJECT.Get("StayOnTop", True):
+ self.Parent.ToggleWindowStyle(wx.STAY_ON_TOP)
+ self.ToggleWindowStyle(wx.STAY_ON_TOP)
+
+ def __set_properties(self):
+ self.SetTitle("Review Ignored Entities")
+ # Colour Scheme Dictionaries
+ self.dark_dict = config.DARK_MODE
+ self.normal_dict = config.NORMAL_MODE
+
+ # Colour Scheme
+ if not config.OPTIONS_OBJECT.Get("DarkMode", False):
+ self.bg_colour = self.normal_dict["BG"]
+ self.txt_colour = self.normal_dict["TXT"]
+ self.lne_colour = self.normal_dict["LNE"]
+ self.hl1_colour = self.normal_dict["HL1"]
+ else:
+ self.bg_colour = self.dark_dict["BG"]
+ self.txt_colour = self.dark_dict["TXT"]
+ self.lne_colour = self.dark_dict["LNE"]
+ self.hl1_colour = self.dark_dict["HL1"]
+
+ # Set default colors
+ self.SetBackgroundColour(self.bg_colour)
+ self.SetForegroundColour(self.txt_colour)
+ self.ignoredList.SetBackgroundColour(self.bg_colour)
+ self.ignoredList.SetForegroundColour(self.txt_colour)
+
+ # Window icon
+ icon = wx.Icon()
+ icon.CopyFromBitmap(wx.Bitmap(config.ICON_FILE, wx.BITMAP_TYPE_ANY))
+ self.SetIcon(icon)
+
+ def __do_layout(self):
+ main = wx.BoxSizer(wx.VERTICAL)
+ buttonSizer = wx.BoxSizer(wx.HORIZONTAL)
+ instrLbl = wx.StaticText(self, wx.ID_ANY, "Select entities to be removed from ignore list:", style=wx.ALIGN_LEFT)
+ main.Add(instrLbl, 0, wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, 10)
+ main.Add(self.ignoredList, 1, wx.ALL | wx.EXPAND, 10)
+ buttonSizer.Add(self.appBtn, 1, wx.RIGHT, 5)
+ buttonSizer.Add(self.cnclBtn, 1, wx.LEFT, 5)
+ self.buttonPanel.SetSizer(buttonSizer)
+ main.Add(self.buttonPanel, 0, wx.ALIGN_BOTTOM | wx.BOTTOM | wx.EXPAND | wx.LEFT | wx.RIGHT, 10)
+ self.SetSizer(main)
+ self.Layout()
+ self.Centre()
+
+ def _populateList(self):
+ idx = 0
+ if self.ignored_entities == []:
+ return
+ if len(self.ignored_entities) > 1:
+ self.ignored_entities = sortarray.sort_array(self.ignored_entities, 2, 1)
+ for i in self.ignored_entities:
+ index = self.ignoredList.InsertItem(idx, i[1])
+ self.ignoredList.SetItem(index, 1, str(i[0]))
+ self.ignoredList.SetItem(index, 2, i[2])
+ idx += 1
+
+ def OnHook(self, event):
+ if event.GetKeyCode() == wx.WXK_ESCAPE:
+ self.OnCancel(event)
+ if event.GetKeyCode() == wx.WXK_RETURN:
+ self.OnApply(event)
+ else:
+ event.Skip()
+
+ def OnApply(self, event):
+ num = self.ignoredList.GetItemCount()
+ for i in range(num):
+ if self.ignoredList.IsChecked(i):
+ id = int(self.ignoredList.GetItemText(i, 1))
+ n = 0
+ for r in self.ignored_entities:
+ if r[0] == id:
+ del self.ignored_entities[n]
+ n += 1
+ config.OPTIONS_OBJECT.Set("ignoredList", self.ignored_entities)
+ self.Parent.updateList(config.OPTIONS_OBJECT.Get("outlist"))
+ self.Close()
+
+ def OnCancel(self, event):
+ if config.OPTIONS_OBJECT.Get("StayOnTop", True):
+ self.Parent.ToggleWindowStyle(wx.STAY_ON_TOP)
+ self.Close()
+
+
+def showIgnoreDialog(parent, evt=None):
+ app = wx.App(False)
+ frame = IgnoreDialog(parent=parent)
+ app.SetTopWindow(frame)
+ frame.Show()
+ app.MainLoop()
diff --git a/optstore.py b/optstore.py
index 6e79383..dae6242 100644
--- a/optstore.py
+++ b/optstore.py
@@ -67,6 +67,17 @@ def Set(self, key, value):
'''
self._options[key] = value
+ def Del(self, key):
+ '''
+ Deletes specified key in the dictionary object.
+
+ :param `key`: existing key of the dictionary object;
+ '''
+ try:
+ del self._options[key]
+ except:
+ raise Exception("ERROR: no such key: " + str(key))
+
def Save(self):
'''
Saves the dictionary object in a pickle file under the file name
diff --git a/reportstats.py b/reportstats.py
index 87509ea..5f94f66 100644
--- a/reportstats.py
+++ b/reportstats.py
@@ -8,7 +8,7 @@
# **********************************************************************
import json
import logging
-import os
+import platform
import threading
import time
@@ -36,7 +36,7 @@ def __init__(self, outlist, duration):
self.daemon = True
self._uuid = config.OPTIONS_OBJECT.Get("uuid")
self._version = config.CURRENT_VER
- self._platform = os.name
+ self._platform = platform.system()
self._chars = str(len(outlist))
self._duration = str(duration)
self._sh_faction = str(config.OPTIONS_OBJECT.Get("ShowFaction", True))
diff --git a/sortarray.py b/sortarray.py
new file mode 100644
index 0000000..9db9658
--- /dev/null
+++ b/sortarray.py
@@ -0,0 +1,178 @@
+# !/usr/local/bin/python3.6
+# MIT licensed
+# Copyright (c) 2018 White Russsian
+# Github: **********************
+'''SortArray() provides functionality to sort an array (list of lists
+or tuples) containing string or numeric values (or a mix thereof).
+Ability to sort by two "columns", to break a tie in the primary sort
+column. Can be case sensitive.
+'''
+# cSpell Checker - Correct Words****************************************
+# // cSpell:words russsian
+# **********************************************************************
+
+
+class SortArrayError(Exception):
+ '''
+ Base exception for any exceptions raised by SortArray.
+ '''
+ def __init__(self, msg=None):
+ if msg is None:
+ # Set some default useful error message
+ msg = "SortArray encountered a problem and stopped."
+ super(SortArrayError, self).__init__(msg)
+
+
+class OutOfBoundError(SortArrayError):
+ '''
+ Gets raised when `prim_col` is greater than the last column in `array`.
+ '''
+ def __init__(self, prim_col, sort_array):
+ prim_col = prim_col
+ array_columns = len(sort_array[0])
+ msg = (
+ "Sort column index (%s) exceeds number of columns in the unsorted input array (%s)." % (prim_col, array_columns)
+ )
+ super(SortArrayError, self).__init__(msg)
+
+
+class NothingToSortError(SortArrayError):
+ '''
+ Gets raised when there are less than two sortable objects.
+ '''
+ def __init__(self):
+ msg = (
+ "The unsorted input array does not contain sufficient sortable values."
+ )
+ super(SortArrayError, self).__init__(msg)
+
+
+def _determineApproach(array, sort_col):
+ '''
+ Takes an array (list of lists/tuples) and determines whether values
+ in a given column should be sorted as numbers or strings. Returns
+ a boolean which is True if column should be sorted as string and
+ False if to be sorted as float.
+
+ :param `array`: A list of list or tuples.
+
+ :param `sort_col`: The number of the sort column as integer.
+
+ :return: Boolean indicating if sort type is string (True) or float
+ (False).
+ '''
+
+ if sort_col > len(array[0]):
+ raise OutOfBoundError(sort_col, array)
+
+ # Check type of each element to be sorted_list
+ is_num = is_str = is_other = is_none = 0
+ for r in array:
+ if isinstance(r[sort_col], (int, float)):
+ is_num += 1
+ elif isinstance(r[sort_col], str):
+ try:
+ float(r[sort_col])
+ is_num += 1
+ except ValueError:
+ is_str += 1
+ elif r[sort_col] is None:
+ is_none += 1
+ else:
+ is_other += 1
+
+ # Make sure all elements are sortable, if not return TypeError
+ if is_other > 0:
+ raise TypeError
+
+ # If any element is not or cannot be converted to a number,
+ # treat all elements as string.
+ elif is_str > 0:
+ sort_as_str = True
+ else:
+ sort_as_str = False
+
+ # If there is nothing to sort, raise error.
+ if (is_num + is_str + is_none) < 2:
+ raise NothingToSortError
+
+ return sort_as_str
+
+
+def sort_array(array, prim_col, sec_col=None, prim_desc=False, sec_desc=False, case_sensitive=False):
+ '''
+ Take an array (list of lists/tuples) with numeric or text values (or
+ mix of both) and sort it by a primary column and optionally by a
+ secondary column. It is tollerant to None values.
+
+ :param `array`: List of lists or tuples containing strings
+ or numbers.
+
+ :param `prim_col`: Index (integer) of primary sort column.
+
+ :param `sec_col`: Index (integer) of secondary sort column.
+
+ :param `prim_desc`: Boolean indicating sort order of primary sort
+ column(`True` for descending `False` for ascending)
+
+ :param `sec_desc`: Boolean indicating sort order of secondary sort
+ column(`True` for descending `False` for ascending)
+
+ :param `case_sensitive`: Boolean set to True if cases matters.
+
+ :return: The sorted array as list of tuples.
+ '''
+
+ # Determine if we need to convert values to str or float
+ prim_is_str = _determineApproach(array, prim_col)
+ if sec_col is not None and sec_col != prim_col:
+ sec_is_str = _determineApproach(array, sec_col)
+ else:
+ sec_col = None
+
+ # We mke use of the fact that sorted() is stable and first sort by
+ # the secondary sort column, if any, and then by the primary.
+
+ # Secondary Sort --------------------------------------------------
+ if sec_col is not None:
+ if sec_is_str and case_sensitive:
+ sorted_array = sorted(
+ array,
+ key=lambda r: str(r[sec_col]) if r[sec_col] is not None else "",
+ reverse=sec_desc
+ )
+ elif sec_is_str and not case_sensitive:
+ sorted_array = sorted(
+ array,
+ key=lambda r: str(r[sec_col]).lower() if r[sec_col] is not None else "",
+ reverse=sec_desc
+ )
+ else:
+ sorted_array = sorted(
+ array,
+ key=lambda r: float(r[sec_col]) if r[sec_col] is not None else float("-inf"),
+ reverse=sec_desc
+ )
+ array = sorted_array
+
+ # Primary Sort -----------------------------------------------------
+ if prim_is_str and case_sensitive:
+ sorted_array = sorted(
+ array,
+ key=lambda r: str(r[prim_col]) if r[prim_col] is not None else "",
+ reverse=prim_desc
+ )
+ elif prim_is_str and not case_sensitive:
+ sorted_array = sorted(
+ array,
+ key=lambda r: str(r[prim_col]).lower() if r[prim_col] is not None else "",
+ reverse=prim_desc
+ )
+ else:
+ sorted_array = sorted(
+ array,
+ key=lambda r: float(r[prim_col]) if r[prim_col] is not None else float("-inf"),
+ reverse=prim_desc
+ )
+
+ return sorted_array