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

psychopy/app/themes/icons.py

@@ -10,6 +10,7 @@ from . import theme as appTheme
 retStr = ""
 resources = Path(prefs.paths['resources'])
 iconCache = {}
+pluginIconFiles = []
 
 
 class BaseIcon:
@@ -144,9 +145,7 @@ class ButtonIcon(BaseIcon):
         if theme is None:
             theme = appTheme.icons
         # Get all files in the resource folder containing the given stem
-        matches = [f for f in resources.glob(f"**/{stem}*.png")]
-        # get all icons from plugins
-        matches += findPluginIcons(stem)
+        matches = [f for f in resources.glob(f"**/{stem}*.png")] + pluginIconFiles
         # Create blank arrays to store retina and non-retina files
         ret = {}
         nret = {}
@@ -263,38 +262,3 @@ class ComponentIcon(BaseIcon):
             self._beta = wx.Bitmap(combined)
 
         return self._beta
-
-
-def findPluginIcons(stem):
-    """
-    Search icons added by plugins for any matching the given file stem.
-
-    Parameters
-    ----------
-    stem : str
-        The file stem (aka the filename without `.png` on the end) to search for - will also find
-        files beginning with the given stem (e.g. "globe" will also find "globe@2x.png")
-
-    Returns
-    -------
-    list[Path]
-        List of file paths for found icons
-    """
-    from psychopy.plugins import getEntryPointGroup
-    # start off with no files
-    files = []
-    # iterate through found entry points
-    for ep in getEntryPointGroup("psychopy.app.themes.icons"):
-        try:
-            # try to load module
-            mod = ep.load()
-            # get module folder
-            folder = Path(mod.__file__).parent
-            # add all matching .png files from that folder
-            for file in folder.glob(f"**/{stem}*.png"):
-                files.append(file)
-        except:
-            # if it fails for any reason, skip it
-            logging.warn(f"Failed to load {ep.value}")
-
-    return files

psychopy/app/ui/__init__.py

@@ -5,7 +5,7 @@
 """
 
 # 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 wx

psychopy/app/utils.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).
 
 """utility classes for the Builder
@@ -1555,7 +1555,7 @@ def sanitize(inStr):
     """
     # Key-value pairs of patterns with what to replace them with
     patterns = {
-        "https\:\/\/oauth2\:[\d\w]{64}@gitlab\.pavlovia\.org\/.*\.git": "[[OAUTH key hidden]]" # Remove any oauth keys
+        r"https\:\/\/oauth2\:[\d\w]{64}@gitlab\.pavlovia\.org\/.*\.git": "[[OAUTH key hidden]]" # Remove any oauth keys
     }
     # Replace each pattern
     for pattern, repl in patterns.items():
@@ -1671,7 +1671,7 @@ def sanitize(inStr):
     """
     # Key-value pairs of patterns with what to replace them with
     patterns = {
-        "https\:\/\/oauth2\:[\d\w]{64}@gitlab\.pavlovia\.org\/.*\.git": "[[OAUTH key hidden]]" # Remove any oauth keys
+        r"https:\/\/oauth2:[\d\w]{64}@gitlab\.pavlovia\.org\/.*\.git": "[[OAUTH key hidden]]" # Remove any oauth keys
     }
     # Replace each pattern
     for pattern, repl in patterns.items():

psychopy/clock.py

@@ -16,7 +16,7 @@ Clock logic.
 """
 
 # 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 logging
 import time
@@ -497,6 +497,9 @@ class StaticPeriod:
         wait(timeRemaining)
 
         return 1
+    
+    def getDuration(self):
+        return self.countdown._countdown_duration
 
 
 def _dispatchWindowEvents():

psychopy/colors.py

@@ -261,7 +261,6 @@ class Color:
         self._cache = {}
         self._renderCache = {}
         self.contrast = contrast if isinstance(contrast, (int, float)) else 1
-        self.alpha = 1
         self.valid = False
         self.conematrix = conematrix
 
@@ -383,6 +382,8 @@ class Color:
             return self._renderCache[space]
         # Transform contrast to match rgb
         contrast = self.contrast
+        if contrast is None:
+            contrast = 1
         contrast = np.reshape(contrast, (-1, 1))
         contrast = np.hstack((contrast, contrast, contrast))
         # Multiply
@@ -396,7 +397,7 @@ class Color:
         """If colour is printed, it will display its class and value.
         """
         if self.valid:
-            if self.named:
+            if isinstance(self.named, str):
                 return (f"<{self.__class__.__module__}."
                         f"{self.__class__.__name__}: {self.named}, "
                         f"alpha={self.alpha}>")
@@ -535,12 +536,18 @@ class Color:
         """How opaque (1) or transparent (0) this color is. Synonymous with
         `opacity`.
         """
-        return self._alpha
+        if hasattr(self, "_alpha"):
+            return self._alpha
+
+        return 1
 
     @alpha.setter
     def alpha(self, value):
-        # Treat 1x1 arrays as a float
-        if isinstance(value, np.ndarray):
+        if value is None:
+            # setting as None should do nothing
+            return
+        elif isinstance(value, np.ndarray):
+            # treat 1x1 arrays as a float
             if value.size == 1:
                 value = float(value[0])
         else:

psychopy/core.py

@@ -4,7 +4,7 @@
 """Basic functions, including timing, rush (imported), quit
 """
 # 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

psychopy/data/base.py

@@ -540,7 +540,7 @@ class DataHandler(_ComparisonMixin, dict):
         # check whether data falls within bounds
         posArr = np.asarray(position)
         shapeArr = np.asarray(self.dataShape)
-        if not np.alltrue(posArr < shapeArr):
+        if not np.all(posArr < shapeArr):
             # array isn't big enough
             logging.warning('need a bigger array for: ' + thisType)
             # not implemented yet!

psychopy/data/experiment.py

@@ -11,7 +11,7 @@ from psychopy import constants, clock
 from psychopy import logging
 from psychopy.data.trial import TrialHandler2
 from psychopy.tools.filetools import (openOutputFile, genDelimiter,
-                                      genFilenameFromDelimiter)
+                                      genFilenameFromDelimiter, handleFileCollision)
 from psychopy.localization import _translate
 from .utils import checkValidFilePath
 from .base import _ComparisonMixin
@@ -95,7 +95,7 @@ class ExperimentHandler(_ComparisonMixin):
         self.originPath = originPath
         self.savePickle = savePickle
         self.saveWideText = saveWideText
-        self.dataFileName = dataFileName
+        self.dataFileName = handleFileCollision(dataFileName, "rename")
         self.sortColumns = sortColumns
         self.thisEntry = {}
         self.entries = []  # chronological list of entries
@@ -108,6 +108,10 @@ class ExperimentHandler(_ComparisonMixin):
         self.autoLog = autoLog
         self.appendFiles = appendFiles
         self.status = constants.NOT_STARTED
+        # dict of filenames to collision method to be used next time it's saved
+        self._nextSaveCollision = {}
+        # list of call profiles for connected save methods
+        self.connectedSaveMethods = []
 
         if dataFileName in ['', None]:
             logging.warning('ExperimentHandler created with no dataFileName'
@@ -422,6 +426,9 @@ class ExperimentHandler(_ComparisonMixin):
         """
         Set status to be PAUSED.
         """
+        logging.exp(_translate(
+            "Experiment '{}' paused."
+        ).format(self.name))
         # warn if experiment is already paused
         if self.status == constants.PAUSED:
             logging.warn(_translate(
@@ -435,6 +442,9 @@ class ExperimentHandler(_ComparisonMixin):
         """
         Set status to be STARTED.
         """
+        logging.exp(_translate(
+            "Experiment '{}' resumed."
+        ).format(self.name))
         # warn if experiment is already running
         if self.status == constants.STARTED:
             logging.warn(_translate(
@@ -471,7 +481,7 @@ class ExperimentHandler(_ComparisonMixin):
         if not isinstance(self.currentLoop, TrialHandler2):
             return
         # skip trials in current loop
-        self.currentLoop.skipTrials(n)
+        return self.currentLoop.skipTrials(n)
 
     def rewindTrials(self, n=1):
         """
@@ -487,7 +497,7 @@ class ExperimentHandler(_ComparisonMixin):
         if not isinstance(self.currentLoop, TrialHandler2):
             return
         # rewind trials in current loop
-        self.currentLoop.rewindTrials(n)
+        return self.currentLoop.rewindTrials(n)
     
     def getAllTrials(self):
         """
@@ -610,13 +620,89 @@ class ExperimentHandler(_ComparisonMixin):
             entries.append(self.thisEntry)
         return entries
 
+    def queueNextCollision(self, fileCollisionMethod, fileName=None):
+        """
+        Tell this ExperimentHandler than, next time the named file is saved, it should handle 
+        collisions a certain way. This is useful if you want to save multiple times within an 
+        experiment.
+
+        Parameters
+        ----------
+        fileCollisionMethod : str
+            File collision method to use, see `saveAsWideText` or `saveAsPickle` for 
+            details.
+        fileName : str
+            Filename to queue collision on, if None (default) will use this ExperimentHandler's 
+            `dataFileName`
+        """
+        # handle default
+        if fileName is None:
+            fileName = self.dataFileName
+        # make filename iterable
+        if not isinstance(fileName, (list, tuple)):
+            fileName = [fileName]
+        # queue collision
+        for thisFileName in fileName:
+            self._nextSaveCollision[thisFileName] = fileCollisionMethod
+    
+    def connectSaveMethod(self, fcn, *args, **kwargs):
+        """
+        Tell this experiment handler to call the given function with the given arguments and 
+        keyword arguments whenever it saves its own data.
+
+        Parameters
+        ----------
+        fcn : function
+            Function to call
+        *args
+            Positional arguments to be given to the function when it's called
+        **kwargs
+            Keyword arguments to be given to the function when it's called
+        """
+        # create a call profile for the given function
+        profile = {
+            'fcn': fcn,
+            'args': args,
+            'kwargs': kwargs
+        }
+        # connect it
+        self.connectedSaveMethods.append(profile)
+    
+    def save(self):
+        """
+        Work out from own settings how to save, then use the appropriate method (saveAsWideText, 
+        saveAsPickle, etc.)
+        """
+        savedNames = []
+        if self.dataFileName not in ['', None]:
+            if self.autoLog:
+                msg = 'Saving data for %s ExperimentHandler' % self.name
+                logging.debug(msg)
+            if self.savePickle:
+                savedNames.append(
+                    self.saveAsPickle(self.dataFileName)
+                )
+            if self.saveWideText:
+                savedNames.append(
+                    self.saveAsWideText(self.dataFileName + '.csv')
+                )
+        else:
+            logging.warn(
+                "ExperimentHandler.save was called on an ExperimentHandler with no dataFileName set."
+            )
+        # call connected save functions
+        for profile in self.connectedSaveMethods:
+            profile['fcn'](*profile['args'], **profile['kwargs'])
+        
+        return savedNames
+
     def saveAsWideText(self,
                        fileName,
                        delim='auto',
                        matrixOnly=False,
                        appendFile=None,
                        encoding='utf-8-sig',
-                       fileCollisionMethod='rename',
+                       fileCollisionMethod=None,
                        sortColumns=None):
         """Saves a long, wide-format text file, with one line representing
         the attributes and data for a single trial. Suitable for analysis
@@ -632,38 +718,43 @@ class ExperimentHandler(_ComparisonMixin):
         which can be handy if you want to append data to an existing file
         of the same format.
 
-        :Parameters:
-
-            fileName:
-                if extension is not specified, '.csv' will be appended if
-                the delimiter is ',', else '.tsv' will be appended.
-                Can include path info.
+        Parameters
+        ----------
 
-            delim:
-                allows the user to use a delimiter other than the default
-                tab ("," is popular with file extension ".csv")
+        fileName:
+            if extension is not specified, '.csv' will be appended if
+            the delimiter is ',', else '.tsv' will be appended.
+            Can include path info.
 
-            matrixOnly:
-                outputs the data with no header row.
+        delim:
+            allows the user to use a delimiter other than the default
+            tab ("," is popular with file extension ".csv")
 
-            appendFile:
-                will add this output to the end of the specified file if
-                it already exists.
+        matrixOnly:
+            outputs the data with no header row.
 
-            encoding:
-                The encoding to use when saving a the file.
-                Defaults to `utf-8-sig`.
+        appendFile:
+            will add this output to the end of the specified file if
+            it already exists.
 
-            fileCollisionMethod:
-                Collision method passed to
-                :func:`~psychopy.tools.fileerrortools.handleFileCollision`
+        encoding:
+            The encoding to use when saving a the file.
+            Defaults to `utf-8-sig`.
 
-            sortColumns : str or bool
-                How (if at all) to sort columns in the data file. Can be:
-                - "alphabetical", "alpha", "a" or True: Sort alphabetically by header name
-                - "priority", "pr" or "p": Sort according to priority
-                - other: Do not sort, columns remain in order they were added
+        fileCollisionMethod:
+            Collision method passed to
+            :func:`~psychopy.tools.fileerrortools.handleFileCollision`
 
+        sortColumns : str or bool
+            How (if at all) to sort columns in the data file. Can be:
+            - "alphabetical", "alpha", "a" or True: Sort alphabetically by header name
+            - "priority", "pr" or "p": Sort according to priority
+            - other: Do not sort, columns remain in order they were added
+        
+        Returns
+        -------
+        str
+            Final filename (including _1, _2, etc. and file extension) which data was saved as
         """
         # set default delimiter if none given
         delimOptions = {
@@ -678,6 +769,11 @@ class ExperimentHandler(_ComparisonMixin):
 
         if appendFile is None:
             appendFile = self.appendFiles
+        # check for queued collision methods if using default, fallback to rename
+        if fileCollisionMethod is None and fileName in self._nextSaveCollision:
+            fileCollisionMethod = self._nextSaveCollision.pop(fileName)
+        elif fileCollisionMethod is None:
+            fileCollisionMethod = "rename"
 
         # create the file or send to stdout
         fileName = genFilenameFromDelimiter(fileName, delim)
@@ -730,15 +826,23 @@ class ExperimentHandler(_ComparisonMixin):
             f.close()
         logging.info('saved data to %r' % f.name)
 
-    def saveAsPickle(self, fileName, fileCollisionMethod='rename'):
+        return fileName
+
+    def saveAsPickle(self, fileName, fileCollisionMethod=None):
         """Basically just saves a copy of self (with data) to a pickle file.
 
         This can be reloaded if necessary and further analyses carried out.
 
-        :Parameters:
+        Parameters
+        ----------
 
-            fileCollisionMethod: Collision method passed to
-            :func:`~psychopy.tools.fileerrortools.handleFileCollision`
+        fileCollisionMethod : str
+            Collision method passed to :func:`~psychopy.tools.fileerrortools.handleFileCollision`
+        
+        Returns
+        -------
+        str
+            Final filename (including _1, _2, etc. and file extension) which data was saved as
         """
         # Store the current state of self.savePickle and self.saveWideText
         # for later use:
@@ -754,16 +858,22 @@ class ExperimentHandler(_ComparisonMixin):
         savePickle = self.savePickle
         saveWideText = self.saveWideText
 
+        # append extension
+        if not fileName.endswith('.psydat'):
+            fileName += '.psydat'
+
+        # check for queued collision methods if using default, fallback to rename
+        if fileCollisionMethod is None and fileName in self._nextSaveCollision:
+            fileCollisionMethod = self._nextSaveCollision.pop(fileName)
+        elif fileCollisionMethod is None:
+            fileCollisionMethod = "rename"
+
         self.savePickle = False
         self.saveWideText = False
 
         origEntries = self.entries
         self.entries = self.getAllEntries()
 
-        # otherwise use default location
-        if not fileName.endswith('.psydat'):
-            fileName += '.psydat'
-
         with openOutputFile(fileName=fileName, append=False,
                            fileCollisionMethod=fileCollisionMethod) as f:
             pickle.dump(self, f)
@@ -775,6 +885,8 @@ class ExperimentHandler(_ComparisonMixin):
         self.savePickle = savePickle
         self.saveWideText = saveWideText
 
+        return fileName
+
     def getJSON(self, priorityThreshold=constants.priority.EXCLUDE+1):
         """
         Get the experiment data as a JSON string.
@@ -810,14 +922,7 @@ class ExperimentHandler(_ComparisonMixin):
         return json.dumps(context, indent=True, allow_nan=False, default=str)
         
     def close(self):
-        if self.dataFileName not in ['', None]:
-            if self.autoLog:
-                msg = 'Saving data for %s ExperimentHandler' % self.name
-                logging.debug(msg)
-            if self.savePickle:
-                self.saveAsPickle(self.dataFileName)
-            if self.saveWideText:
-                self.saveAsWideText(self.dataFileName + '.csv')
+        self.save()
         self.abort()
         self.autoLog = False
 

psychopy/data/routine.py

@@ -53,4 +53,30 @@ class Routine:
         # starting status
         self.status = constants.NOT_STARTED
     
-    
+    def getPlaybackComponents(self):
+        """
+        Get a list of all Components within this Routine which have a concept of playing and 
+        pausing (Sound, Movie, etc.)
+        """
+        playbackComps = []
+        # iterate through all Components
+        for comp in self.components:
+            # if it has play and pause methods, append it
+            if hasattr(comp, 'play') and hasattr(comp, 'pause'):
+                playbackComps.append(comp)
+        
+        return playbackComps
+    
+    def getDispatchComponents(self):
+        """
+        Get a list of all Components within this Routine which have a method for dispatching 
+        messages from a response device.
+        """
+        dispatchComps = []
+        # iterate through all Components
+        for comp in self.components:
+            # if it has a device which has a dispatch method, append it
+            if hasattr(comp, 'device') and hasattr(comp.device, 'dispatchMessages'):
+                dispatchComps.append(comp)
+        
+        return dispatchComps

psychopy/data/staircase.py

@@ -1609,7 +1609,8 @@ class QuestPlusHandler(StairHandler):
 
         # if needed replace the existing intensity with this custom one
         if intensity is not None:
-            self.intensities.pop()
+            if len(self.intensities) != 0: # avoid error during the first trial where self.intensities will be of length 0, so pop does not work
+                self.intensities.pop()  # remove the auto-generated one
             self.intensities.append(intensity)
         # add the current data to experiment if possible
         if self.getExp() is not None: