psychopy 2024.2.5__py3-none-any.whl → 2025.1.1__py3-none-any.whl

psychopy/app/plugin_manager/packages.py

@@ -4,7 +4,6 @@ import wx
 import os
 import sys
 import subprocess as sp
-from pypi_search import search as pypi
 
 from psychopy.app import utils
 from psychopy.app.themes import handlers, icons
@@ -63,17 +62,16 @@ class PIPTerminalPanel(wx.Panel):
         ):
             executable = f'"{executable}"'
         # Construct preface
-        self.preface = " ".join([executable, "-m"])
+        self.preface = " ".join([executable, "-m", "pip"])
         # Add output
         self.output = wx.richtext.RichTextCtrl(
             self,
             value=_translate(
-                "Type a PIP command below and press Enter to execute it in the installed PsychoPy environment, any "
-                "returned text will appear below.\n"
+                "Type pip commands below and press Enter to execute them in the installed PsychoPy environment, any returned text will appear below. When installing, remember to add `--user` on the end!\n"
                 "\n"
                 "All commands will be automatically prefaced with:\n"
                 "{}\n"
-                "\n"
+                "(so you don't need to type it yourself)\n"
             ).format(self.preface),
             size=(480, -1),
             style=wx.TE_READONLY)
@@ -277,19 +275,17 @@ class PackageListCtrl(wx.Panel):
         # Add column for latest version if we're actually searching
         self.ctrl.AppendColumn(_translate("Latest"))
         # Get packages from search
-        foundPackages = pypi.find_packages(self.searchCtrl.GetValue())
         # Populate
-        for pkg in foundPackages:
+        for pkg, version in installedPackages.items():
+            if pkg is None:
+                continue
             font = wx.Font()
-            if pkg['name'] in installedPackages:
+            if searchTerm in pkg:
                 # If installed, add row with value for installed version
-                item = self.ctrl.Append((pkg['name'], installedPackages[pkg['name']], pkg['version']))
+                item = self.ctrl.Append((pkg, version))
                 font = font.Bold()
-            else:
-                # Otherwise, add row with installed version blank
-                item = self.ctrl.Append((pkg['name'], "-", pkg['version']))
-            # Style new row according to install status
-            self.ctrl.SetItemFont(item, font)
+                # Style new row according to install status
+                self.ctrl.SetItemFont(item, font)
 
     def onAddFromFile(self, evt=None):
         # Create dialog to get package file location

psychopy/app/plugin_manager/plugins.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from packaging.version import Version
 import shutil
 
 import wx
@@ -209,12 +210,12 @@ class PluginInfo:
             current.remove(self.pipname)
         plugins.startUpPlugins(current, add=False, verify=False)
 
-    def install(self):
+    def install(self, forceReinstall=False):
         if self.parent is None:
             return
 
         wx.CallAfter(
-            self.parent.GetTopLevelParent().installPlugin, self)
+            self.parent.GetTopLevelParent().installPlugin, self, forceReinstall=forceReinstall)
 
     def uninstall(self):
         if self.parent is None:
@@ -227,6 +228,23 @@ class PluginInfo:
     def installed(self):
         return pkgtools.isInstalled(self.pipname)
 
+    @property
+    def installedVersion(self):
+        """
+        Returns
+        -------
+        Version or None
+            The version of this plugin which is installed, or None if it is not installed.
+        """
+        if self.installed:
+            try:
+                ver = plugins.pluginMetadata(self.pipname)["Version"]
+                return Version(ver)
+            except:
+                return None
+        else:
+            return None
+
     @property
     def author(self):
         if hasattr(self, "_author"):
@@ -243,6 +261,28 @@ class PluginInfo:
         else:
             # Otherwise, assume no author
             self._author = AuthorInfo()
+    
+    def getReleases(self):
+        """
+        Get known versions of this plugin.
+
+        Returns
+        -------
+        list[str]
+            List of version strings
+        """
+        # get package info
+        info = pkgtools.getPypiInfo(self.pipname, silence=True)
+        # convert all release numbers to Version objects
+        releases = []
+        for release in info.get('releases', []):
+            try:
+                ver = Version(release)
+                releases.append(ver)
+            except:
+                continue
+        
+        return releases
 
 
 class PluginManagerPanel(wx.Panel, handlers.ThemeMixin):
@@ -764,6 +804,13 @@ class PluginDetailsPanel(wx.Panel, handlers.ThemeMixin):
         self.installBtn.SetBitmapMargins(6, 3)
         self.installBtn.Bind(wx.EVT_BUTTON, self.onInstall)
         self.buttonSizer.Add(self.installBtn, border=3, flag=wx.ALL | wx.EXPAND)
+        # update btn
+        self.updateBtn = wx.Button(self, label=_translate("Update"))
+        self.updateBtn.SetBitmap(
+            icons.ButtonIcon("plus", 16).bitmap
+        )
+        self.updateBtn.Bind(wx.EVT_BUTTON, self.onUpdate)
+        self.buttonSizer.Add(self.updateBtn, border=3, flag=wx.ALL | wx.EXPAND)
         # uninstall btn
         self.uninstallBtn = wx.Button(self, label=_translate("Uninstall"))
         self.uninstallBtn.SetBitmap(
@@ -867,14 +914,14 @@ class PluginDetailsPanel(wx.Panel, handlers.ThemeMixin):
             active=active
         )
 
-    def _doInstall(self):
+    def _doInstall(self, forceReinstall=None):
         """Routine to run the installation of a package after the `onInstall`
         event is processed.
         """
         # mark as pending
         self.markInstalled(None)
         # install
-        self.info.install()
+        self.info.install(forceReinstall=forceReinstall)
         # mark according to install success
         self.markInstalled(self.info.installed)
     
@@ -893,6 +940,11 @@ class PluginDetailsPanel(wx.Panel, handlers.ThemeMixin):
         if evt is not None and hasattr(evt, 'Skip'):
             evt.Skip()
     
+    def onUpdate(self, evt=None):
+        wx.CallAfter(self._doInstall, forceReinstall=True)  # call after processing button events
+        if evt is not None and hasattr(evt, 'Skip'):
+            evt.Skip()
+    
     def onUninstall(self, evt=None):
         """
         Event called when the uninstall button is clicked.
@@ -993,6 +1045,14 @@ class PluginDetailsPanel(wx.Panel, handlers.ThemeMixin):
         self.pipName.SetLabelText(value.pipname)
         # Set installed
         self.markInstalled(value.installed)
+        # show/hide update button
+        releases = self.info.getReleases()
+        if releases:
+            self.updateBtn.Show(
+                self.info.installed 
+                and self.info.installedVersion is not None 
+                and self.info.installedVersion < max(releases)
+            )
         # Enable/disable homepage
         self.homepageBtn.Enable(bool(self.info.homepage))
         # Set activated

psychopy/app/preferencesDlg.py

@@ -12,11 +12,11 @@ import re
 import os
 
 from psychopy.app.themes import icons
+from psychopy.hardware.speaker import SpeakerDevice
 from . import dialogs
 from psychopy import localization, prefs
 from psychopy.localization import _translate
 from packaging.version import Version
-from psychopy import sound
 from psychopy.app.utils import getSystemFonts
 import collections
 
@@ -243,7 +243,7 @@ class PrefPropGrid(wx.Panel):
             pagePtr.Clear()
 
             for s in sections:
-                _ = pagePtr.Append(pg.PropertyCategory(s, s))
+                _ = pagePtr.Append(pg.PropertyCategory(_translate(s), s))
                 for name, prop in self.sections[s].items():
                     if name in prefs.legacy:
                         # If this is included in the config file only for legacy, don't show it
@@ -429,7 +429,12 @@ class PreferencesDlg(wx.Dialog):
 
         # get sound devices for "audioDevice" property
         try:
-            devnames = sorted(sound.getDevices('output'))
+            devnames = [profile['deviceName'] for profile in SpeakerDevice.getAvailableDevices()]
+            # prefs need to have a default value, but we need an actual device - so remove it from 
+            # the dialog
+            if 'default' in devnames:
+                devnames.pop('default')
+
         except (ValueError, OSError, ImportError, AttributeError):
             devnames = []
 
@@ -468,7 +473,7 @@ class PreferencesDlg(wx.Dialog):
                         thisPref = thisPref.replace('Ctrl+', 'Cmd+')
 
                 # can we translate this pref?
-                pLabel = prefName
+                pLabel = _translate(prefName)
 
                 # get tooltips from comment lines from the spec, as parsed by
                 # configobj
@@ -552,36 +557,6 @@ class PreferencesDlg(wx.Dialog):
                             labels=labels,
                             values=[i for i in range(len(labels))],
                             value=default, helpText=helpText)
-                # # audio latency mode for the PTB driver
-                elif prefName == 'audioLatencyMode':
-                    # get the labels from above
-                    labels = []
-                    for val, labl in audioLatencyLabels.items():
-                        labels.append(u'{}: {}'.format(val, labl))
-
-                    # get the options from the config file spec
-                    vals = thisSpec.replace("option(", "").replace("'", "")
-                    # item -1 is 'default=x' from spec
-                    vals = vals.replace(", ", ",").split(',')
-
-                    try:
-                        # set the field to the value in the pref
-                        default = int(thisPref)
-                    except ValueError:
-                        try:
-                            # use first if default not in list
-                            default = int(vals[-1].strip('()').split('=')[1])
-                        except (IndexError, TypeError, ValueError):
-                            # no default
-                            default = 0
-
-                    self.proPrefs.addEnumItem(
-                            sectionName,
-                            pLabel,
-                            prefName,
-                            labels=labels,
-                            values=[i for i in range(len(labels))],
-                            value=default, helpText=helpText)
                 # # option items are given a dropdown, current value is shown
                 # # in the box
                 elif thisSpec.startswith('option') or prefName == 'audioDevice':
@@ -610,7 +585,7 @@ class PreferencesDlg(wx.Dialog):
 
                     labels = []  # display only
                     for opt in options:
-                        labels.append(opt)
+                        labels.append(_translate(opt))
 
                     self.proPrefs.addEnumItem(
                             sectionName,
@@ -701,8 +676,8 @@ class PreferencesDlg(wx.Dialog):
                             newVal = eval(thisPref)
                     except Exception:
                         # if eval() failed, show warning dialog and return
-                        pLabel = prefName
-                        sLabel = sectionName
+                        pLabel = _translate(prefName)
+                        sLabel = _translate(sectionName)
                         txt = _translate(
                             'Invalid value in "%(pref)s" ("%(section)s" Tab)')
                         msg = txt % {'pref': pLabel, 'section': sLabel}

psychopy/app/psychopyApp.py

@@ -2,9 +2,11 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# 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 argparse
+from pathlib import Path
 import sys
 
 # fix macOS locale-bug on startup: sets locale to LC_ALL (must be defined!)
@@ -16,58 +18,130 @@ import psychopy.locale_setup  # noqa
 # file now used solely as a launcher for the app, not as the app itself.
 
 
-def start_app():
+def main():
     from psychopy.app import startApp, quitApp
     from psychopy.preferences import prefs
 
-    showSplash = prefs.app['showSplash']
-    if '--no-splash' in sys.argv:
-        showSplash = False
-        del sys.argv[sys.argv.index('--no-splash')]
-    _ = startApp(showSplash=showSplash)  # main loop
-    quitApp()
+    # parser to process input arguments
+    argParser = argparse.ArgumentParser(
+        prog="PsychoPyApp", description=(
+"""Starts the PsychoPy application.
 
+Usage:  python psychopy.app [options] [files]
 
-def main():
-    if '-x' in sys.argv:
-        # run a .py script from the command line using StandAlone python
-        targetScript = sys.argv[sys.argv.index('-x') + 1]
+Without options or files provided this starts PsychoPy using prefs to
+decide on the view(s) to open.  If optional [files] is provided action
+depends on the type of the [files]:
+
+ Python script 'file.py' -- opens coder
+
+ Experiment design 'file.psyexp' -- opens builder
+ """
+        )
+    )
+    # first argument is always the calling script
+    argParser.add_argument("callscript")
+    # recognise version query
+    argParser.add_argument(
+        "--version", "-v", dest="version", action="store_true", help=(
+        "Print the current PsychoPy version."
+    ))
+    # add option to directly run a script
+    argParser.add_argument(
+        "--direct", "-x", dest="direct", action="store_true", help=(
+            "Use PsychoPy to run a Python script (.py) or a PsychoPy experiment (.psyexp), without "
+            "opening the app."
+        )
+    )
+    # add options for starting view
+    argParser.add_argument(
+        "--builder", "-b", dest="startView", const="builder", action="append_const", help=(
+            "Open PsychoPy with a Builder window open. Combine with --coder/-c and --runner/-r "
+            "to open a specific set of frames."
+        )
+    )
+    argParser.add_argument(
+        "--coder", "-c", dest="startView", const="coder", action="append_const", help=(
+            "Open PsychoPy with the Coder window open. Combine with --builder/-b and --runner/-r "
+            "to open a specific set of frames."
+        )
+    )
+    argParser.add_argument(
+        "--runner", "-r", dest="startView", const="runner", action="append_const", help=(
+            "Open PsychoPy with the Runner window open. Combine with --coder/-c and --builder/-b "
+            "to open a specific set of frames."
+        )
+    )
+    # add option to show config wizard
+    argParser.add_argument(
+        "--firstrun", dest="firstRun", action="store_true", help=(
+            "Launches configuration wizard"
+        )
+    )
+    # add option to hide splash
+    argParser.add_argument(
+        "--no-splash", dest="showSplash", action="store_false", default=prefs.app['showSplash'], help=(
+            "Suppresses splash screen"
+        )
+    )
+    # add option to include app profiling
+    argParser.add_argument(
+        "--profiling", dest="profiling", action="store_true", help=(
+            "Launches app with profiling to see what specific processes are taking up resources."
+        )
+    )
+    # parse args
+    args, startFilesRaw = argParser.parse_known_args(sys.argv)
+    # pathify startFiles
+    startFiles = None
+    for thisFile in startFilesRaw:
+        if startFiles is None:
+            startFiles = []
+        try:
+            startFiles.append(Path(thisFile))
+        except:
+            print(
+                "Could not interpret {} as a path.".format(thisFile)
+            )
+            continue
+
+    # run files directly if requested
+    if args.direct:
         from psychopy import core
         import os
-        core.shellCall([sys.executable, os.path.abspath(targetScript)])
+        # make sure there's a file to run
+        assert startFiles, (
+            "Argument -x was used to directly run a script or experiment, but no script or "
+            "experiment path was given."
+        )
+        # run all .py scripts from the command line using StandAlone python
+        for targetScript in startFiles:
+            # skip non-runnable files
+            if targetScript.suffix not in (".psyexp", ".py"):
+                print(
+                    "Could not run file '{}' as it is not a Python script or PsychoPy experiment."
+                    .format(targetScript)
+                )
+                continue
+            # compile Python code if given a psyexp
+            if targetScript.suffix == ".psyexp":
+                from psychopy import experiment
+                exp = experiment.Experiment.fromFile(targetScript)
+                script = exp.writeScript()
+                targetScript = targetScript.parent / (targetScript.stem + ".py")
+                targetScript.write_text(script, encoding="utf-8")
+            # run file
+            stderr = core.shellCall([sys.executable, targetScript.absolute()], stderr=True)
+            for line in stderr:
+                print(line)
         sys.exit()
+    # print version info if requested
     if '-v' in sys.argv or '--version' in sys.argv:
         from psychopy import __version__
         msg = ('PsychoPy3, version %s (c)Jonathan Peirce 2018, GNU GPL license'
                % __version__)
         print(msg)
         sys.exit()
-    if '-h' in sys.argv or '--help' in sys.argv:
-        print("""Starts the PsychoPy3 application.
-
-Usage:  python PsychoPy.py [options] [file]
-
-Without options or files provided this starts PsychoPy using prefs to
-decide on the view(s) to open.  If optional [file] is provided action
-depends on the type of the [file]:
-
- Python script 'file.py' -- opens coder
-
- Experiment design 'file.psyexp' -- opens builder
-
-Options:
-    -c, --coder, coder       opens coder view only
-    -b, --builder, builder   opens builder view only
-    -x script.py             execute script.py using StandAlone python
-
-    -v, --version    prints version and exits
-    -h, --help       prints this help and exit
-
-    --firstrun       launches configuration wizard
-    --no-splash      suppresses splash screen
-
-""")
-        sys.exit()
 
     if (sys.platform == 'darwin' and
             ('| packaged by conda-forge |' in sys.version or
@@ -89,9 +163,7 @@ Options:
         # Therefore `pythonw` often doesn't exist, and we can just use `python`.
         if PYTHONW != 'True' and os.path.isfile(pyw_exe):
             from psychopy import core
-            cmd = [pyw_exe, __file__]
-            if '--no-splash' in sys.argv:
-                cmd.append('--no-splash')
+            cmd = [pyw_exe] + sys.argv
 
             stdout, stderr = core.shellCall(cmd,
                                             env=dict(env, PYTHONW='True'),
@@ -100,9 +172,23 @@ Options:
             print(stderr, file=sys.stderr)
             sys.exit()
         else:
-            start_app()
+            startApp(
+                startView=args.startView, 
+                showSplash=args.showSplash, 
+                startFiles=startFiles,
+                firstRun=args.firstRun,
+                profiling=args.profiling
+            )
     else:
-        start_app()
+        # start app
+        _ = startApp(
+            startView=args.startView, 
+            showSplash=args.showSplash, 
+            startFiles=startFiles,
+            firstRun=args.firstRun,
+            profiling=args.profiling
+        )
+        quitApp()
 
 
 if __name__ == '__main__':

psychopy/app/ribbon.py

@@ -412,6 +412,7 @@ class FrameRibbonSection(wx.Panel, handlers.ThemeMixin):
         # set color
         self.SetBackgroundColour(colors.app['frame_bg'])
         self.SetForegroundColour(colors.app['text'])
+        self.label.SetForegroundColour(colors.app['text'])
         # set bitmaps again
         self._icon.reload()
         self.icon.SetBitmap(self._icon.bitmap)

psychopy/app/runner/runner.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# 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 glob
 import json
@@ -24,7 +24,7 @@ import webbrowser
 from pathlib import Path
 from subprocess import Popen, PIPE
 
-from psychopy import experiment, logging
+from psychopy import experiment, logging, alerts
 from psychopy.app.utils import FrameSwitcher, FileDropTarget
 from psychopy.localization import _translate
 from psychopy.projects.pavlovia import getProject
@@ -538,7 +538,7 @@ class RunnerPanel(wx.Panel, ScriptProcess, handlers.ThemeMixin):
         self.splitter.SplitVertically(
             window1=self.topPanel,
             window2=self.bottomPanel,
-            sashPosition=480
+            sashPosition=360
         )
         self.splitter.SetMinimumPaneSize(360)
 
@@ -693,7 +693,7 @@ class RunnerPanel(wx.Panel, ScriptProcess, handlers.ThemeMixin):
         # start server
         self.startServer(htmlPath, port=port)
         # open experiment
-        webbrowser.open("http://localhost:{}".format(port))
+        webbrowser.open("http://localhost:{}?__pilotToken=local".format(port))
         # log experiment open
         print(
             f"##### Running PsychoJS task from {htmlPath} on port {port} #####\n"
@@ -1050,7 +1050,12 @@ class RunnerPanel(wx.Panel, ScriptProcess, handlers.ThemeMixin):
 
 class RunnerOutputNotebook(aui.AuiNotebook, handlers.ThemeMixin):
     def __init__(self, parent):
-        aui.AuiNotebook.__init__(self, parent, style=wx.BORDER_NONE)
+        aui.AuiNotebook.__init__(
+            self, 
+            parent, 
+            style=wx.BORDER_NONE, 
+            agwStyle=aui.AUI_NB_CLOSE_ON_ALL_TABS
+        )
 
         # store pages by non-translated names for easy access (see RunnerFrame.getOutputPanel)
         self.panels = {}
@@ -1065,6 +1070,7 @@ class RunnerOutputNotebook(aui.AuiNotebook, handlers.ThemeMixin):
             self.alertsPnl, caption=_translate("Alerts")
         )
         self.panels['alerts'] = self.alertsPnl
+        alerts.addAlertHandler(self.alertsPnl.ctrl)
 
         # StdOut
         self.stdoutPnl = ScriptOutputPanel(
@@ -1091,8 +1097,14 @@ class RunnerOutputNotebook(aui.AuiNotebook, handlers.ThemeMixin):
         # bind function when page receives focus
         self._readCache = {}
         self.Bind(aui.EVT_AUINOTEBOOK_PAGE_CHANGED, self.onFocus)
-
-        self.SetMinSize(wx.Size(100, 100))  # smaller than window min size
+        # min size is 80 chars / 40 lines
+        self.SetMinSize(wx.Size(
+            self.stdoutPnl.GetCharWidth() * 80, 
+            self.stdoutPnl.GetCharHeight() * 40, 
+        ))
+        # hide close buttons on tabs
+        for i in range(self.GetPageCount()):
+            self.SetCloseButton(i, False)
 
     def setRead(self, i, state):
         """

psychopy/app/runner/scriptProcess.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 """Utilities for running scripts from the PsychoPy application suite.
@@ -297,11 +297,16 @@ class ScriptProcess:
             Program exit code.
 
         """
-        # write a close message, shows the exit code
-        closeMsg = \
-            " Experiment ended with exit code {} [pid:{}] ".format(
-                exitCode, pid)
-        closeMsg = closeMsg.center(80, '#') + '\n'
+        # write a close message, shows the exit code if there is one
+        if exitCode:
+            closeMsg = (
+                " Experiment ended with exit code {ec} [pid:{pid}] "
+            )
+        else:
+            closeMsg = (
+                " Experiment completed [pid:{pid}] "
+            )
+        closeMsg = closeMsg.format(ec=exitCode, pid=pid).center(64, '#') + '\n'
         self._writeOutput(closeMsg)
 
         self.scriptProcess = None  # reset

psychopy/app/stdout/stdOutRich.py

@@ -7,7 +7,7 @@ import re
 import wx.richtext
 import locale
 
-from psychopy import prefs
+from psychopy import prefs, alerts
 from psychopy.localization import _translate
 from psychopy.app.utils import sanitize
 #!/usr/bin/env python
@@ -16,7 +16,7 @@ from psychopy.app.utils import sanitize
 """Classes and functions for the script output."""
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# 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 re
@@ -390,6 +390,13 @@ class ScriptOutputCtrl(StdOutRich, handlers.ThemeMixin):
 
         self.errors = []
         self.alerts = []
+    
+    def __del__(self):
+        """
+        If setup as an alert handler, remove self on deletion.
+        """
+        if alerts.isAlertHandler(self):
+            alerts.removeAlertHandler(self)
 
 
 if __name__ == "__main__":

psychopy/app/themes/fonts.py

@@ -568,7 +568,7 @@ def extractFaceNames(val):
     # Make sure val is a list
     if isinstance(val, str):
         # Get rid of any perentheses
-        val = re.sub("[\(\)\[\]]", "", val)
+        val = re.sub(r"[\(\)\[\]]", "", val)
         # Split by comma
         val = val.split(",")
     # Clear style markers