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

psychopy/preferences/preferences.py

@@ -6,6 +6,7 @@ import os
 import sys
 import platform
 from pathlib import Path
+from psychopy import logging
 from .. import __version__
 
 from packaging.version import Version
@@ -22,14 +23,14 @@ except ImportError:
 
 
 if _haveConfigobj:  # Use the "global" installation.
-    from configobj import ConfigObj
+    from configobj import ConfigObj, ConfigObjError
     try:
         from configobj import validate
     except ImportError:  # Older versions of configobj
         import validate
 else:  # Use our contrib package if configobj is not installed or too old.
     from psychopy.contrib import configobj
-    from psychopy.contrib.configobj import ConfigObj
+    from psychopy.contrib.configobj import ConfigObj, ConfigObjError
     from psychopy.contrib.configobj import validate
 join = os.path.join
 
@@ -175,7 +176,7 @@ class Preferences:
                 if err.errno != errno.EEXIST:
                     raise
 
-        # root site-packages directory for user-installed packages and add it
+        # site-packages root directory for user-installed packages
         userPkgRoot = Path(self.paths['packages'])
 
         # Package paths for custom user site-packages, these should be compliant
@@ -188,6 +189,42 @@ class Preferences:
         elif sys.platform == 'darwin' and sys._framework:  # macos + framework
             pyVersion = sys.version_info
             pyDirName = "python{}.{}".format(pyVersion[0], pyVersion[1])
+
+            # determine if we should use symlinks for the package folders if the
+            # user already has package installed
+            useSymlinks = (
+                Path(self.paths['packages']) / 'include' / pyDirName).exists()
+
+            # Standard scheme of lib directories for OSX framework does not
+            # distinguish between python versions. We must modify the
+            # site-packages root directory to provide a unique path for
+            # each python version.
+            userPkgRoot = Path(self.paths['packages']) / pyDirName
+            try:
+                os.makedirs(userPkgRoot)
+            except OSError as err:
+                if err.errno != errno.EEXIST:
+                    raise
+            
+            if useSymlinks:
+                # create symlinks to refer to the old package directories
+                oldUserPackageRoot = Path(self.paths['packages'])
+                userPackages = userPkgRoot / "lib"
+                userInclude = userPkgRoot / "include"
+                userScripts = userPkgRoot / "bin"
+
+                # create symlinks to the python version agnostic directories
+                if not userPackages.exists():
+                    userPackages.symlink_to(oldUserPackageRoot / "lib")
+                if not userInclude.exists():
+                    userInclude.symlink_to(oldUserPackageRoot / "include")
+                if not userScripts.exists():
+                    userScripts.symlink_to(oldUserPackageRoot / "bin")
+
+            # reload userPkgRoot
+            self.paths['packages'] = userPkgRoot = Path(self.paths['packages'])  
+            # See the ox_framework_user scheme standard:
+            # https://docs.python.org/3/library/sysconfig.html#osx-framework-user
             userPackages = userPkgRoot / "lib" / "python" / "site-packages"
             userInclude = userPkgRoot / "include" / pyDirName
             userScripts = userPkgRoot / "bin"
@@ -283,11 +320,25 @@ class Preferences:
                 msg = ("Preferences.py failed to create folder %s. Settings"
                        " will be read-only")
                 print(msg % self.paths['userPrefsDir'])
-        # then get the configuration file
-        cfg = ConfigObj(self.paths['userPrefsFile'],
-                        encoding='UTF8', configspec=self.prefsSpec)
-        # cfg.validate(self._validator, copy=False)  # merge then validate
-        # don't cfg.write(), see explanation above
+        # load configuration from file
+        try:
+            cfg = ConfigObj(
+                self.paths['userPrefsFile'], encoding='UTF8', configspec=self.prefsSpec
+            )
+        except ConfigObjError as err:
+            # if invalid, print a warning and reset to defaults
+            logging.warn(
+                f"Failed to load preferences file, falling back to defaults. Reason:\n{err}"
+            )
+            # create blank config
+            cfg = ConfigObj(
+                None, encoding='UTF8', configspec=self.prefsSpec
+            )
+            # point blank config object to file
+            cfg.filename = self.paths['userPrefsFile']
+            # overwrite existing prefs
+            cfg.write()
+        
         return cfg
 
     def saveUserPrefs(self):
@@ -305,11 +356,29 @@ class Preferences:
         appDir = Path(self.paths['appDir'])
         if not appDir.is_dir():  # if no app dir this may be just lib install
             return {}
-        # fetch appData too against a config spec
-        appDataSpec = ConfigObj(join(self.paths['appDir'], 'appData.spec'),
-                                encoding='UTF8', list_values=False)
-        cfg = ConfigObj(self.paths['appDataFile'],
-                        encoding='UTF8', configspec=appDataSpec)
+        # get spec to validate configuration against
+        appDataSpec = ConfigObj(
+            join(self.paths['appDir'], 'appData.spec'), encoding='UTF8', list_values=False
+        )
+        # get configuration from file
+        try:
+            cfg = ConfigObj(
+                self.paths['appDataFile'], encoding='UTF8', configspec=appDataSpec
+            )
+        except ConfigObjError as err:
+            # if invalid, print a warning and reset to defaults
+            logging.warn(
+                f"Failed to load preferences file, falling back to defaults. Reason:\n{err}"
+            )
+            # create blank config
+            cfg = ConfigObj(
+                None, encoding='UTF8', configspec=appDataSpec
+            )
+            # point blank config object to file
+            cfg.filename = self.paths['appDataFile']
+            # overwrite existing prefs
+            cfg.write()
+        # validate configuration
         resultOfValidate = cfg.validate(self._validator,
                                         copy=True,
                                         preserve_errors=True)

psychopy/projects/__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).
 
 """Helper functions in PsychoPy for interacting with projects (e.g. from pavlovia)

psychopy/projects/pavlovia.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).
 
 """Helper functions in PsychoPy for interacting with Pavlovia.org
@@ -33,6 +33,10 @@ try:
     haveGit = True
 except ImportError:
     haveGit = False
+# message to show when git is needed and not installed (format with action that failed)
+noGitMsg = _translate(
+    "Failed to {} as Pavlovia works via git, which is not installed on this machine. You can install git from here: https://git-scm.com/downloads"
+)
 
 import requests
 import gitlab
@@ -1109,9 +1113,11 @@ class PavloviaProject(dict):
         elif localFiles:
             # get project name
             if "/" in self.stringId:
-                _, projectName = self.stringId.split("/")
+                _, projectName = self.stringId.split("/", maxsplit=1)
             else:
                 projectName = self.stringId
+            # remove extra / from project name
+            projectName = projectName.replace("/", "")
             # ask user if they want to clone to a subfolder
             msg = _translate(
                     "Folder '{localRoot}' is not empty, use '{localRoot}/{projectName}' instead?"
@@ -1401,8 +1407,10 @@ class PavloviaProject(dict):
 def getGitRoot(p):
     """Return None or the root path of the repository"""
     if not haveGit:
-        raise exceptions.DependencyError(
-                "gitpython and a git installation required for getGitRoot()")
+        logging.warn(
+            noGitMsg.format(_translate("get git root"))
+        )
+        return None
 
     p = pathlib.Path(p).absolute()
     if not p.is_dir():
@@ -1432,8 +1440,10 @@ def getNameWithNamespace(p):
     """
     # Work out cwd
     if not haveGit:
-        raise exceptions.DependencyError(
-                "gitpython and a git installation required for getGitRoot()")
+        logging.warn(
+            noGitMsg.format(_translate("get project name"))
+        )
+        return None
 
     p = pathlib.Path(p).absolute()
     if not p.is_dir():
@@ -1446,14 +1456,14 @@ def getNameWithNamespace(p):
                             universal_newlines=True)  # newlines forces stdout to unicode
     stdout, stderr = proc.communicate()
     # Find a gitlab url in the response
-    url = re.match("https:\/\/gitlab\.pavlovia\.org\/\w*\/\w*\.git", stdout)
+    url = re.match(r"https:\/\/gitlab\.pavlovia\.org\/\w*\/\w*\.git", stdout)
     if url:
         # Get contents of url from response
         url = url.string[url.pos:url.endpos]
         # Get namespace/name string from url
         path = url
-        path = re.sub("\.git[.\n]*", "", path)
-        path = re.sub("[.\n]*https:\/\/gitlab\.pavlovia\.org\/", "", path)
+        path = re.sub(r"\.git[.\n]*", "", path)
+        path = re.sub(r"[.\n]*https:\/\/gitlab\.pavlovia\.org\/", "", path)
         return path
     else:
         return None
@@ -1464,8 +1474,10 @@ def getProject(filename):
     """
     # Check that we have Git
     if not haveGit:
-        raise exceptions.DependencyError(
-                "gitpython and a git installation required for getProject()")
+        logging.warn(
+            noGitMsg.format(_translate("get Pavlovia project"))
+        )
+        return None
     # Get git root
     gitRoot = getGitRoot(filename)
     # Get name with namespace
@@ -1477,7 +1489,9 @@ def getProject(filename):
     # If already found, return
     if (knownProjects is not None) and (path in knownProjects) and ('idNumber' in knownProjects[path]):
         # Make sure we are logged in
-        nameSpace, projectName = path.split("/")
+        nameSpace, projectName = path.split("/", maxsplit=1)
+        # remove extra slashes from project name
+        projectName = projectName.replace("/", "")
         # Try to log in if not logged in
         if not session.user:
             if nameSpace in knownUsers:
@@ -1523,7 +1537,9 @@ def getProject(filename):
                     # Remove .git
                     namespaceName = namespaceName.replace(".git", "")
                     # Split to get namespace
-                    nameSpace, projectName = namespaceName.split('/')
+                    nameSpace, projectName = namespaceName.split("/", maxsplit=1)
+                    # remove extra slashes from project name
+                    projectName = projectName.replace("/", "")
                     # Get current session
                     pavSession = getCurrentSession()
                     # Try to log in if not logged in

psychopy/scripts/psyexpCompile.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 io

psychopy/session.py

@@ -252,7 +252,7 @@ class Session:
             priorityThreshold=constants.priority.EXCLUDE+1,
             params=None,
             liaison=None,
-            restMsg="Rest..."
+            restMsg="Rest"
         ):
         # Store root and add to Python path
         self.root = Path(root)
@@ -273,6 +273,8 @@ class Session:
             dataDir / f"session_{wallTime}.log",
             level=getattr(logging, loggingLevel.upper())
         )
+        if liaison is not None:
+            liaison.logger.addTarget(self.logFile)
         # Store priority threshold
         self.priorityThreshold = priorityThreshold
         # Add experiments
@@ -290,14 +292,23 @@ class Session:
             # If win is the name of an experiment, setup from that experiment's method
             self.win = None
             self.setupWindowFromExperiment(win)
-        # Setup Session clock
+        # setup experiment clock
         if clock in (None, "float"):
             clock = core.Clock()
         elif clock == "iso":
             clock = core.Clock(format=str)
         elif isinstance(clock, str):
             clock = core.Clock(format=clock)
-        self.sessionClock = clock
+        self.experimentClock = clock
+        # setup session clock (same format as experiment clock)
+        if clock in (None, "float"):
+            self.sessionClock = core.Clock()
+        elif clock == "iso":
+            self.sessionClock = core.Clock(format=str)
+        elif isinstance(clock, str):
+            self.sessionClock = core.Clock(format=clock)
+        else:
+            self.sessionClock = core.Clock()
         # make sure we have a default keyboard
         if DeviceManager.getDevice("defaultKeyboard") is None:
             DeviceManager.addDevice(
@@ -724,7 +735,7 @@ class Session:
 
         return True
 
-    def setupWindowFromParams(self, params, measureFrameRate=False, blocking=True):
+    def setupWindowFromParams(self, params, measureFrameRate=False, recreate=True, blocking=True):
         """
         Create/setup a window from a dict of parameters
 
@@ -735,6 +746,8 @@ class Session:
             __init__ signature of psychopy.visual.Window
         measureFrameRate : bool
             If True, will measure frame rate upon window creation.
+        recreate : bool
+            If True, will close and recreate the window as needed
         blocking : bool
             Should calling this method block the current thread?
 
@@ -761,6 +774,29 @@ class Session:
                 params
             )
             return True
+        
+        # figure out whether we need to recreate the window
+        needsRecreate = False
+        for param in ("fullscr", "size", "pos", "screen"):
+            # skip params not specified
+            if param not in params:
+                continue
+            # skip all if there's no window
+            if self.win is None:
+                continue
+            # if param has changed, we'll need to recreate the window to apply it
+            if getattr(self.win, param) != params[param]:
+                needsRecreate = True
+                # if not allowed to recreate, warn
+                if not recreate:
+                    logging.warn(
+                        f"Changing Window.{param} requires the Window to be recreated, but "
+                        "`Session.setupWindowFromParams` was called with `recreate=False`."
+                    )
+        # if recreating, close window so we make a new one
+        if recreate and needsRecreate:
+            self.win.close()
+            self.win = None
 
         if self.win is None:
             # If win is None, make a Window
@@ -778,8 +814,10 @@ class Session:
         self.win.title = "PsychoPy Session"
         # Measure frame rate
         if measureFrameRate:
+            frameRate = self.getFrameRate(retest=True)
             expInfo = self.getCurrentExpInfo()
-            expInfo['frameRate'] = self.win.getActualFrameRate()
+            if expInfo is not False:
+                expInfo['frameRate'] = frameRate
 
         return True
 
@@ -1030,13 +1068,23 @@ class Session:
         logging.info(_translate(
             "Running experiment via Session: name={key}, expInfo={expInfo}"
         ).format(key=key, expInfo=expInfo))
+        # reset session clock
+        self.experimentClock.reset()
+        # send start event to liaison
+        if self.liaison is not None:
+            self.sendToLiaison({
+                    'type': "experiment_status",
+                    'name': thisExp.name,
+                    'status': constants.STARTED,
+                    'expInfo': expInfo
+                })
         # Run this experiment
         try:
             self.experiments[key].run(
                 expInfo=expInfo,
                 thisExp=thisExp,
                 win=self.win,
-                globalClock=self.sessionClock,
+                globalClock=self.experimentClock,
                 thisSession=self
             )
         except Exception as _err:
@@ -1171,6 +1219,31 @@ class Session:
             )
         
         return trials
+    
+    def pauseLoop(self):
+        """
+        Pause the current loop of the current experiment. Note that this will not take effect until 
+        the loop would next iterate.
+
+        Returns
+        -------
+        bool or None
+            True if the operation completed successfully
+        """
+        # warn and return failed if no experiment is running
+        if self.currentExperiment is None:
+            logging.warn(_translate(
+                "Could not pause loop as there is no experiment running."
+            ))
+            return False
+        # warn and return failed if not in a loop
+        if self.currentExperiment.currentLoop is self.currentExperiment:
+            logging.warn(_translate(
+                "Could not pause loop as the current experiment is not in a loop."
+            ))
+            return False
+        # pause loop
+        self.currentExperiment.currentLoop.status = constants.PAUSED
 
     def pauseExperiment(self):
         """
@@ -1249,7 +1322,7 @@ class Session:
         if self.currentExperiment is None:
             return
         # skip trials in current loop
-        self.currentExperiment.skipTrials(n)
+        return self.currentExperiment.skipTrials(n)
 
     def rewindTrials(self, n=1):
         """
@@ -1270,7 +1343,7 @@ class Session:
         if self.currentExperiment is None:
             return
         # rewind trials in current loop
-        self.currentExperiment.rewindTrials(n)
+        return self.currentExperiment.rewindTrials(n)
 
     def saveExperimentData(self, key, thisExp=None, blocking=True):
         """

psychopy/sound/__init__.py

@@ -30,7 +30,7 @@ After importing sound, the sound lib and driver being used will be stored as::
 """
 
 # 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 sys
@@ -71,7 +71,7 @@ backend = None
 # These are the names that can be used in the prefs to specifiy audio libraries.
 # The available libraries are hard-coded at this point until we can overhaul
 # the sound library to be more modular.
-_audioLibs = ['PTB', 'sounddevice', 'pyo', 'pysoundcard', 'pygame']
+_audioLibs = ['ptb', 'sounddevice', 'pyo', 'pysoundcard', 'pygame']
 failed = []  # keep track of audio libs that failed to load
 
 # check if this is being imported on Travis/Github (has no audio card)
@@ -115,7 +115,7 @@ for thisLibName in prefs.hardware['audioLib']:
                 from . import backend_ptb as backend
                 Sound = backend.SoundPTB
                 audioDriver = backend.audioDriver
-            except Exception:
+            except Exception as err:
                 failed.append(thisLibName)
                 continue
             else:
@@ -198,8 +198,18 @@ else:
 if Sound is not None:
     audioLib = thisLibName
     init = backend.init
-    if hasattr(backend, 'getDevices'):
+    getDevices = None
+    if audioLib != 'ptb' and hasattr(backend, 'getDevices'):
         getDevices = backend.getDevices
+    else:
+        import psychopy.hardware.speaker as speaker
+
+        def _getDevices(*args, **kwargs):  # for matching function signiture
+            allDevices = speaker.SpeakerDevice.getAvailableDevices()
+            return [dev['name'] for dev in allDevices]
+
+        getDevices = _getDevices
+
     logging.info('sound is using audioLib: %s' % audioLib)
 else:
     # if we get here, there is no audioLib that is supported
@@ -275,12 +285,17 @@ elif hasattr(backend, 'defaultOutput'):
     # is it simply "default" (do nothing)
     if dev == 'default' or systemtools.isVM_CI():
         pass  # do nothing
-    elif dev not in backend.getDevices(kind='output'):
-        deviceNames = sorted(backend.getDevices(kind='output').keys())
-        logging.warn(
-            u"Requested audio device '{}' that is not available on "
-            "this hardware. The 'audioDevice' preference should be one of "
-            "{}".format(dev, deviceNames))
+    elif getDevices is not None:
+        devices = getDevices(kind='output')
+        if type(devices) is dict:
+            deviceNames = sorted(devices.keys())
+        else:
+            deviceNames = sorted(devices)
+        if dev not in devices:
+            logging.warn(
+                u"Requested audio device '{}' that is not available on "
+                "this hardware. The 'audioDevice' preference should be one of "
+                "{}".format(dev, deviceNames))
     else:
         setDevice(dev, kind='output')