[gui] Support user site-packages plugin install GUI

libretiny-eu · Mar 9, 2024 · 48f90e1 · 48f90e1
1 parent 7ad41da
commit 48f90e1
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 3 deletions.
diff --git a/ltchiptool/gui/main.py b/ltchiptool/gui/main.py
@@ -85,7 +85,7 @@ def __init__(self, *args, **kw):
 
         windows = [
             ("flash", FlashPanel),
-            ("plugins", (not ltim.is_bundled) and PluginsPanel),
+            ("plugins", PluginsPanel),
             ("install", ltim.is_gui_entrypoint and os.name == "nt" and InstallPanel),
             ("about", AboutPanel),
         ]

diff --git a/ltchiptool/gui/panels/plugins.py b/ltchiptool/gui/panels/plugins.py
@@ -11,6 +11,7 @@
 from ltchiptool.gui.utils import on_event, with_event
 from ltchiptool.gui.work.plugins import PluginsThread
 from ltchiptool.util.lpm import LPM
+from ltchiptool.util.ltim import LTIM
 from ltctplugin.base import PluginBase
 
 from .base import BasePanel
@@ -223,6 +224,7 @@ def __init__(self, parent: wx.Window, frame):
         self.LoadXRC("PluginsPanel")
         self.AddToNotebook("Plugins")
 
+        self.ltim = LTIM.get()
         self.lpm = LPM.get()
         self.model = PluginsDataModel()
         self.results: list[LPM.SearchResult] = []
@@ -242,6 +244,29 @@ def __init__(self, parent: wx.Window, frame):
         self.InstallInput = self.BindTextCtrl("input_install")
         self.InstallButton = self.BindButton("button_install", self.OnInstallClick)
 
+        self.SitePath = self.BindTextCtrl("input_site_path")
+        self.SiteReason = self.FindStaticText("text_site_reason")
+
+        reason = "unknown"
+        if self.ltim.is_bundled:
+            if self.ltim.is_windows():
+                reason = "running Windows .EXE bundle"
+            elif self.ltim.is_macos():
+                reason = "running macOS App Bundle"
+            else:
+                reason = "running a bundled copy"
+        elif self.lpm.plugin_site_path:
+            reason = "path set in sitecustomize.py"
+        elif self.ltim.is_dev:
+            reason = "development copy - editable"
+        elif "site-packages" in __file__:
+            reason = "installed using pip"
+
+        self.SitePath.SetLabelText(
+            str(self.lpm.plugin_site_path or "Python-default site-packages")
+        )
+        self.SiteReason.SetLabel(f"(reason: {reason})")
+
     def OnWorkStopped(self, t: PluginsThread):
         super().OnWorkStopped(t)
         if t.search:

diff --git a/ltchiptool/gui/res/ltchiptool.wxui b/ltchiptool/gui/res/ltchiptool.wxui
@@ -650,6 +650,20 @@
         orientation="wxVERTICAL"
         var_name="sizer_main_plugins"
         flags="wxEXPAND">
+        <node
+          class="wxStaticText"
+          label="Plugins will be installed to:"
+          borders="wxTOP|wxRIGHT|wxLEFT" />
+        <node
+          class="wxTextCtrl"
+          style="wxTE_READONLY"
+          var_name="input_site_path"
+          flags="wxEXPAND" />
+        <node
+          class="wxStaticText"
+          label="(reason: unknown)"
+          var_name="text_site_reason"
+          borders="wxBOTTOM|wxRIGHT|wxLEFT" />
         <node
           class="wxDataViewCtrl"
           style="wxDV_HORIZ_RULES"
@@ -663,7 +677,7 @@
           flags="wxEXPAND">
           <node
             class="wxButton"
-            label="Download plugins..."
+            label="Search for plugins..."
             var_name="button_download"
             flags="wxEXPAND" />
           <node

diff --git a/ltchiptool/gui/res/ltchiptool.xrc b/ltchiptool/gui/res/ltchiptool.xrc
@@ -782,6 +782,29 @@
 		<style>wxTAB_TRAVERSAL</style>
 		<object class="wxBoxSizer" name="sizer_main_plugins">
 			<orient>wxVERTICAL</orient>
+			<object class="sizeritem">
+				<flag>wxTOP|wxRIGHT|wxLEFT</flag>
+				<border>5</border>
+				<object class="wxStaticText" name="m_staticText">
+					<label>Plugins will be installed to:</label>
+					<wrap>-1</wrap>
+				</object>
+			</object>
+			<object class="sizeritem">
+				<flag>wxALL|wxEXPAND</flag>
+				<border>5</border>
+				<object class="wxTextCtrl" name="input_site_path">
+					<style>wxTE_READONLY</style>
+				</object>
+			</object>
+			<object class="sizeritem">
+				<flag>wxBOTTOM|wxRIGHT|wxLEFT</flag>
+				<border>5</border>
+				<object class="wxStaticText" name="text_site_reason">
+					<label>(reason: unknown)</label>
+					<wrap>-1</wrap>
+				</object>
+			</object>
 			<object class="sizeritem">
 				<flag>wxALL|wxEXPAND</flag>
 				<border>5</border>
@@ -799,7 +822,7 @@
 						<flag>wxALL|wxEXPAND</flag>
 						<border>5</border>
 						<object class="wxButton" name="button_download">
-							<label>Download plugins...</label>
+							<label>Search for plugins...</label>
 						</object>
 					</object>
 					<object class="sizeritem">