psychopy 2025.1.0__py3-none-any.whl → 2025.2.1__py3-none-any.whl

psychopy/app/plugin_manager/packages.py

@@ -1,6 +1,13 @@
+# -*- coding: utf-8 -*-
+
+# Part of the PsychoPy library
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
+# Distributed under the terms of the GNU General Public License (GPL).
+
 import webbrowser
 
 import wx
+import wx.dataview
 import os
 import sys
 import subprocess as sp
@@ -8,13 +15,22 @@ import subprocess as sp
 from psychopy.app import utils
 from psychopy.app.themes import handlers, icons
 from psychopy.localization import _translate
-from psychopy.tools.pkgtools import (
-    getInstalledPackages, getPackageMetadata, getPypiInfo, isInstalled,
-    _isUserPackage, getInstallState
-)
+from psychopy.tools.pkgtools import (getPackageMetadata, getPypiInfo)
+from psychopy.app.plugin_manager.packageIndex import (
+    getInstalledPackages, 
+    getRemotePackages, 
+    isUserPackageInstalled, 
+    isSystemPackageInstalled)
 from psychopy.tools.versionchooser import parseVersionSafely
 
 
+# data flags for package status
+PACKAGE_STATUS_INVALID = -1
+PACKAGE_STATUS_NOT_INSTALLED = 0
+PACKAGE_STATUS_INSTALLED_SYSTEM = 1
+PACKAGE_STATUS_INSTALLED_USER = 2  # installed and user package
+
+
 class PackageManagerPanel(wx.Panel):
     def __init__(self, parent, dlg):
         wx.Panel.__init__(self, parent)
@@ -24,21 +40,18 @@ class PackageManagerPanel(wx.Panel):
         self.SetSizer(self.border)
         self.sizer = wx.BoxSizer(wx.HORIZONTAL)
         self.border.Add(self.sizer, proportion=1, border=6, flag=wx.ALL | wx.EXPAND)
-        # Add package list
+        # self.packageList.Bind(wx.dataview.EVT_DATAVIEW_ITEM_ACTIVATED, self.onSelectItem)
+        self.detailsPanel = PackageDetailsPanel(self, dlg=self.dlg)
         self.packageList = PackageListCtrl(self, dlg=self.dlg)
-        self.packageList.Bind(wx.EVT_LIST_ITEM_SELECTED, self.onSelectItem)
         self.sizer.Add(self.packageList, flag=wx.EXPAND | wx.ALL)
-        # Seperator
         self.sizer.Add(wx.StaticLine(self, style=wx.LI_VERTICAL), border=6, flag=wx.EXPAND | wx.ALL)
-        # Add details panel
-        self.detailsPanel = PackageDetailsPanel(self, dlg=self.dlg)
         self.sizer.Add(self.detailsPanel, proportion=1, flag=wx.EXPAND | wx.ALL)
 
-    def onSelectItem(self, evt=None):
-        # Get package name
-        pipname = evt.GetText()
-        # Set pip details from name
-        self.detailsPanel.package = pipname
+    def refresh(self, evt=None):
+        # Refresh package list
+        self.packageList.searchCtrl.SetValue("")
+        self.packageList.refresh()
+        self.detailsPanel.package = None
 
 
 class PIPTerminalPanel(wx.Panel):
@@ -147,15 +160,47 @@ class PackageListCtrl(wx.Panel):
         self.sizer = wx.BoxSizer(wx.VERTICAL)
         self.border.Add(self.sizer, proportion=1, border=12, flag=wx.ALL | wx.EXPAND)
 
+        # parent package list control
+        self.parent = parent
+        self.packageDetailsPanel = self.parent.detailsPanel
+        
         # Search bar
-        self.searchCtrl = wx.SearchCtrl(self)
+        self.searchCtrl = wx.SearchCtrl(self, style=wx.TE_PROCESS_ENTER)
         self.searchCtrl.Bind(wx.EVT_SEARCH, self.refresh)
+        self.searchCtrl.Bind(wx.EVT_SEARCH_CANCEL, self.onSearchCancel)
+        self.searchCtrl.Bind(wx.EVT_TEXT, self.onSearchText)
         self.sizer.Add(self.searchCtrl, border=6, flag=wx.ALL | wx.EXPAND)
+
+        self.searchCtrl.ShowSearchButton(True)
+
         # Create list ctrl
-        self.ctrl = utils.ListCtrl(self, style=wx.LC_REPORT | wx.LC_SINGLE_SEL)
-        self.ctrl.setResizeColumn(0)
-        self.ctrl.Bind(wx.EVT_LIST_ITEM_SELECTED, self.onItemSelected)
-        self.ctrl.Bind(wx.EVT_LIST_ITEM_RIGHT_CLICK, self.onRightClick)
+        # self.ctrl = utils.ListCtrl(self, style=wx.LC_REPORT | wx.LC_SINGLE_SEL)
+        # self.ctrl.setResizeColumn(0)
+        # self.ctrl.Bind(wx.EVT_LIST_ITEM_SELECTED, self.onItemSelected)
+        # self.ctrl.Bind(wx.EVT_LIST_ITEM_RIGHT_CLICK, self.onRightClick)
+        # self.sizer.Add(self.ctrl, proportion=1, border=6, flag=wx.LEFT | wx.RIGHT | wx.EXPAND)
+
+        self.ctrl = wx.dataview.TreeListCtrl(self)
+        self.ctrl.SetMinSize((120, 400))
+        self.ctrl.AppendColumn(_translate("Package"))
+        self.ctrl.AppendColumn(_translate("Installed"))
+
+        self.rootUserPackages = self.ctrl.AppendItem(self.ctrl.GetRootItem(), _translate("User Packages"))
+        self.rootSystemPackages = self.ctrl.AppendItem(self.ctrl.GetRootItem(), _translate("System Packages"))  
+        self.rootRemotePackages = self.ctrl.AppendItem(self.ctrl.GetRootItem(), _translate("Available Packages"))
+
+        self.ctrl.SetItemText(self.rootUserPackages, _translate("User Packages"))
+        self.ctrl.SetItemText(self.rootSystemPackages, _translate("System Packages"))
+        self.ctrl.SetItemText(self.rootRemotePackages, _translate("Available Packages"))
+        self.ctrl.SetItemData(self.rootUserPackages, PACKAGE_STATUS_INVALID)
+        self.ctrl.SetItemData(self.rootSystemPackages, PACKAGE_STATUS_INVALID)
+        self.ctrl.SetItemData(self.rootRemotePackages, PACKAGE_STATUS_INVALID)
+        self.ctrl.SetColumnWidth(0, 200)
+        self.ctrl.SetColumnWidth(1, 100)
+
+        # self.ctrl.Bind(wx.dataview.EVT_TREELIST_ITEM_ACTIVATED, self.onItemSelected)
+        self.ctrl.Bind(wx.dataview.EVT_TREELIST_SELECTION_CHANGED, self.onItemSelected)
+        # self.ctrl.Bind(wx.dataview.EVT_DATAVIEW_ITEM_RIGHT_CLICK, self.onRightClick)
         self.sizer.Add(self.ctrl, proportion=1, border=6, flag=wx.LEFT | wx.RIGHT | wx.EXPAND)
 
         # "Or..." label
@@ -180,6 +225,30 @@ class PackageListCtrl(wx.Panel):
 
         self.Layout()
 
+    def onSearchText(self, evt=None):
+        """On text change in search box. Used to refresh the package list if
+        the search term is empty since the box doesn't trigger a search
+        when the text is cleared.
+        """
+        # Get search term
+        searchTerm = self.searchCtrl.GetValue()
+
+        if not searchTerm:
+            # If empty, refresh
+            self.refresh()
+            return
+        
+        if evt is not None:
+            evt.Skip()
+
+    def onSearchCancel(self, evt=None):
+        """On search cancel button pressed. Used to refresh the package list
+        if the search term is empty since the box doesn't trigger a search
+        when the text is cleared.
+        """
+        self.searchCtrl.SetValue("")
+        self.refresh()
+
     def onOpenPipTerminal(self, evt=None):
         # Make dialog
         dlg = wx.Dialog(self, title="PIP Terminal", size=(480, 480), style=wx.RESIZE_BORDER | wx.CAPTION | wx.CLOSE_BOX)
@@ -196,9 +265,18 @@ class PackageListCtrl(wx.Panel):
 
     def onItemSelected(self, evt=None):
         # Post event so it can be caught by parent
-        evt.SetEventObject(self)
-        wx.PostEvent(self, evt)
-
+        # evt.SetEventObject(self)
+        # wx.PostEvent(self, evt)
+
+        selection = evt.GetItem()
+        pipname = None
+        if selection.IsOk():
+            # check if valid
+            if self.ctrl.GetItemData(selection) != PACKAGE_STATUS_INVALID:
+                pipname = self.ctrl.GetItemText(selection)
+        
+        self.packageDetailsPanel.package = pipname
+        
     def onRightClick(self, evt=None):
         # Get package name
         package = evt.GetText()
@@ -206,11 +284,11 @@ class PackageListCtrl(wx.Panel):
         menu = wx.Menu()
         # Map menu functions
         menu.functions = {}
-        if isInstalled(package) and _isUserPackage(package):
+        if isUserPackageInstalled(package):
             # Add uninstall if installed to user
             uninstallOpt = menu.Append(wx.ID_ANY, item=_translate("Uninstall"))
             menu.functions[uninstallOpt.GetId()] = self.onUninstall
-        elif isInstalled(package):
+        elif isSystemPackageInstalled(package):
             # Add nothing if installed to protected system folder
             pass
         else:
@@ -257,35 +335,84 @@ class PackageListCtrl(wx.Panel):
         self.refresh()
 
     def refresh(self, evt=None):
+        # get states of items
+        rootRemoteWasExpanded = self.ctrl.IsExpanded(self.rootRemotePackages)
+        rootUserWasExpanded = self.ctrl.IsExpanded(self.rootUserPackages)
+        rootSystemWasExpanded = self.ctrl.IsExpanded(self.rootSystemPackages)
+
         # Get search term
         searchTerm = self.searchCtrl.GetValue()
-        # Clear
-        self.ctrl.ClearAll()
-        self.ctrl.AppendColumn(_translate("Package"))
-        self.ctrl.AppendColumn(_translate("Installed"))
-
-        # Get installed packages
+        self.ctrl.DeleteAllItems()
+
+        self.rootUserPackages = self.ctrl.AppendItem(
+            self.ctrl.GetRootItem(), _translate("User Packages"))
+        self.ctrl.SetItemData(self.rootUserPackages, PACKAGE_STATUS_INVALID)
+        self.rootSystemPackages = self.ctrl.AppendItem(
+            self.ctrl.GetRootItem(), _translate("System Packages"))  
+        self.ctrl.SetItemData(self.rootSystemPackages, PACKAGE_STATUS_INVALID)
+        self.rootRemotePackages = self.ctrl.AppendItem(
+            self.ctrl.GetRootItem(), _translate("Available Packages"))
+        self.ctrl.SetItemData(
+            self.rootRemotePackages, PACKAGE_STATUS_INVALID)
+
+        # get packages
         installedPackages = dict(getInstalledPackages())
-        # If there's no search term, show all installed and return
-        if searchTerm in (None, ""):
-            for pkg, version in installedPackages.items():
-                item = self.ctrl.Append((pkg, version))
-                self.ctrl.SetItemFont(item, font=wx.Font().Bold())
-            return
-        # Add column for latest version if we're actually searching
-        self.ctrl.AppendColumn(_translate("Latest"))
-        # Get packages from search
-        # Populate
-        for pkg, version in installedPackages.items():
-            if pkg is None:
-                continue
-            font = wx.Font()
-            if searchTerm in pkg:
-                # If installed, add row with value for installed version
-                item = self.ctrl.Append((pkg, version))
-                font = font.Bold()
-                # Style new row according to install status
-                self.ctrl.SetItemFont(item, font)
+
+        systemPackages = installedPackages['system']['packages']
+        userPackages = installedPackages['user']['packages']
+        availablePackages = getRemotePackages()['packages']
+        
+        # filter on search
+        if searchTerm not in (None, ""):
+            self.searchCtrl.ShowCancelButton(True)
+            systemPackages = {k: v for k, v in systemPackages.items() if searchTerm in k}
+            userPackages = {k: v for k, v in userPackages.items() if searchTerm in k}
+            availablePackages = [v for v in availablePackages if searchTerm in v]
+        else:
+            self.searchCtrl.ShowCancelButton(False)
+
+        for pkg, version in systemPackages.items():
+            item = self.ctrl.AppendItem(self.rootSystemPackages, pkg)
+            self.ctrl.SetItemText(item, 1, version)
+            self.ctrl.SetItemData(item, PACKAGE_STATUS_INSTALLED_SYSTEM)
+            # self.ctrl.SetItemFont(item, font=wx.Font().Bold())
+
+        self.ctrl.SetItemText(
+            self.rootSystemPackages, 
+            _translate("System Packages") + " (%d)" % len(systemPackages))
+
+        for pkg, version in userPackages.items():
+            item = self.ctrl.AppendItem(self.rootUserPackages, pkg)
+            self.ctrl.SetItemText(item, 1, version)
+            self.ctrl.SetItemData(item, PACKAGE_STATUS_INSTALLED_USER)
+            # self.ctrl.SetItemFont(item, font=wx.Font().Bold())
+
+        self.ctrl.SetItemText(
+            self.rootUserPackages,
+            _translate("User Packages") + " (%d)" % len(userPackages))
+    
+        if len(availablePackages) > 1000:
+            availablePackages = availablePackages[:1000]
+            self.ctrl.SetItemText(
+                self.rootRemotePackages,
+                _translate("Available Packages") + " (1000+)")
+        else:
+            totalSearchMatches = len(availablePackages)
+            self.ctrl.SetItemText(
+                self.rootRemotePackages,
+                _translate("Available Packages") + " (%d)" % totalSearchMatches)
+
+        for pkg in availablePackages:
+            item = self.ctrl.AppendItem(self.rootRemotePackages, pkg)
+            self.ctrl.SetItemData(item, PACKAGE_STATUS_NOT_INSTALLED)
+
+        # Expand all roots
+        if rootRemoteWasExpanded:
+            self.ctrl.Expand(self.rootRemotePackages)
+        if rootUserWasExpanded:
+            self.ctrl.Expand(self.rootUserPackages)
+        if rootSystemWasExpanded:
+            self.ctrl.Expand(self.rootSystemPackages)
 
     def onAddFromFile(self, evt=None):
         # Create dialog to get package file location
@@ -342,8 +469,8 @@ class PackageDetailsPanel(wx.Panel):
         self.installBtn.Bind(wx.EVT_BUTTON, self.onInstall)
         # Version chooser
         self.versionCtrl = wx.Choice(self)
+        # self.versionCtrl.Bind(wx.EVT_CHOICE, self.onVersionSelection)
         self.headBtnSzr.Add(self.versionCtrl, border=3, flag=wx.RIGHT | wx.TOP | wx.BOTTOM | wx.ALIGN_CENTER)
-        self.versionCtrl.Bind(wx.EVT_CHOICE, self.onVersion)
         # Uninstall button
         self.uninstallBtn = wx.Button(self, label=_translate("Uninstall"))
         self.headBtnSzr.AddStretchSpacer(1)
@@ -385,6 +512,7 @@ class PackageDetailsPanel(wx.Panel):
                 metadata = getPackageMetadata(self._package)
             else:
                 metadata = {}
+
             # Get best data available, prioritising local metadata
             self.params = {
                 'name': metadata.get('Name', pypiData.get('Name', pipname)),
@@ -413,7 +541,7 @@ class PackageDetailsPanel(wx.Panel):
         self.versionCtrl.Clear()
         self.versionCtrl.AppendItems(self.params['releases'])
         if self.params['version'] is None:
-            self.versionCtrl.SetSelection(0)
+            self.versionCtrl.SetSelection(self.versionCtrl.GetCount() - 1)
         else:
             if self.params['version'] not in self.versionCtrl.GetStrings():
                 self.versionCtrl.Append(self.params['version'])
@@ -423,31 +551,43 @@ class PackageDetailsPanel(wx.Panel):
         self.Layout()
         self._applyAppTheme()
 
+    # def onVersionSelection(self, evt=None):
+    #     # if the version matches the installed version, disable the install button
+    #     self.refresh()
+
     def refresh(self, evt=None):
-        state, version = getInstallState(self.package)
+        # check if the package is installed
+        installedPackages = dict(getInstalledPackages())
+        systemPackages = installedPackages['system']['packages']
+        userPackages = installedPackages['user']['packages']
+        availablePackages = getRemotePackages()['packages']
 
-        if state == "u":
+        pkgName = self.package
+        state = False
+        if pkgName in userPackages:
             # If installed to the user space, can be uninstalled or changed
             self.uninstallBtn.Enable()
             self.versionCtrl.Enable()
+            self.versionCtrl.SetStringSelection(userPackages[pkgName])
             self.installBtn.Enable(
-                self.versionCtrl.GetStringSelection() != version
+                self.versionCtrl.GetStringSelection() != userPackages[pkgName]
             )
-        elif state == "s":
-            # If installed to the system, can't be uninstalled or changed
-            self.uninstallBtn.Disable()
-            self.versionCtrl.Disable()
-            self.installBtn.Disable()
-        elif state == "n":
-            # If uninstalled, can only be installed
+            state = True
+        elif pkgName in availablePackages:
+            # If available but not installed, can be installed
             self.uninstallBtn.Disable()
             self.versionCtrl.Enable()
             self.installBtn.Enable()
+            self.versionCtrl.SetSelection(self.versionCtrl.GetCount() - 1)  # newest
+            state = True
         else:
-            # If None, disable everything
+            # If installed to the system, can't be uninstalled or changed
+            if pkgName in systemPackages:
+                self.versionCtrl.SetStringSelection(systemPackages[pkgName])
             self.uninstallBtn.Disable()
             self.versionCtrl.Disable()
             self.installBtn.Disable()
+
         # Disable all controls if we have None
         self.homeBtn.Enable(state is not None)
         self.nameCtrl.Enable(state is not None)