Merge pull request LykosAI#1225 from ionite34/backport/main/pr-1224

mohnjiles · web-flow · commit 5aa4780e17d4 · 2026-04-09T19:22:47.000-07:00
[dev to main] backport: Refactor Teaching Tip logic in MainPackageManagerView.  (1224)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning 2.0](https://semver.org/spec/v2
 - Settings file saves are now atomic to prevent corruption from interrupted writes
 ### Fixed
 - Fixed an issue where `Align Your Steps` scheduler and Unet Loader workflows ignored Regional Prompting (and other addon) conditioning modifiers.
-- Potentially fixed [#1578](https://github.com/LykosAI/StabilityMatrix/issues/1578) - `SocketException: Address already in use` on Linux startup by cleaning stale interprocess socket files and reactivating the existing window
+- Fixed the Package Manager "Add Package" teaching tip opening inopportunely while packages were still loading or after opening the add-package dialog
 - Fixed bold text not rendering in markdown dialogs on Windows 11 due to Avalonia 11.3.x variable font regression with Segoe UI Variable Text
 - Fixed Japanese text appearing compressed/squished in markdown dialogs by ensuring the bundled NotoSansJP font is used for CTextBlock rendering
 - Fixed ContentDialog title and buttons not using the correct font for Japanese locale (NotoSansJP) when shown as overlay
@@ -27,6 +27,8 @@ and this project adheres to [Semantic Versioning 2.0](https://semver.org/spec/v2
 - Fixed dropdown menu overlayed in Inference UI Model Cards not being scrollable on Linux - thanks to @NeuralFault!
 - Fixed [#1590](https://github.com/LykosAI/StabilityMatrix/issues/1590) - Startup crash when settings file is corrupted. Settings files are now self-healing with automatic recovery from null bytes, truncated JSON, and missing brackets
 - Fixed [#1397](https://github.com/LykosAI/StabilityMatrix/issues/1397), [#610](https://github.com/LykosAI/StabilityMatrix/issues/610) - duplicate pip package entries in results - thanks to @e-nord!
+- Fixed [#1596](https://github.com/LykosAI/StabilityMatrix/issues/1596) - package installs and managed embedded Python startup being poisoned by inherited shell Python activation variables such as `PYTHONHOME`, `PYTHONPATH`, `VIRTUAL_ENV`, and Conda environment variables
+- Potentially fixed [#1578](https://github.com/LykosAI/StabilityMatrix/issues/1578) - `SocketException: Address already in use` on Linux startup by cleaning stale interprocess socket files and reactivating the existing window
 
 ## v2.15.6
 ### Added
diff --git a/StabilityMatrix.Avalonia/Program.cs b/StabilityMatrix.Avalonia/Program.cs
@@ -61,6 +61,7 @@ public static class Program
     public static void Main(string[] args)
     {
         StartupTimer.Start();
+        ProcessRunner.SanitizeCurrentProcessPythonEnvironment();
 
         SetDebugBuild();
 
diff --git a/StabilityMatrix.Avalonia/ViewModels/PackageManager/MainPackageManagerViewModel.cs b/StabilityMatrix.Avalonia/ViewModels/PackageManager/MainPackageManagerViewModel.cs
@@ -3,6 +3,7 @@
 using AsyncAwaitBestPractices;
 using Avalonia.Controls;
 using Avalonia.Threading;
+using CommunityToolkit.Mvvm.ComponentModel;
 using CommunityToolkit.Mvvm.Input;
 using DynamicData;
 using DynamicData.Binding;
@@ -61,6 +62,9 @@ public partial class MainPackageManagerViewModel : PageViewModelBase
     public IObservableCollection<PackageCardViewModel> PackageCards { get; } =
         new ObservableCollectionExtended<PackageCardViewModel>();
 
+    [ObservableProperty]
+    private bool isAddPackageTeachingTipOpen;
+
     private DispatcherTimer timer;
 
     public MainPackageManagerViewModel(
@@ -112,11 +116,13 @@ private void OnOneClickInstallFinished(object? sender, bool e)
     public void SetPackages(IEnumerable<InstalledPackage> packages)
     {
         installedPackages.Edit(s => s.Load(packages));
+        UpdateAddPackageTeachingTip();
     }
 
     public void SetUnknownPackages(IEnumerable<InstalledPackage> packages)
     {
         unknownInstalledPackages.Edit(s => s.Load(packages));
+        UpdateAddPackageTeachingTip();
     }
 
     protected override async Task OnInitialLoadedAsync()
@@ -151,7 +157,9 @@ public override async Task OnLoadedAsync()
         if (Design.IsDesignMode || !settingsManager.IsLibraryDirSet)
             return;
 
+        IsAddPackageTeachingTipOpen = false;
         await LoadPackages();
+        UpdateAddPackageTeachingTip();
 
         timer.Start();
     }
@@ -164,6 +172,7 @@ public override void OnUnloaded()
 
     public void ShowInstallDialog(BasePackage? selectedPackage = null)
     {
+        IsAddPackageTeachingTipOpen = false;
         NavigateToSubPage(typeof(PackageInstallBrowserViewModel));
     }
 
@@ -237,6 +246,11 @@ private void NavigateToSubPage(Type viewModelType)
         );
     }
 
+    private void UpdateAddPackageTeachingTip()
+    {
+        IsAddPackageTeachingTipOpen = Packages.Count == 0;
+    }
+
     private void OnInstalledPackagesChanged(object? sender, EventArgs e) =>
-        OnLoadedAsync().SafeFireAndForget();
+        Dispatcher.UIThread.InvokeAsync(OnLoadedAsync).SafeFireAndForget();
 }
diff --git a/StabilityMatrix.Avalonia/Views/PackageManager/MainPackageManagerView.axaml b/StabilityMatrix.Avalonia/Views/PackageManager/MainPackageManagerView.axaml
@@ -607,7 +607,7 @@
             Name="TeachingTip1"
             Title="{x:Static lang:Resources.TeachingTip_AddPackageToGetStarted}"
             Grid.Row="0"
-            IsOpen="{Binding !Packages.Count}"
+            IsOpen="{Binding IsAddPackageTeachingTipOpen}"
             PreferredPlacement="Top"
             Target="{Binding #AddPackagesButton}" />
 
diff --git a/StabilityMatrix.Core/Processes/ProcessRunner.cs b/StabilityMatrix.Core/Processes/ProcessRunner.cs
@@ -1,4 +1,4 @@
-﻿using System.Diagnostics;
+using System.Diagnostics;
 using System.Text;
 using NLog;
 using StabilityMatrix.Core.Exceptions;
@@ -10,6 +10,121 @@ public static class ProcessRunner
 {
     private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
+    // Managed Python/uv subprocesses should not inherit ambient Python/venv activation state.
+    private static readonly string[] PythonEnvironmentVariablesToSanitize =
+    [
+        "PYTHONHOME",
+        "PYTHONPATH",
+        "PYTHONSTARTUP",
+        "PYTHONUSERBASE",
+        "PYTHONEXECUTABLE",
+        "__PYVENV_LAUNCHER__",
+        "VIRTUAL_ENV",
+        "CONDA_PREFIX",
+        "CONDA_DEFAULT_ENV",
+    ];
+
+    public static void SanitizeCurrentProcessPythonEnvironment(bool setNoUserSite = true)
+    {
+        var removedKeys = new List<string>();
+        foreach (var key in PythonEnvironmentVariablesToSanitize)
+        {
+            if (Environment.GetEnvironmentVariable(key, EnvironmentVariableTarget.Process) is null)
+                continue;
+
+            Environment.SetEnvironmentVariable(key, null, EnvironmentVariableTarget.Process);
+            removedKeys.Add(key);
+        }
+
+        if (setNoUserSite)
+        {
+            Environment.SetEnvironmentVariable("PYTHONNOUSERSITE", "1", EnvironmentVariableTarget.Process);
+        }
+
+        if (removedKeys.Count > 0)
+        {
+            Logger.Debug(
+                "Removed inherited Python environment variables from current process: [{Keys}]",
+                string.Join(", ", removedKeys)
+            );
+        }
+    }
+
+    internal static void PrepareEnvironment(
+        ProcessStartInfo info,
+        string fileName,
+        IEnumerable<KeyValuePair<string, string>>? environmentVariables
+    )
+    {
+        if (UsesPythonRuntime(fileName))
+        {
+            var explicitKeys =
+                environmentVariables?.Select(kvp => kvp.Key).ToHashSet(StringComparer.OrdinalIgnoreCase)
+                ?? [];
+
+            var removedKeys = new List<string>();
+            foreach (var key in PythonEnvironmentVariablesToSanitize)
+            {
+                if (explicitKeys.Contains(key))
+                    continue;
+
+                if (info.Environment.Remove(key))
+                {
+                    removedKeys.Add(key);
+                }
+            }
+
+            if (!explicitKeys.Contains("PYTHONNOUSERSITE"))
+            {
+                info.Environment["PYTHONNOUSERSITE"] = "1";
+            }
+
+            if (removedKeys.Count > 0)
+            {
+                Logger.Debug(
+                    "Removed inherited Python environment variables: [{Keys}]",
+                    string.Join(", ", removedKeys)
+                );
+            }
+        }
+
+        ApplyEnvironmentVariables(info, environmentVariables);
+    }
+
+    internal static bool UsesPythonRuntime(string fileName)
+    {
+        var executableName = Path.GetFileNameWithoutExtension(fileName);
+        if (string.IsNullOrWhiteSpace(executableName))
+            return false;
+
+        return executableName.StartsWith("python", StringComparison.OrdinalIgnoreCase)
+            || executableName.StartsWith("pypy", StringComparison.OrdinalIgnoreCase)
+            || executableName.StartsWith("pip", StringComparison.OrdinalIgnoreCase)
+            || executableName.Equals("uv", StringComparison.OrdinalIgnoreCase)
+            || executableName.Equals("uvx", StringComparison.OrdinalIgnoreCase);
+    }
+
+    private static void ApplyEnvironmentVariables(
+        ProcessStartInfo info,
+        IEnumerable<KeyValuePair<string, string>>? environmentVariables
+    )
+    {
+        if (environmentVariables is null)
+            return;
+
+        var keys = new List<string>();
+        foreach (var (key, value) in environmentVariables)
+        {
+            info.EnvironmentVariables[key] = value;
+            keys.Add(key);
+        }
+
+        if (keys.Count > 0)
+        {
+            Logger.Debug("Setting environment variables: [{Keys}]", string.Join(", ", keys));
+        }
+    }
+
     /// <summary>
     /// Opens the given URL in the default browser.
     /// </summary>
@@ -169,13 +284,7 @@ public static async Task<string> GetProcessOutputAsync(
             CreateNoWindow = true,
         };
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                info.EnvironmentVariables[key] = value;
-            }
-        }
+        PrepareEnvironment(info, fileName, environmentVariables);
 
         if (workingDirectory != null)
         {
@@ -218,13 +327,7 @@ public static async Task<ProcessResult> GetProcessResultAsync(
             info.StandardErrorEncoding = Encoding.UTF8;
         }
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                info.EnvironmentVariables[key] = value;
-            }
-        }
+        PrepareEnvironment(info, fileName, environmentVariables);
 
         if (workingDirectory != null)
         {
@@ -297,13 +400,7 @@ public static async Task<ProcessResult> GetAnsiProcessResultAsync(
             CreateNoWindow = true,
         };
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                info.EnvironmentVariables[key] = value;
-            }
-        }
+        PrepareEnvironment(info, fileName, environmentVariables);
 
         if (workingDirectory != null)
         {
@@ -420,13 +517,7 @@ public static Process StartProcess(
             CreateNoWindow = true,
         };
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                info.EnvironmentVariables[key] = value;
-            }
-        }
+        PrepareEnvironment(info, fileName, environmentVariables);
 
         if (workingDirectory != null)
         {
@@ -468,13 +559,7 @@ public static AnsiProcess StartAnsiProcess(
             CreateNoWindow = true,
         };
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                info.EnvironmentVariables[key] = value;
-            }
-        }
+        ApplyEnvironmentVariables(info, environmentVariables);
 
         if (workingDirectory != null)
         {
@@ -525,13 +610,7 @@ public static async Task<ProcessResult> RunBashCommand(
             WorkingDirectory = workingDirectory,
         };
 
-        if (environmentVariables != null)
-        {
-            foreach (var (key, value) in environmentVariables)
-            {
-                processInfo.EnvironmentVariables[key] = value;
-            }
-        }
+        ApplyEnvironmentVariables(processInfo, environmentVariables);
 
         using var process = new Process();
         process.StartInfo = processInfo;
diff --git a/StabilityMatrix.Tests/Core/ProcessRunnerTests.cs b/StabilityMatrix.Tests/Core/ProcessRunnerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public static class Program`
`61`	`61`	`public static void Main(string[] args)`
`62`	`62`	`{`
`63`	`63`	`StartupTimer.Start();`
	`64`	`+ ProcessRunner.SanitizeCurrentProcessPythonEnvironment();`
`64`	`65`
`65`	`66`	`SetDebugBuild();`
`66`	`67`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using AsyncAwaitBestPractices;`
`4`	`4`	`using Avalonia.Controls;`
`5`	`5`	`using Avalonia.Threading;`
	`6`	`+using CommunityToolkit.Mvvm.ComponentModel;`
`6`	`7`	`using CommunityToolkit.Mvvm.Input;`
`7`	`8`	`using DynamicData;`
`8`	`9`	`using DynamicData.Binding;`
`@@ -61,6 +62,9 @@ public partial class MainPackageManagerViewModel : PageViewModelBase`
`61`	`62`	`public IObservableCollection<PackageCardViewModel> PackageCards { get; } =`
`62`	`63`	`new ObservableCollectionExtended<PackageCardViewModel>();`
`63`	`64`
	`65`	`+ [ObservableProperty]`
	`66`	`+ private bool isAddPackageTeachingTipOpen;`
	`67`	`+`
`64`	`68`	`private DispatcherTimer timer;`
`65`	`69`
`66`	`70`	`public MainPackageManagerViewModel(`
`@@ -112,11 +116,13 @@ private void OnOneClickInstallFinished(object? sender, bool e)`
`112`	`116`	`public void SetPackages(IEnumerable<InstalledPackage> packages)`
`113`	`117`	`{`
`114`	`118`	`installedPackages.Edit(s => s.Load(packages));`
	`119`	`+ UpdateAddPackageTeachingTip();`
`115`	`120`	`}`
`116`	`121`
`117`	`122`	`public void SetUnknownPackages(IEnumerable<InstalledPackage> packages)`
`118`	`123`	`{`
`119`	`124`	`unknownInstalledPackages.Edit(s => s.Load(packages));`
	`125`	`+ UpdateAddPackageTeachingTip();`
`120`	`126`	`}`
`121`	`127`
`122`	`128`	`protected override async Task OnInitialLoadedAsync()`
`@@ -151,7 +157,9 @@ public override async Task OnLoadedAsync()`
`151`	`157`	`if (Design.IsDesignMode \|\| !settingsManager.IsLibraryDirSet)`
`152`	`158`	`return;`
`153`	`159`
	`160`	`+ IsAddPackageTeachingTipOpen = false;`
`154`	`161`	`await LoadPackages();`
	`162`	`+ UpdateAddPackageTeachingTip();`
`155`	`163`
`156`	`164`	`timer.Start();`
`157`	`165`	`}`
`@@ -164,6 +172,7 @@ public override void OnUnloaded()`
`164`	`172`
`165`	`173`	`public void ShowInstallDialog(BasePackage? selectedPackage = null)`
`166`	`174`	`{`
	`175`	`+ IsAddPackageTeachingTipOpen = false;`
`167`	`176`	`NavigateToSubPage(typeof(PackageInstallBrowserViewModel));`
`168`	`177`	`}`
`169`	`178`
`@@ -237,6 +246,11 @@ private void NavigateToSubPage(Type viewModelType)`
`237`	`246`	`);`
`238`	`247`	`}`
`239`	`248`
	`249`	`+ private void UpdateAddPackageTeachingTip()`
	`250`	`+ {`
	`251`	`+ IsAddPackageTeachingTipOpen = Packages.Count == 0;`
	`252`	`+ }`
	`253`	`+`
`240`	`254`	`private void OnInstalledPackagesChanged(object? sender, EventArgs e) =>`
`241`		`- OnLoadedAsync().SafeFireAndForget();`
	`255`	`+ Dispatcher.UIThread.InvokeAsync(OnLoadedAsync).SafeFireAndForget();`
`242`	`256`	`}`