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

psychopy/app/Resources/routine_templates/Basic.psyexp

@@ -53,7 +53,6 @@
     <Param val="CONTINUOUS" valType="str" updates="None" name="mgMove"/>
     <Param val="0.5" valType="num" updates="None" name="mgSaccade"/>
     <Param val="0.6" valType="num" updates="None" name="plConfidenceThreshold"/>
-    <Param val="True" valType="bool" updates="None" name="plPupilCaptureRecordingEnabled"/>
     <Param val="" valType="str" updates="None" name="plPupilCaptureRecordingLocation"/>
     <Param val="127.0.0.1" valType="str" updates="None" name="plPupilRemoteAddress"/>
     <Param val="50020" valType="num" updates="None" name="plPupilRemotePort"/>

psychopy/app/Resources/routine_templates/Misc.psyexp

@@ -53,7 +53,6 @@
     <Param val="CONTINUOUS" valType="str" updates="None" name="mgMove"/>
     <Param val="0.5" valType="num" updates="None" name="mgSaccade"/>
     <Param val="0.6" valType="num" updates="None" name="plConfidenceThreshold"/>
-    <Param val="True" valType="bool" updates="None" name="plPupilCaptureRecordingEnabled"/>
     <Param val="" valType="str" updates="None" name="plPupilCaptureRecordingLocation"/>
     <Param val="127.0.0.1" valType="str" updates="None" name="plPupilRemoteAddress"/>
     <Param val="50020" valType="num" updates="None" name="plPupilRemotePort"/>

psychopy/app/Resources/routine_templates/Online.psyexp

@@ -59,9 +59,7 @@
     <Param val="0.5" valType="num" updates="None" name="mgSaccade"/>
     <Param val="neon.local" valType="str" updates="None" name="plCompanionAddress"/>
     <Param val="8080" valType="num" updates="None" name="plCompanionPort"/>
-    <Param val="True" valType="bool" updates="None" name="plCompanionRecordingEnabled"/>
     <Param val="0.6" valType="num" updates="None" name="plConfidenceThreshold"/>
-    <Param val="True" valType="bool" updates="None" name="plPupilCaptureRecordingEnabled"/>
     <Param val="" valType="str" updates="None" name="plPupilCaptureRecordingLocation"/>
     <Param val="127.0.0.1" valType="str" updates="None" name="plPupilRemoteAddress"/>
     <Param val="50020" valType="num" updates="None" name="plPupilRemotePort"/>

psychopy/app/Resources/routine_templates/Trials.psyexp

@@ -53,7 +53,6 @@
     <Param val="CONTINUOUS" valType="str" updates="None" name="mgMove"/>
     <Param val="0.5" valType="num" updates="None" name="mgSaccade"/>
     <Param val="0.6" valType="num" updates="None" name="plConfidenceThreshold"/>
-    <Param val="True" valType="bool" updates="None" name="plPupilCaptureRecordingEnabled"/>
     <Param val="" valType="str" updates="None" name="plPupilCaptureRecordingLocation"/>
     <Param val="127.0.0.1" valType="str" updates="None" name="plPupilRemoteAddress"/>
     <Param val="50020" valType="num" updates="None" name="plPupilRemotePort"/>

psychopy/app/__init__.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).
 
 """Module for the PsychoPy GUI application.
@@ -33,7 +33,37 @@ _psychopyAppInstance = None
 REQUIRES_RESTART = False
 
 
-def startApp(showSplash=True, testMode=False, safeMode=False, startView=None):
+# Adapted from
+# https://code.activestate.com/recipes/580767-unix-tee-like-functionality-via-a-python-class/
+# (BSD 3-Clause)
+class _Tee(object):
+    def __init__(self, fid):
+        self._other_fid = fid
+
+    def write(self, s):
+        sys.__stdout__.write(s)
+        self._other_fid.write(s)
+
+    def writeln(self, s):
+        self.write(s + '\n')
+
+    def close(self):
+        self._other_fid.close()
+
+    def flush(self):
+        self._other_fid.flush()
+        sys.__stdout__.flush()
+
+
+def startApp(
+        showSplash=True, 
+        testMode=False, 
+        safeMode=False, 
+        startView=None,
+        startFiles=None,
+        firstRun=False,
+        profiling=False,
+    ):
     """Start the PsychoPy GUI.
 
     This function is idempotent, where additional calls after the app starts
@@ -88,14 +118,25 @@ def startApp(showSplash=True, testMode=False, safeMode=False, startView=None):
 
         # NOTE - messages and errors cropping up before this point will go to
         # console, afterwards to 'last_app_load.log'.
-        sys.stderr = sys.stdout = lastRunLog  # redirect output to file
+        if sys.platform == 'win32' and sys.executable.endswith('pythonw.exe'):
+            sys.stderr = sys.stdout = lastRunLog
+        else:
+            sys.stderr = sys.stdout = _Tee(lastRunLog)  # redirect output to file
 
     # Create the application instance which starts loading it.
     # If `testMode==True`, all messages and errors (i.e. exceptions) will log to
     # console.
     from psychopy.app._psychopyApp import PsychoPyApp
     _psychopyAppInstance = PsychoPyApp(
-        0, testMode=testMode, showSplash=showSplash, safeMode=safeMode, startView=startView)
+        0, 
+        testMode=testMode, 
+        showSplash=showSplash, 
+        safeMode=safeMode, 
+        startView=startView,
+        startFiles=startFiles,
+        firstRun=firstRun,
+        profiling=profiling,
+    )
 
     # After the app is loaded, we hand off logging to the stream dispatcher
     # using the provided log file path. The dispatcher will write out any log
@@ -148,7 +189,7 @@ def restartApp():
     """Restart the PsychoPy application instance.
 
     This will write a file named '.restart' to the user preferences directory
-    and quit the application. The presence of this file will indicate to the 
+    and quit the application. The presence of this file will indicate to the
     launcher parent process that the app should restart.
 
     The app restarts with the same arguments as the original launch. This is
@@ -160,11 +201,11 @@ def restartApp():
     """
     if not isAppStarted():
         return
-    
+
     # write a restart file to the user preferences directory
     from psychopy.preferences import prefs
     restartFilePath = os.path.join(prefs.paths['userPrefsDir'], '.restart')
-    
+
     with open(restartFilePath, 'w') as restartFile:
         restartFile.write('')  # empty file
 
@@ -288,7 +329,7 @@ def getAppFrame(frameName):
             _psychopyAppInstance.showRunner()
         else:
             raise AttributeError('Cannot load frame. Method not available.')
-        
+
         frameRef = getattr(_psychopyAppInstance, frameName, None)
 
     return frameRef

psychopy/app/__main__.py

@@ -0,0 +1,3 @@
+from psychopy.app.psychopyApp import main
+
+main()

psychopy/app/_psychopyApp.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 traceback
 from pathlib import Path
@@ -19,8 +19,6 @@ import argparse
 
 from psychopy.app.themes import icons, colors, handlers
 
-profiling = False  # turning on will save profile files in currDir
-
 import psychopy
 from psychopy import prefs
 from packaging.version import Version
@@ -51,7 +49,7 @@ from psychopy.localization import _translate
 # e.g. coder and builder are imported during app.__init__ because they
 # take a while
 
-# needed by splash screen for the path to resources/psychopySplash.png
+# needed by splash screen for the path to resources/splash.png
 import ctypes
 from psychopy import logging, __version__
 from psychopy import projects
@@ -123,7 +121,7 @@ class MenuFrame(wx.Frame, themes.handlers.ThemeMixin):
 class IDStore(dict):
     """A simpe class that works like a dict but you can access attributes
     like standard python attrs. Useful to replace the previous pre-made
-    app.IDs (wx.NewID() is no longer recommended or safe)
+    app.IDs (wx.NewIdRef(count=1) is no longer recommended or safe)
     """
     def __getattr__(self, attr):
         return self[attr]
@@ -166,7 +164,7 @@ class _Showgui_Hack():
 class PsychoPyApp(wx.App, handlers.ThemeMixin):
     _called_from_test = False  # pytest needs to change this
 
-    def __init__(self, arg=0, testMode=False, startView=None, **kwargs):
+    def __init__(self, arg=0, testMode=False, startView=None, profiling=False, **kwargs):
         """With a wx.App some things get done here, before App.__init__
         then some further code is launched in OnInit() which occurs after
         """
@@ -208,6 +206,7 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
 
         # set as false to disable loading plugins on startup
         self._safeMode = kwargs.get('safeMode', True)
+        self.firstRun = kwargs.get('firstRun', False)
 
         # Shared memory used for messaging between app instances, this gets
         # allocated when `OnInit` is called.
@@ -245,7 +244,11 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         self.locale.AddCatalog(self.GetAppName())
 
         logging.flush()
-        self.onInit(testMode=testMode, startView=startView, **kwargs)
+        self.onInit(
+            testMode=testMode, 
+            startView=startView, 
+            **kwargs
+        )
         if profiling:
             profile.disable()
             print("time to load app = {:.2f}".format(time.time()-t0))
@@ -378,7 +381,15 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
             for builderFrame in self.builder:
                 builderFrame.componentButtons.populate()
 
-    def onInit(self, showSplash=True, testMode=False, safeMode=False, startView=None):
+    def onInit(
+            self, 
+            showSplash=True, 
+            testMode=False, 
+            safeMode=False, 
+            startView=None,
+            startFiles=None,
+            firstRun=False,
+        ):
         """This is launched immediately *after* the app initialises with
         wxPython.
 
@@ -406,8 +417,14 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
 
         if showSplash:
             # show splash screen
-            splashFile = os.path.join(
-                self.prefs.paths['resources'], 'psychopySplash.png')
+            if str(__version__).endswith("beta"):
+                splashFile = os.path.join(
+                    self.prefs.paths['resources'], 'betasplash.png'
+                )
+            else:
+                splashFile = os.path.join(
+                    self.prefs.paths['resources'], 'splash.png'
+                )
             splashImage = wx.Image(name=splashFile)
             splashImage.ConvertAlphaToMask()
             splash = AS.AdvancedSplash(
@@ -415,7 +432,7 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
                 timeout=3000, agwStyle=AS.AS_TIMEOUT | AS.AS_CENTER_ON_SCREEN
             )
             w, h = splashImage.GetSize()
-            splash.SetTextPosition((340, h - 30))
+            splash.SetTextPosition((300, h - 30))
             splash.SetText(
                 _translate("Copyright (C) {year} OpenScienceTools.org").format(year=2024))
         else:
@@ -428,9 +445,6 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         # import coder and builder here but only use them later
         from psychopy.app import coder, builder, runner, dialogs
 
-        if '--firstrun' in sys.argv:
-            del sys.argv[sys.argv.index('--firstrun')]
-            self.firstRun = True
         if 'lastVersion' not in self.prefs.appData:
             # must be before 1.74.00
             last = self.prefs.appData['lastVersion'] = '1.73.04'
@@ -445,18 +459,25 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         # on a mac, don't exit when the last frame is deleted, just show menu
         if sys.platform == 'darwin':
             self.menuFrame = MenuFrame(parent=None, app=self)
-        # fetch prev files if that's the preference
-        if self.prefs.coder['reloadPrevFiles']:
-            scripts = self.prefs.appData['coder']['prevFiles']
-        else:
-            scripts = []
-        appKeys = list(self.prefs.appData['builder'].keys())
-        if self.prefs.builder['reloadPrevExp'] and ('prevFiles' in appKeys):
-            exps = self.prefs.appData['builder']['prevFiles']
-        else:
-            exps = []
-        runlist = []
+        
+        # get starting windows
+        if startView in (None, []):
+            # if no window specified, use default from prefs
+            if self.prefs.app['defaultView'] == 'all':
+                startView = ["builder", "coder", "runner"]
+            elif self.prefs.app['defaultView'] == "last":
+                if self.prefs.appData['lastFrame'] == "both" or not self.prefs.appData['lastFrame']:
+                    self.prefs.appData['lastFrame'] = "builder-coder-runner"
+                startView = self.prefs.appData['lastFrame'].split("-")
+            elif self.prefs.app['defaultView'] in ["builder", "coder", "runner"]:
+                startView = self.prefs.app['defaultView']
 
+        if not startView:  # if we still don't have a startView then load Builder
+            startView = ["builder"]
+
+        # load fonts
+        if splash:
+            splash.SetText(_translate("Loading app fonts..."))
         self.dpi = int(wx.GetDisplaySize()[0] /
                        float(wx.GetDisplaySizeMM()[0]) * 25.4)
         # detect retina displays
@@ -470,7 +491,6 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         # adjust dpi to something reasonable
         if not (50 < self.dpi < 120):
             self.dpi = 80  # dpi was unreasonable, make one up
-
         # Manage fonts
         if sys.platform == 'win32':
             # wx.SYS_DEFAULT_GUI_FONT is default GUI font in Win32
@@ -478,10 +498,9 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         else:
             self._mainFont = wx.SystemSettings.GetFont(wx.SYS_ANSI_FIXED_FONT)
             # rescale for tiny retina fonts
-
         if hasattr(wx.Font, "AddPrivateFont") and sys.platform != "darwin":
             # Load packaged fonts if possible
-            for fontFile in (Path(__file__).parent / "Resources" / "fonts").glob("*"):
+            for fontFile in (Path(__file__).parent.parent / "assets" / "fonts").glob("*"):
                 if fontFile.suffix in ['.ttf', '.truetype']:
                     wx.Font.AddPrivateFont(str(fontFile))
             # Set fonts as those loaded
@@ -498,126 +517,92 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
                                          wx.FONTFAMILY_TELETYPE,
                                          wx.FONTSTYLE_NORMAL,
                                          wx.FONTWEIGHT_NORMAL)
-
         if self.isRetina:
             self._codeFont.SetPointSize(int(self._codeFont.GetPointSize()*fontScale))
             self._mainFont.SetPointSize(int(self._mainFont.GetPointSize()*fontScale))
-
         # that gets most of the properties of _codeFont but the FaceName
         # FaceName is set in the setting of the theme:
         self.theme = prefs.app['theme']
 
-        # removed Aug 2017: on newer versions of wx (at least on mac)
-        # this looks too big
-        # if hasattr(self._mainFont, 'Larger'):
-        #     # Font.Larger is available since wyPython version 2.9.1
-        #     # PsychoPy still supports 2.8 (see ensureMinimal above)
-        #     self._mainFont = self._mainFont.Larger()
-        #     self._codeFont.SetPointSize(
-        #         self._mainFont.GetPointSize())  # unify font size
-
         # load plugins so they're available before frames are created
         if splash:
-            splash.SetText(_translate("  Loading plugins..."))
+            splash.SetText(_translate("Loading plugins..."))
         from psychopy.plugins import activatePlugins
         activatePlugins()
-        
-        # create both frame for coder/builder as necess
-        if splash:
-            splash.SetText(_translate("  Creating frames..."))
-        
-        # get starting windows
-        if startView in (None, []):
-            # if no window specified, use default from prefs
-            if self.prefs.app['defaultView'] == 'all':
-                startView = ["builder", "coder", "runner"]
-            elif self.prefs.app['defaultView'] == "last":
-                if self.prefs.appData['lastFrame'] == "both" or not self.prefs.appData['lastFrame']:
-                    self.prefs.appData['lastFrame'] = "builder-coder-runner"
-                startView = self.prefs.appData['lastFrame'].split("-")
-            elif self.prefs.app['defaultView'] in ["builder", "coder", "runner"]:
-                startView = self.prefs.app['defaultView']
 
-        if not startView:  # if we still don't have a startView then load Builder
-            startView = ["builder"]
+        # show frames
+        if splash:
+            splash.SetText(_translate("Creating frames..."))
         
         # if specified as a single string, convert to list
         if isinstance(startView, str):
             startView = [startView]
-        
-        # get files to open from commandline args
-        for arg in sys.argv:
-            if arg.endswith(".psyexp"):
-                exps.append(arg)
-            if arg.endswith(".py"):
-                if arg.endswith("psychopyApp.py"):
-                    # this is called erroneously when starting standalone app
-                    continue
-                else:
-                    scripts.append(arg)
-            if "runner" not in startView and arg.endswith(".psyrun"):
-                runlist.append(arg)
-        
-        # show frames according to files
-        if exps and "builder" not in startView:
-            startView.append("builder")
-        if scripts and "coder" not in startView:
-            startView.append("coder")
-        if runlist and "runner" not in startView:
-            startView.append("runner")
-
+        # if last open frame was no frame, use all instead
+        if not startView:
+            startView = ["builder", "coder", "runner"]
         # create windows
         if "runner" in startView:
-            # open Runner if requested
-            try:
-                self.showRunner(fileList=runlist)
-            except Exception as err:
-                # if Runner failed with file, try without
-                self.showRunner()
-                # log error
-                logging.error(_translate(
-                    "Failed to open Runner with requested file list, opening without file list.\n"
-                    "Requested: {}\n"
-                    "Err: {}"
-                ).format(runlist, err))
-                logging.debug(
-                    "\n".join(traceback.format_exception(err))
-                )
-
+            self.showRunner()
         if "coder" in startView:
-            # open Coder if requested
+            self.showCoder()
+        if "builder" in startView:
+            self.showBuilder()
+        # # if told to directly run stuff, do it now
+        # if "direct" in startView:
+        #     self.showRunner()
+        #     for exp in [file for file in sys.argv if file.endswith('.psyexp') or file.endswith('.py')]:
+        #         self.runner.panel.runFile(exp)
+        
+        # load starting files
+        if splash:
+            splash.SetText(_translate("Loading requested files..."))
+        # get starting files
+        if startFiles is None:
+            startFiles = []
+            # get last coder files
+            if self.prefs.coder['reloadPrevFiles']:
+                for thisFile in self.prefs.appData['coder']['prevFiles']:
+                    startFiles.append(thisFile)
+            # get last builder files
+            if self.prefs.builder['reloadPrevExp'] and ('prevFiles' in self.prefs.appData['builder']):
+                for thisFile in self.prefs.appData['builder']['prevFiles']:
+                    startFiles.append(thisFile)
+        # open start files
+        for thisFile in startFiles:
+            # convert to file object & skip any which aren't paths
             try:
-                self.showCoder(fileList=scripts)
-            except Exception as err:
-                # if Coder failed with file, try without
+                thisFile = Path(thisFile)
+            except:
+                continue
+            # skip nonexistent files
+            if not thisFile.is_file():
                 logging.error(_translate(
-                    "Failed to open Coder with requested scripts, opening with no scripts open.\n"
-                    "Requested: {}\n"
-                    "Err: {}"
-                ).format(scripts, err))
-                logging.debug(
-                    "\n".join(traceback.format_exception(err))
-                )
-                self.showCoder()
-        
-        if "builder" in startView:
-            # open Builder if requested
+                    "Failed to open {}, file does not exist."
+                ).format(thisFile))
+                continue
             try:
-                self.showBuilder(fileList=exps)
+                # choose frame based on extension
+                if "builder" in startView and thisFile.suffix == ".psyexp":
+                    # open .psyexp in Builder
+                    builder = self.showBuilder()
+                    if builder.fileExists:
+                        # if current builder file is a real file, open in new frame
+                        self.newBuilderFrame(fileName=str(thisFile))
+                    else:
+                        # otherwise, open in current
+                        builder.fileOpen(filename=thisFile)
+                elif "runner" in startView and thisFile.suffix == ".psyrun":
+                    # open .psyrun in Runner
+                    runner = self.showRunner()
+                    runner.fileOpen(filename=str(thisFile))
+                elif "coder" in startView and thisFile.suffix not in (".psyexp", ".psyrun"):
+                    # open anything else in Coder
+                    coder = self.showCoder()
+                    coder.fileOpen(filename=str(thisFile))
             except Exception as err:
-                # if Builder failed with file, try without
-                self.showBuilder()
-                # log error
                 logging.error(_translate(
-                    "Failed to open Builder with requested experiments, opening with no experiments open.\n"
-                    "Requested: {}\n"
-                    "Err: {}"
-                ).format(exps, err))
-        
-        if "direct" in startView:
-            self.showRunner()
-            for exp in [file for file in sys.argv if file.endswith('.psyexp') or file.endswith('.py')]:
-                self.runner.panel.runFile(exp)
+                    "Failed to open file {}, reason: {}"
+                ).format(thisFile, err))
 
         # if we started a busy cursor which never finished, finish it now
         if wx.IsBusy():
@@ -855,6 +840,8 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         self.SetTopWindow(self.coder)
         self.coder.Raise()
 
+        return self.coder
+
     def newBuilderFrame(self, event=None, fileName=None):
         # have to reimport because it is only local to __init__ so far
         wx.BeginBusyCursor()
@@ -868,6 +855,7 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         self.SetTopWindow(self.builder)
         self.updateWindowMenu()
         wx.EndBusyCursor()
+
         return self.builder
 
     def showBuilder(self, event=None, fileList=()):
@@ -880,12 +868,31 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         if len(self.getAllFrames(frameType="builder")) == 0:
             self.newBuilderFrame()
         # loop through all frames, from the back bringing each forward
+        thisFrame = None
         for thisFrame in self.getAllFrames(frameType='builder'):
             thisFrame.Show(True)
             thisFrame.Raise()
+            self.builder = thisFrame
             self.SetTopWindow(thisFrame)
+        
+        return self.builder
 
     def showRunner(self, event=None, fileList=[]):
+        """
+        Show the Runner window, if not shown already.
+
+        Parameters
+        ----------
+        event : wx.Event, optional
+            wx event, if called by a UI element, by default None
+        fileList : list[str or pathlib.Path], optional
+            List of files to open Runner with, by default []
+
+        Returns
+        -------
+        psychopy.app.runner.RunnerFrame
+            Current Runner frame
+        """
         if not self.runner:
             self.runner = self.newRunnerFrame()
         if not self.testMode:
@@ -895,6 +902,8 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         # Runner captures standard streams until program closed
         # if self.runner and not self.testMode:
         #     sys.stderr = sys.stdout = self.stdStreamDispatcher
+        
+        return self.runner
 
     def newRunnerFrame(self, event=None):
         # have to reimport because it is only local to __init__ so far
@@ -1090,7 +1099,7 @@ class PsychoPyApp(wx.App, handlers.ThemeMixin):
         info.SetVersion('v' + psychopy.__version__)
         info.SetDescription(msg)
 
-        info.SetCopyright('(C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.')
+        info.SetCopyright('(C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.')
         info.SetWebSite('https://www.psychopy.org')
         info.SetLicence(license)
         # developers