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

psychopy/app/stdout/stdOutRich.py

@@ -107,7 +107,11 @@ class StdOutRich(wx.richtext.RichTextCtrl, _BaseErrorHandler, handlers.ThemeMixi
         }
 
     def onURL(self, evt=None):
-        wx.BeginBusyCursor()
+        """Open link in default browser."""
+
+        if wx.Platform != '__WXGTK__':
+            wx.BeginBusyCursor()
+
         try:
             if evt.String.startswith("http"):
                 webbrowser.open(evt.String)
@@ -121,7 +125,8 @@ class StdOutRich(wx.richtext.RichTextCtrl, _BaseErrorHandler, handlers.ThemeMixi
         except Exception as e:
             print("##### Could not open URL: {} #####\n".format(evt.String))
             print(e)
-        wx.EndBusyCursor()
+        if wx.Platform != '__WXGTK__':
+            wx.EndBusyCursor()
 
     def write(self, inStr, evt=None):
         self.MoveEnd()  # always 'append' text rather than 'writing' it
@@ -357,7 +362,8 @@ class ScriptOutputCtrl(StdOutRich, handlers.ThemeMixin):
 
     def onURL(self, evt):
         """Open link in default browser."""
-        wx.BeginBusyCursor()
+        if wx.Platform != '__WXGTK__':
+            wx.BeginBusyCursor()
         try:
             if evt.String.startswith("http"):
                 webbrowser.open(evt.String)
@@ -375,7 +381,8 @@ class ScriptOutputCtrl(StdOutRich, handlers.ThemeMixin):
         except Exception as e:
             print("##### Could not open URL: {} #####\n".format(evt.String))
             print(e)
-        wx.EndBusyCursor()
+        if wx.Platform != '__WXGTK__':
+            wx.EndBusyCursor()
 
     def clear(self, evt=None):
         self.Clear()

psychopy/app/themes/icons.py

@@ -125,6 +125,9 @@ class BaseIcon:
         # If size is None, return bitmap as is
         if size in (None, (None, None)):
             return bmp
+        # if given a single value, duplicate it
+        if isinstance(size, (int, float)):
+            size = (size, size)
         # Split up size value
         width, height = size
         # If size is unchanged, return bitmap as is

psychopy/app/utils.py

@@ -1665,6 +1665,67 @@ class ListCtrl(wx.ListCtrl, listmixin.ListCtrlAutoWidthMixin):
         listmixin.ListCtrlAutoWidthMixin.__init__(self)
 
 
+class ShowHideBtn(wx.ToggleButton):
+    """
+    Button which shows/hides a panel by toggling itself.
+    """
+    indicators = {
+        True: "▾",
+        False: "▸"
+    }
+    def __init__(
+            self, 
+            parent, 
+            target,
+            label=""
+    ):
+        wx.ToggleButton.__init__(self)
+        self.SetBackgroundStyle(wx.BG_STYLE_TRANSPARENT)
+        self.Create(
+            parent,
+            label=label,
+            style=wx.BU_LEFT | wx.BORDER_NONE
+        )
+        # for some reason, wx won't hide the background unless you set the foreground
+        self.SetForegroundColour("black")  
+        # store root label
+        self.rootLabel = label
+        # store target
+        self.target = target
+        # bind toggle
+        self.Bind(
+            wx.EVT_TOGGLEBUTTON, self.onToggle
+        )
+    
+    def setValue(self, value):
+        self.onToggle(value)
+    
+    def toggle(self):
+        self.setValue(not self.GetValue())
+    
+    def onToggle(self, evt):
+        # get value
+        if isinstance(evt, bool):
+            val = evt
+        else:
+            val = evt.Int
+        # show/hide target
+        if isinstance(self.target, wx.Sizer):
+            self.target.ShowItems(val)
+        else:
+            self.target.Show(val)
+        # toggle indicator
+        indicator = self.indicators[val]
+        self.SetLabel(f"{indicator} {self.rootLabel}")
+        # layout parent
+        self.GetParent().Layout()
+        if hasattr(self.GetParent(), "SetupScrolling"):
+            self.GetParent().SetupScrolling()
+        # toggle as normal
+        if hasattr(evt, "Skip"):
+            evt.Skip()
+
+
 def sanitize(inStr):
     """
     Process a string to remove any sensitive information, i.e. OAUTH keys

psychopy/data/experiment.py

@@ -85,6 +85,7 @@ class ExperimentHandler(_ComparisonMixin):
         """
         self.loops = []
         self.loopsUnfinished = []
+        self.currentRoutine = None
         self.name = name
         self.version = version
         self.runtimeInfo = runtimeInfo
@@ -124,20 +125,44 @@ class ExperimentHandler(_ComparisonMixin):
 
     def __del__(self):
         self.close()
-
-    @property
-    def currentLoop(self):
+    
+    def getCurrentLoop(self, isTrials=True):
         """
         Return the loop which we are currently in, this will either be a handle to a loop, such as
         a :class:`~psychopy.data.TrialHandler` or :class:`~psychopy.data.StairHandler`, or the handle
         of the :class:`~psychopy.data.ExperimentHandler` itself if we are not in a loop.
+
+        Parameters
+        ----------
+        isTrials : bool
+            Filter for only loops which have isTrials checked
         """
-        # If there are unfinished (aka currently active) loops, return the most recent
         if len(self.loopsUnfinished):
-            return self.loopsUnfinished[-1]
-        # If we are not in a loop, return handle to experiment handler
+            # iterate through unfinished (aka active) loops, starting with the most recent
+            for loop in reversed(self.loopsUnfinished):
+                # if not filtering, just return the first one
+                if not isTrials:
+                    return loop
+                # otherwise, return the first one which is a trials loop
+                if getattr(loop, 'isTrials', False):
+                    return loop
+        # if we are not in a loop, return to experiment handler
         return self
 
+    @property
+    def currentLoop(self):
+        """
+        Calls `.getCurrentLoop` with `isTrials=False`
+        """
+        return self.getCurrentLoop(isTrials=False)
+    
+    @property
+    def currentTrialsLoop(self):
+        """
+        Calls `.getCurrentLoop` with `isTrials=True`
+        """
+        return self.getCurrentLoop(isTrials=True)
+
     def addLoop(self, loopHandler):
         """Add a loop such as a :class:`~psychopy.data.TrialHandler`
         or :class:`~psychopy.data.StairHandler`
@@ -274,6 +299,12 @@ class ExperimentHandler(_ComparisonMixin):
         # get entry from row number
         entry = self.thisEntry
         if row is not None:
+            # if row exceeds size of entries, warn and abort
+            if row > len(self.entries):
+                logging.error(_translate(
+                    "Cannot add data to row {} as there are only {} entries"
+                ).format(row, len(self.entries)))
+            # get entry from row
             entry = self.entries[row]
         entry[name] = value
 
@@ -466,8 +497,37 @@ class ExperimentHandler(_ComparisonMixin):
             ))
         # set own status
         self.status = constants.STOPPED
+    
+    def next(self, isTrials=True):
+        """
+        Move on to either the next trial (if in a trials loop) or the next Routine.
+
+        Parameters
+        ----------
+        isTrials : bool
+            Filter for only loops which have isTrials checked
+        """
+        if isinstance(self.getCurrentLoop(isTrials=isTrials), TrialHandler2):
+            # if there is a loop, skip trials
+            self.skipTrials(1, isTrials=isTrials)
+        elif self.currentRoutine is not None:
+            # if not, but there is a Routine, end it
+            self.endCurrentRoutine()
+        else:
+            # otherwise, do nothing
+            return
+    
+    def endCurrentRoutine(self):
+        """
+        End the current Routine (via the Routine.forceEnded attribute)
+        """
+        # if there's no current Routine yet, do nothing
+        if self.currentRoutine is None:
+            return
+        # force end the Routine
+        self.currentRoutine.forceEnded = True
 
-    def skipTrials(self, n=1):
+    def skipTrials(self, n=1, isTrials=True):
         """
         Skip ahead n trials - the trials inbetween will be marked as "skipped". If you try to
         skip past the last trial, will log a warning and skip *to* the last trial.
@@ -476,14 +536,23 @@ class ExperimentHandler(_ComparisonMixin):
         ----------
         n : int
             Number of trials to skip ahead
+        isTrials : bool
+            Filter for only loops which have isTrials checked
         """
+        loop = self.getCurrentLoop(isTrials=isTrials)
         # return if there isn't a TrialHandler2 active
-        if not isinstance(self.currentLoop, TrialHandler2):
+        if not isinstance(loop, TrialHandler2):
             return
+        # end inner loops
+        for innerLoop in self.loopsUnfinished[
+            self.loopsUnfinished.index(loop)+1:
+        ].copy():
+            innerLoop.finished = True
+            self.loopEnded(innerLoop)
         # skip trials in current loop
-        return self.currentLoop.skipTrials(n)
+        return loop.skipTrials(n)
 
-    def rewindTrials(self, n=1):
+    def rewindTrials(self, n=1, isTrials=True):
         """
         Skip ahead n trials - the trials inbetween will be marked as "skipped". If you try to
         skip past the last trial, will log a warning and skip *to* the last trial.
@@ -492,18 +561,34 @@ class ExperimentHandler(_ComparisonMixin):
         ----------
         n : int
             Number of trials to skip ahead
+        isTrials : bool
+            Filter for only loops which have isTrials checked
         """
+        loop = self.getCurrentLoop(isTrials=isTrials)
         # return if there isn't a TrialHandler2 active
-        if not isinstance(self.currentLoop, TrialHandler2):
+        if not isinstance(loop, TrialHandler2):
             return
+        # restart inner loops
+        for innerLoop in self.loopsUnfinished[
+            self.loopsUnfinished.index(loop)+1:
+        ]:
+            innerLoop.rewindTrials(
+                len(innerLoop.elapsedTrials)
+            )
         # rewind trials in current loop
-        return self.currentLoop.rewindTrials(n)
+        return loop.rewindTrials(n)
+
     
-    def getAllTrials(self):
+    def getAllTrials(self, isTrials=True):
         """
         Returns all trials (elapsed, current and upcoming) with an index indicating which trial is 
         the current trial.
 
+        Parameters
+        ----------
+        isTrials : bool
+            Filter for only loops which have isTrials checked
+
         Returns
         -------
         list[Trial]
@@ -512,39 +597,49 @@ class ExperimentHandler(_ComparisonMixin):
             Index of the current trial in this list
         """
         # return None if there isn't a TrialHandler2 active
-        if not isinstance(self.currentLoop, TrialHandler2):
+        if not isinstance(self.getCurrentLoop(isTrials=isTrials), TrialHandler2):
             return [None], 0
         # get all trials from current loop
-        return self.currentLoop.getAllTrials()
+        return self.getCurrentLoop(isTrials=isTrials).getAllTrials()
 
-    def getCurrentTrial(self):
+    def getCurrentTrial(self, isTrials=True):
         """
         Returns the current trial (`.thisTrial`)
 
+        Parameters
+        ----------
+        isTrials : bool
+            Filter for only loops which have isTrials checked
+
         Returns
         -------
         Trial
             The current trial
         """
         # return None if there isn't a TrialHandler2 active
-        if not isinstance(self.currentLoop, TrialHandler2):
+        if not isinstance(self.getCurrentLoop(isTrials=isTrials), TrialHandler2):
             return None
         
-        return self.currentLoop.getCurrentTrial()
+        return self.getCurrentLoop(isTrials=isTrials).getCurrentTrial()
     
-    def getFutureTrial(self, n=1):
+    def getFutureTrial(self, n=1, isTrials=True):
         """
         Returns the condition for n trials into the future, without
         advancing the trials. Returns 'None' if attempting to go beyond
         the last trial in the current loop, or if there is no current loop.
+
+        Parameters
+        ----------
+        isTrials : bool
+            Filter for only loops which have isTrials checked
         """
         # return None if there isn't a TrialHandler2 active
-        if not isinstance(self.currentLoop, TrialHandler2):
+        if not isinstance(self.getCurrentLoop(isTrials=isTrials), TrialHandler2):
             return None
         # get future trial from current loop
-        return self.currentLoop.getFutureTrial(n)
+        return self.getCurrentLoop(isTrials=isTrials).getFutureTrial(n)
 
-    def getFutureTrials(self, n=1, start=0):
+    def getFutureTrials(self, n=1, start=0, isTrials=True):
         """
         Returns Trial objects for a given range in the future. Will start looking at `start` trials 
         in the future and will return n trials from then, so e.g. to get all trials from 2 in the 
@@ -556,6 +651,8 @@ class ExperimentHandler(_ComparisonMixin):
             How many trials into the future to look, by default 1
         start : int, optional
             How many trials into the future to start looking at, by default 0
+        isTrials : bool
+            Filter for only loops which have isTrials checked
         
         Returns
         -------
@@ -568,7 +665,7 @@ class ExperimentHandler(_ComparisonMixin):
         for i in range(n):
             # add each to the list
             trials.append(
-                self.getFutureTrial(start + i)
+                self.getFutureTrial(start + i, isTrials=isTrials)
             )
         
         return trials
@@ -874,9 +971,22 @@ class ExperimentHandler(_ComparisonMixin):
         origEntries = self.entries
         self.entries = self.getAllEntries()
 
+        # temporarily remove connected save methods so they don't get pickled
+        origConnectedSaveMethods = self.connectedSaveMethods
+        self.connectedSaveMethods = [
+            {
+                'fcn': f"<{callback['fcn'].__module__}:{callback['fcn'].__name__}>",
+                'args': callback['args'],
+                'kwargs': callback['kwargs']
+            } for callback in origConnectedSaveMethods
+        ]
+
         with openOutputFile(fileName=fileName, append=False,
                            fileCollisionMethod=fileCollisionMethod) as f:
             pickle.dump(self, f)
+        
+        # reinstate connected save methods
+        self.connectedSaveMethods = origConnectedSaveMethods
 
         if (fileName is not None) and (fileName != 'stdout'):
             logging.info('saved data to %s' % f.name)

psychopy/data/routine.py

@@ -53,6 +53,18 @@ class Routine:
         # starting status
         self.status = constants.NOT_STARTED
     
+    def __getstate__(self):
+        """
+        Components can't be pickled due to their window reference, so don't include them when 
+        pickled
+        """
+        # capture what is normally pickled
+        state = self.__dict__.copy()
+        # replace components with their name
+        state['components'] = []
+
+        return state
+    
     def getPlaybackComponents(self):
         """
         Get a list of all Components within this Routine which have a concept of playing and 

psychopy/data/staircase.py

@@ -55,23 +55,26 @@ class StairHandler(_BaseTrialHandler):
 
     """
 
-    def __init__(self,
-                 startVal,
-                 nReversals=None,
-                 stepSizes=4,  # dB stepsize
-                 nTrials=0,
-                 nUp=1,
-                 nDown=3,  # correct responses before stim goes down
-                 applyInitialRule=True,
-                 extraInfo=None,
-                 method='2AFC',
-                 stepType='db',
-                 minVal=None,
-                 maxVal=None,
-                 originPath=None,
-                 name='',
-                 autoLog=True,
-                 **kwargs):
+    def __init__(
+        self,
+        startVal,
+        nReversals=None,
+        stepSizes=4,  # dB stepsize
+        nTrials=0,
+        nUp=1,
+        nDown=3,  # correct responses before stim goes down
+        applyInitialRule=True,
+        extraInfo=None,
+        method='2AFC',
+        stepType='db',
+        minVal=None,
+        maxVal=None,
+        originPath=None,
+        isTrials=True,
+        name='',
+        autoLog=True,
+        **kwargs
+    ):
         """
         :Parameters:
 
@@ -136,6 +139,10 @@ class StairHandler(_BaseTrialHandler):
                 The largest legal value for the staircase, which can be
                 used to prevent it reaching impossible contrast values,
                 for instance.
+            
+            isTrials : bool
+                Is this controlling trials, or created for another purpose (e.g. iterating a 
+                stimulus within a trial)?
 
             Additional keyword arguments will be ignored.
 
@@ -155,6 +162,7 @@ class StairHandler(_BaseTrialHandler):
         self.extraInfo = extraInfo
         self.method = method
         self.stepType = stepType
+        self.isTrials = isTrials
 
         try:
             self.stepSizes = list(stepSizes)
@@ -1736,9 +1744,18 @@ class QuestPlusHandler(StairHandler):
 
 class MultiStairHandler(_BaseTrialHandler):
 
-    def __init__(self, stairType='simple', method='random',
-                 conditions=None, nTrials=50, randomSeed=None,
-                 originPath=None, name='', autoLog=True):
+    def __init__(
+        self, 
+        stairType='simple', 
+        method='random',
+        conditions=None, 
+        nTrials=50, 
+        randomSeed=None,
+        originPath=None, 
+        isTrials=True,
+        name='', 
+        autoLog=True,
+    ):
         """A Handler to allow easy interleaved staircase procedures
         (simple or QUEST).
 
@@ -1790,6 +1807,10 @@ class MultiStairHandler(_BaseTrialHandler):
                 The seed with which to initialize the random number generator
                 (RNG). If `None` (default), do not initialize the RNG with
                 a specific value.
+            
+            isTrials : bool
+                Is this controlling trials, or created for another purpose (e.g. iterating a 
+                stimulus within a trial)?
 
         Example usage::
 
@@ -1829,6 +1850,7 @@ class MultiStairHandler(_BaseTrialHandler):
         self.nTrials = nTrials
         self.finished = False
         self.totalTrials = 0
+        self.isTrials = isTrials
         self._checkArguments()
         # create staircases
         self.staircases = []  # all staircases

psychopy/data/trial.py

@@ -852,16 +852,19 @@ class TrialHandler2(_BaseTrialHandler):
     Then you'll find that `dat` has the following attributes that
     """
 
-    def __init__(self,
-                 trialList,
-                 nReps,
-                 method='random',
-                 dataTypes=None,
-                 extraInfo=None,
-                 seed=None,
-                 originPath=None,
-                 name='',
-                 autoLog=True):
+    def __init__(
+        self,
+        trialList,
+        nReps,
+        method='random',
+        dataTypes=None,
+        extraInfo=None,
+        seed=None,
+        originPath=None,
+        isTrials=True,
+        name='',
+        autoLog=True
+    ):
         """
 
         :Parameters:
@@ -929,10 +932,14 @@ class TrialHandler2(_BaseTrialHandler):
 
             .origin - the contents of the script or builder experiment that
                 created the handler
+            
+            .isTrials - is this controlling trials, or created for another purpose (e.g. iterating a 
+                stimulus within a trial)?
 
         """
         self.name = name
         self.autoLog = autoLog
+        self.isTrials = isTrials
 
         if trialList in [None, [None], []]:  # user wants an empty trialList
             # which corresponds to a list with a single empty entry
@@ -1284,8 +1291,9 @@ class TrialHandler2(_BaseTrialHandler):
             # advance row in data file
             if self.getExp() is not None:
                 self.getExp().nextEntry()
-        # mark as recently skipped so the next iteration is cancelled
-        self._cancelNextIteration = True
+        # mark as recently skipped so the next iteration (if there is one) is cancelled
+        if n or len(self.upcomingTrials):
+            self._cancelNextIteration = True
 
         return self.thisTrial   
 

psychopy/data/utils.py

@@ -181,6 +181,35 @@ def indicesFromString(indsString):
         pass
 
 
+def dictFromString(val):
+    # return as-is if already a dict
+    if isinstance(val, dict):
+        return val
+    # stringify
+    if not isinstance(val, str):
+        val = str(val)
+    # strip spaces
+    val = val.strip()
+    # make sure we have curly braces
+    if not val.startswith("{") and val.endswith("}"):
+        val = f"{{{val}}}"
+    # try to evaluate with ast (works for simple values)
+    try:
+        iterable = ast.literal_eval(val)
+        assert isinstance(iterable, dict)
+        return iterable
+    except (ValueError, SyntaxError, AssertionError):
+        pass  # e.g. "yes, no" won't work. We'll go on and try another way
+    # try manually if ast fails
+    parsed = {}
+    for item in val[1:-1].split(","):
+        if ":" in item:
+            key, val = item.split(":", maxsplit=1)
+            parsed[key.strip()] = val.strip()
+
+    return parsed 
+
+
 def listFromString(val, excludeEmpties=False):
     """Take a string that looks like a list (with commas and/or [] and make
     an actual python list"""
@@ -191,8 +220,7 @@ def listFromString(val, excludeEmpties=False):
     elif type(val) == list:
         return list(val)  # nothing to do
     elif type(val) != str:
-        raise ValueError("listFromString requires a string as its input not {}"
-                         .format(repr(val)))
+        return [val]
     # try to evaluate with ast (works for "'yes,'no'" or "['yes', 'no']")
     try:
         iterable = ast.literal_eval(val)
@@ -277,6 +305,10 @@ def importConditions(fileName, returnFieldNames=False, selection=""):
                     thisAttempt = pd.read_csv(
                         fileName, encoding='utf-8-sig', sep=sep, decimal=dec
                     )
+                    # read in the headers separately to bypass pandas sanitization
+                    thisAttempt.columns = pd.read_csv(
+                        fileName, encoding='utf-8-sig', sep=sep, decimal=dec, header=None, nrows=1
+                    ).iloc[0, :]
                     # if there's only one header, check that it doesn't contain delimiters
                     # (one column with delims probably means it's parsed without error but not
                     # recognised columns correctly)
@@ -335,12 +367,20 @@ def importConditions(fileName, returnFieldNames=False, selection=""):
         names are OK, return silently; else raise  with msg
         """
         fileName = pathToString(fileName)
+        # make sure all columns are named
         if not all(fieldNames):
             raise exceptions.ConditionsImportError(
                 "Conditions file %s: Missing parameter name(s); empty cell(s) in the first row?" % fileName,
                 translated=_translate("Conditions file %s: Missing parameter name(s); empty cell(s) in the first row?") % fileName
             )
+        # check each name
         for name in fieldNames:
+            # is this name duplicated?
+            if sum([otherName == name for otherName in fieldNames]) > 1:
+                raise exceptions.ConditionsImportError(_translate(
+                "Duplicate column name '{}'"
+            ).format(name))
+            # is this name a valid variable name?
             OK, msg, translated = isValidVariableName(name)
             if not OK:
                 # tailor message to importConditions