psychopy 2024.1.4__py3-none-any.whl → 2024.2.0__py3-none-any.whl

psychopy/app/runner/runner.py

@@ -902,7 +902,7 @@ class RunnerPanel(wx.Panel, ScriptProcess, handlers.ThemeMixin):
         # disable stop
         self.ribbon.buttons['pystop'].Disable()
         # switch mode
-        self.ribbon.buttons['pyswitch'].setMode(runMode == "run")
+        self.ribbon.buttons['pyswitch'].setMode(runMode == "run", silent=True)
         # update
         self.updateAlerts()
         self.app.updateWindowMenu()
@@ -1235,6 +1235,11 @@ class RunnerRibbon(ribbon.FrameRibbon):
             section="pavlovia", name="pavuser", frame=parent
         )
 
+        self.addSeparator()
+
+        # --- Plugin sections ---
+        self.addPluginSections("psychopy.app.builder")
+
         # --- Views ---
         self.addStretchSpacer()
         self.addSeparator()

psychopy/app/stdout/stdOutRich.py

@@ -93,6 +93,18 @@ class StdOutRich(wx.richtext.RichTextCtrl, _BaseErrorHandler, handlers.ThemeMixi
                 font=font.obj,
             )),
         }
+        # connect logging levels to styles
+        from psychopy import logging
+        self.logLevelStyles = {
+            logging.NOTSET: self._styles['base'],
+            logging.DEBUG: self._styles['info'],
+            logging.INFO: self._styles['info'],
+            logging.EXP: self._styles['info'],
+            logging.DATA: self._styles['info'],
+            logging.WARNING: self._styles['warning'],
+            logging.ERROR: self._styles['error'],
+            logging.CRITICAL: self._styles['error'],
+        }
 
     def onURL(self, evt=None):
         wx.BeginBusyCursor()
@@ -119,6 +131,7 @@ class StdOutRich(wx.richtext.RichTextCtrl, _BaseErrorHandler, handlers.ThemeMixi
             class WordFetcher:
         File "C:\\Program Files\\wxPython2.8 Docs and Demos\\samples\\hangman\\hangman.py", line 23, in WordFetcher
         """
+        from psychopy import logging
 
         if type(inStr) == AlertEntry:
             alert = inStr
@@ -174,17 +187,20 @@ class StdOutRich(wx.richtext.RichTextCtrl, _BaseErrorHandler, handlers.ThemeMixi
                     self.BeginURL(thisLine)
                     self.WriteText(thisLine)
                     self.EndURL()
-                elif len(re.findall('CRITICAL|ERROR', thisLine)) > 0:
-                    # this line contains an error
-                    self.BeginStyle(self._styles['error'])
-                    self.WriteText(thisLine)
-                elif len(re.findall('WARNING|DEPRECATION', thisLine)) > 0:
-                    # this line contains a warning
-                    self.BeginStyle(self._styles['warning'])
-                    self.WriteText(thisLine)
-                elif len(re.findall('DATA|EXP|INFO|DEBUG', thisLine)):
-                    # this line contains logging
-                    self.BeginStyle(self._styles['info'])
+                elif re.findall(logging._levelNamesRe, thisLine):
+                    # this line contains a logging message
+                    lvl = logging.NOTSET
+                    # for each styled level...
+                    for thisLvl, style in self.logLevelStyles.items():
+                        # get its name
+                        name = logging._levelNames[thisLvl]
+                        # look for name in the current line
+                        if len(re.findall(name, thisLine)) > 0:
+                            # if found, set level and stop looking
+                            lvl = thisLvl
+                            break
+                    # if level allowed by prefs, set style and write
+                    self.BeginStyle(self.logLevelStyles[lvl])
                     self.WriteText(thisLine)
                 else:
                     # anything else

psychopy/app/themes/icons.py

@@ -4,7 +4,7 @@ from abc import ABC
 import numpy
 import wx
 from pathlib import Path
-from psychopy import prefs
+from psychopy import prefs, logging
 from . import theme as appTheme
 
 retStr = ""
@@ -18,7 +18,7 @@ class BaseIcon:
         self.bitmaps = {}
         self._bitmap = None
         self.size = size
-
+        self.stem = stem
         if theme in (appTheme.icons, None) and stem in iconCache:
             # Duplicate relevant attributes if relevant (depends on subclass)
             self.bitmaps = iconCache[stem].bitmaps
@@ -30,6 +30,19 @@ class BaseIcon:
             # Store ref to self in iconCache if using app theme
             if theme in (appTheme.icons, None):
                 iconCache[stem] = self
+    
+    def reload(self, theme=None):
+        """
+        Get all images associated with this icon again. This is useful when changeing theme to one 
+        with different icons.
+
+        Parameters
+        ----------
+        theme : str, optional
+            Theme to get icons from, by default will use the current theme
+        """
+        self._populate(stem=self.stem, theme=theme)
+
 
     def _populate(self, stem, theme=None):
         raise NotImplementedError(
@@ -132,6 +145,8 @@ class ButtonIcon(BaseIcon):
             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)
         # Create blank arrays to store retina and non-retina files
         ret = {}
         nret = {}
@@ -248,3 +263,38 @@ 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/changes/2023.1.0.md

@@ -0,0 +1,9 @@
+# Changes in 2023.1.0
+
+## Introducing: Plugins
+Over the years, PsychoPy has gotten pretty big! We have a lot more functionality than when we 
+first started, but with that comes more packages and dependencies. In 2023.1.0 we introduced 
+plugins - making certain functinality optional rather than coming with PsychoPy by default. 
+Check out the "Plugins & packages manager" in the "Tools" menu to see what's available.
+
+[Click here for more information about plugins.](https://www.psychopy.org/usingplugins.html)

psychopy/changes/2024.1.0.md

@@ -0,0 +1,16 @@
+# Changes in 2024.1.0
+
+## Introducing: Pilot mode
+You may have noticed a new toggle button in the Builder toolbar - pressing it changes the run 
+buttons from green to orange. This button toggles the new "pilot mode" on and off. When in pilot 
+mode, the "Run in JS" button will run your experiment locally in your browser rather than on 
+Pavlovia, and the "Run in Python" button will run your experiment with a few (configurable) 
+adjustments, most noticeably:
+- It will always run in Windowed mode, making it easier to escape if something goes wrong
+- It will always run with full logging, so you get the maximum amount of info
+
+To make it extra clear that you are in piloting mode, there's also a pretty noticeable orange 
+border around the window, so you don't run on actual participants while in this mode.
+
+The purpose of piloting mode is to give you a safer environment to build your experiment in, 
+after which you can switch to running mode when you're ready to start gathering data.

psychopy/clock.py

@@ -23,7 +23,7 @@ import time
 import sys
 from datetime import datetime
 
-from pkg_resources import parse_version
+from packaging.version import Version
 
 try:
     import pyglet
@@ -507,7 +507,7 @@ def _dispatchWindowEvents():
     # let's see if pyglet collected any event in meantime
     try:
         # this takes focus away from command line terminal window:
-        if parse_version(pyglet.version) < parse_version('1.2'):
+        if Version(pyglet.version) < Version('1.2'):
             # events for sounds/video should run independently of wait()
             pyglet.media.dispatch_events()
     except AttributeError:

psychopy/colors.py

@@ -389,7 +389,8 @@ class Color:
         adj = np.clip(self.rgb * contrast, -1, 1)
         buffer = self.copy()
         buffer.rgb = adj
-        return getattr(buffer, space)
+        self._renderCache[space] = getattr(buffer, space)
+        return self._renderCache[space]
 
     def __repr__(self):
         """If colour is printed, it will display its class and value.

psychopy/compatibility.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
+from pathlib import Path
+from packaging.version import Version
 import psychopy.data
 
 ######### Begin Compatibility Class Definitions #########
@@ -93,3 +94,54 @@ def checkCompatibility(old, new, prefs=None, fix=True):
         msg += "\nNo known compatibility issues"
 
     return (not warning), msg
+
+
+def checkUpdatesInfo(old, new):
+    """
+    Checks whether we need to display information from a new update, e.g. introducing a new feature.
+
+    Parameters
+    ----------
+    old : str or packaging.version.Version
+        Last version which was opened
+    new : str or packaging.version.Version
+        Current version
+    prefs : psychopy.preferences.Preferences
+        Preferences for the app
+
+    Returns
+    -------
+    list[str]
+        List of strings with markdown content for relevant updates
+    """
+    from psychopy.preferences import prefs
+    # make sure both versions are Version objects
+    if isinstance(old, str):
+        old = Version(old)
+    if isinstance(new, str):
+        new = Version(new)
+    # start off with no messages
+    messages = []
+    # if not a new version, no action needed
+    if old >= new:
+        return messages
+    # find changes folder
+    changesDir = Path(prefs.paths['psychopy']) / "changes"
+    # if it is a new version, check for updates
+    for file in changesDir.glob("*.md"):
+        # try to Version-ise target
+        try:
+            target = Version(file.stem)
+        except (TypeError, ValueError):
+            # skip if it fails
+            continue
+        # have we just crossed the target version?
+        if old < target < new:
+            # load the markdown file
+            msg = file.read_text(encoding="utf-8")
+            # add its contents to messages array
+            messages.append(msg)
+    # reverse messages so they go from most-to-least recent
+    messages.reverse()
+
+    return messages

psychopy/contrib/configobj/__init__.py

@@ -45,26 +45,28 @@ BOMS = {
     BOM_UTF16_LE: ('utf16_le', 'utf_16'),
     BOM_UTF16: ('utf_16', 'utf_16'),
     }
+
 # All legal variants of the BOM codecs.
-# TODO: the list of aliases is not meant to be exhaustive, is there a
-#   better way ?
 BOM_LIST = {
     'utf_16': 'utf_16',
-    'u16': 'utf_16',
     'utf16': 'utf_16',
     'utf-16': 'utf_16',
-    'utf16_be': 'utf16_be',
     'utf_16_be': 'utf16_be',
     'utf-16be': 'utf16_be',
-    'utf16_le': 'utf16_le',
     'utf_16_le': 'utf16_le',
     'utf-16le': 'utf16_le',
     'utf_8': 'utf_8',
-    'u8': 'utf_8',
-    'utf': 'utf_8',
     'utf8': 'utf_8',
     'utf-8': 'utf_8',
-    }
+    'u16': 'utf_16',  # Add mapping for 'u16'
+    'u8': 'utf_8',    # Add mapping for 'u8'
+}
+
+# Add regular expressions for matching variations
+for encoding in ['utf-16', 'utf-8']:
+    regex = re.compile(fr'{encoding}(?:_|\-)?(?:be|le)?|u16|u8', re.IGNORECASE)
+    for match in filter(regex.fullmatch, BOM_LIST.keys()):
+        BOM_LIST[match] = BOM_LIST[encoding]
 
 # Map of encodings to the BOM to write.
 BOM_SET = {

psychopy/data/__init__.py

@@ -3,9 +3,10 @@
 
 import sys
 
-from pkg_resources import parse_version
+from packaging.version import Version
 
 from .base import DataHandler
+from .routine import Routine
 from .experiment import ExperimentHandler
 from .trial import TrialHandler, TrialHandler2, TrialHandlerExt, TrialType
 from .staircase import (StairHandler, QuestHandler, PsiHandler,
@@ -27,7 +28,7 @@ from .fit import (FitFunction, FitCumNormal, FitLogistic, FitNakaRushton,
 try:
     # import openpyxl
     import openpyxl
-    if parse_version(openpyxl.__version__) >= parse_version('2.4.0'):
+    if Version(openpyxl.__version__) >= Version('2.4.0'):
         # openpyxl moved get_column_letter to utils.cell
         from openpyxl.utils.cell import get_column_letter
     else:

psychopy/data/base.py

@@ -11,7 +11,7 @@ import codecs
 import numpy as np
 import pandas as pd
 import json_tricks
-from pkg_resources import parse_version
+from packaging.version import Version
 
 import psychopy
 from psychopy import logging
@@ -23,7 +23,7 @@ from .utils import _getExcelCellName
 
 try:
     import openpyxl
-    if parse_version(openpyxl.__version__) >= parse_version('2.4.0'):
+    if Version(openpyxl.__version__) >= Version('2.4.0'):
         # openpyxl moved get_column_letter to utils.cell
         from openpyxl.utils.cell import get_column_letter
     else:
@@ -120,7 +120,7 @@ class _BaseTrialHandler(_ComparisonMixin):
         """
         fileName = pathToString(fileName)
 
-        if self.thisTrialN < 1 and self.thisRepN < 1:
+        if self.thisTrialN < 0 and self.thisRepN < 0:
             # if both are < 1 we haven't started
             if self.autoLog:
                 logging.info('.saveAsPickle() called but no trials completed.'
@@ -191,7 +191,7 @@ class _BaseTrialHandler(_ComparisonMixin):
         if stimOut is None:
             stimOut = []
 
-        if self.thisTrialN < 1 and self.thisRepN < 1:
+        if self.thisTrialN < 0 and self.thisRepN < 0:
             # if both are < 1 we haven't started
             if self.autoLog:
                 logging.info('TrialHandler.saveAsText called but no trials'
@@ -306,7 +306,7 @@ class _BaseTrialHandler(_ComparisonMixin):
         if stimOut is None:
             stimOut = []
 
-        if self.thisTrialN < 1 and self.thisRepN < 1:
+        if self.thisTrialN < 0 and self.thisRepN < 0:
             # if both are < 1 we haven't started
             if self.autoLog:
                 logging.info('TrialHandler.saveAsExcel called but no '

psychopy/data/experiment.py

@@ -9,6 +9,7 @@ import pandas as pd
 
 from psychopy import constants, clock
 from psychopy import logging
+from psychopy.data.trial import TrialHandler2
 from psychopy.tools.filetools import (openOutputFile, genDelimiter,
                                       genFilenameFromDelimiter)
 from psychopy.localization import _translate
@@ -456,6 +457,112 @@ class ExperimentHandler(_ComparisonMixin):
         # set own status
         self.status = constants.STOPPED
 
+    def skipTrials(self, n=1):
+        """
+        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.
+
+        Parameters
+        ----------
+        n : int
+            Number of trials to skip ahead
+        """
+        # return if there isn't a TrialHandler2 active
+        if not isinstance(self.currentLoop, TrialHandler2):
+            return
+        # skip trials in current loop
+        self.currentLoop.skipTrials(n)
+
+    def rewindTrials(self, n=1):
+        """
+        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.
+
+        Parameters
+        ----------
+        n : int
+            Number of trials to skip ahead
+        """
+        # return if there isn't a TrialHandler2 active
+        if not isinstance(self.currentLoop, TrialHandler2):
+            return
+        # rewind trials in current loop
+        self.currentLoop.rewindTrials(n)
+    
+    def getAllTrials(self):
+        """
+        Returns all trials (elapsed, current and upcoming) with an index indicating which trial is 
+        the current trial.
+
+        Returns
+        -------
+        list[Trial]
+            List of trials, in order (oldest to newest)
+        int
+            Index of the current trial in this list
+        """
+        # return None if there isn't a TrialHandler2 active
+        if not isinstance(self.currentLoop, TrialHandler2):
+            return [None], 0
+        # get all trials from current loop
+        return self.currentLoop.getAllTrials()
+
+    def getCurrentTrial(self):
+        """
+        Returns the current trial (`.thisTrial`)
+
+        Returns
+        -------
+        Trial
+            The current trial
+        """
+        # return None if there isn't a TrialHandler2 active
+        if not isinstance(self.currentLoop, TrialHandler2):
+            return None
+        
+        return self.currentLoop.getCurrentTrial()
+    
+    def getFutureTrial(self, n=1):
+        """
+        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.
+        """
+        # return None if there isn't a TrialHandler2 active
+        if not isinstance(self.currentLoop, TrialHandler2):
+            return None
+        # get future trial from current loop
+        return self.currentLoop.getFutureTrial(n)
+
+    def getFutureTrials(self, n=1, start=0):
+        """
+        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 
+        future to 5 in the future you would use `start=2` and `n=3`.
+
+        Parameters
+        ----------
+        n : int, optional
+            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
+        
+        Returns
+        -------
+        list[Trial or None]
+            List of Trial objects n long. Any trials beyond the last trial are None.
+        """
+        # blank list to store trials in
+        trials = []
+        # iterate through n trials
+        for i in range(n):
+            # add each to the list
+            trials.append(
+                self.getFutureTrial(start + i)
+            )
+        
+        return trials
+
     def nextEntry(self):
         """Calling nextEntry indicates to the ExperimentHandler that the
         current trial has ended and so further addData() calls correspond
@@ -464,9 +571,7 @@ class ExperimentHandler(_ComparisonMixin):
         this = self.thisEntry
         # fetch data from each (potentially-nested) loop
         for thisLoop in self.loopsUnfinished:
-            names, vals = self._getLoopInfo(thisLoop)
-            for n, name in enumerate(names):
-                this[name] = vals[n]
+            self.updateEntryFromLoop(thisLoop)
         # add the extraInfo dict to the data
         if type(self.extraInfo) == dict:
             this.update(self.extraInfo)
@@ -474,6 +579,24 @@ class ExperimentHandler(_ComparisonMixin):
         # add new entry with its
         self.thisEntry = {}
 
+    def updateEntryFromLoop(self, thisLoop):
+        """
+        Add all values from the given loop to the current entry.
+
+        Parameters
+        ----------
+        thisLoop : BaseLoopHandler
+            Loop to get fields from
+        """
+        # for each name and value in the current trial...
+        names, vals = self._getLoopInfo(thisLoop)
+        for n, name in enumerate(names):
+            # add/update value
+            self.thisEntry[name] = vals[n]
+            # make sure name is in data names
+            if name not in self.dataNames:
+                self.dataNames.append(name)
+
     def getAllEntries(self):
         """Fetches a copy of all the entries including a final (orphan) entry
         if that exists. This allows entries to be saved even if nextEntry() is
@@ -563,7 +686,9 @@ class ExperimentHandler(_ComparisonMixin):
                            encoding=encoding)
 
         names = self._getAllParamNames()
-        names.extend(self.dataNames)
+        for name in self.dataNames:
+            if name not in names:
+                names.append(name)
         # names from the extraInfo dictionary
         names.extend(self._getExtraInfo()[0])
         if len(names) < 1:
@@ -676,6 +801,7 @@ class ExperimentHandler(_ComparisonMixin):
         # put in context
         context = {
             'type': "trials_data",
+            'thisTrial': self.thisEntry,
             'trials': trials.to_dict(orient="records"),
             'priority': self.columnPriority,
             'threshold': priorityThreshold,

psychopy/data/routine.py

@@ -0,0 +1,56 @@
+from psychopy import constants
+
+class Routine:
+    """
+    Object representing a Routine, used to store start/stop times and other aspects of Routine settings.
+
+    Parameters
+    ----------
+    name : str
+        Name of the Routine
+    components : list[object]
+        List of handles to Components associated with this Routine
+    maxDuration : float or None
+        Maximum time this Routine can take. None if there is no maximum.
+    
+    Attributes
+    ----------
+    tStart : float or None
+        Time (UTC) when this Routine started
+    tStartRefresh : float or None
+        Time (UTC) of the first frame flip of this Routine
+    tStop : float or None
+        Time (UTC) when this Routine ended
+    tStopRefresh : float or None
+        Time (UTC) of the last frame flip of this Routine
+    maxDurationReached : bool
+        True if this Routine ended by its max duration being reached
+    skipped : bool
+        True if this Routine was skipped by the "Skip if..." parameter of its settings
+    forceEnded : bool
+        True if this Routine was forcibly ended (e.g. by a key press)
+    status : int
+        Value from psychopy.constants.status indicating whether this Routine has started, is finished, etc.
+    """
+    def __init__(
+        self,
+        name,
+        components=[],
+        maxDuration=None,
+    ):
+        self.name = name
+        self.components = components
+        self.maxDuration = maxDuration
+        # start all times as None
+        self.tStart = None
+        self.tStartRefresh = None
+        self.tStop = None
+        self.tStopRefresh = None
+        # start off assuming not skipped, timed out or force ended
+        self.maxDurationReached = False
+        self.skipped = False
+        self.forceEnded = False
+        # starting status
+        self.status = constants.NOT_STARTED
+    
+    

psychopy/data/staircase.py

@@ -7,7 +7,7 @@ import pickle
 import copy
 import warnings
 import numpy as np
-from pkg_resources import parse_version
+from packaging.version import Version
 
 import psychopy
 from psychopy import logging
@@ -26,7 +26,7 @@ except ImportError:
 try:
     # import openpyxl
     import openpyxl
-    if parse_version(openpyxl.__version__) >= parse_version('2.4.0'):
+    if Version(openpyxl.__version__) >= Version('2.4.0'):
         # openpyxl moved get_column_letter to utils.cell
         from openpyxl.utils.cell import get_column_letter
     else: