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

psychopy/CHANGELOG.txt

@@ -1038,11 +1038,11 @@ PsychoPy 2021.1
 
 The first major release of 2021 brings a lot of fixes (the dev team is focussing heavily on making the user experience more smooth at the moment).
 
-On top of those fixes are a number of useful additions though, like the new :ref:`buttonComponent`.
+On top of those fixes are a number of useful additions though, like the new :ref:`buttoncomponent`.
 
 NEW:
 
-- Builder has a :ref:`buttonComponent` to make it easier to have clickable image/text objects
+- Builder has a :ref:`buttoncomponent` to make it easier to have clickable image/text objects
 - Builder: Improved layout of Component dialogs:
   
     - Consistent tabs for common parameters (like pos, size, color...)
@@ -2599,7 +2599,7 @@ PsychoPy 1.78.00
 
 Released: Aug 2013
 
-* ADDED: option to preload during Builder scripts using :ref:`static`, which uses :class:`~psychopy.core.StaticPeriod` class
+* ADDED: option to preload during Builder scripts using :ref:`staticcomponent`, which uses :class:`~psychopy.core.StaticPeriod` class
 * ADDED: Polygon Component to Builder for drawing regular polygons (including simple lines)
 * ADDED: TrialHander can now fetch previous trials as well as future ones (thanks Mike MacAskill)
 * ADDED: BufferImageStim accepts mask and pos params (thanks Jeremy)
@@ -2964,7 +2964,7 @@ PsychoPy 1.70.00
 *NB This version introduces a number of changes to Builder experiment files that will prevent files from this version being opened by earlier versions of PsychoPy*
 
 * CHANGED use of allowedKeys in Keyboard Component. You used to be able to type `ynq` to get those keys, but this was confusing when you then needed `'space'` or `'left'` etc. Now you must type 'y','n','q', which makes it more obvious how to include 'space','left','right'...
-* CHANGED dot algorithm in DotStim. Previously the signalDots=same/different was using the opposite to Scase et al's terminology, now they match. Also the default method for noiseDots was 'position' and this has been changed to 'direction'. The documentation explaining the algorithms has been clarified. (see :ref:`dots`)
+* CHANGED dot algorithm in DotStim. Previously the signalDots=same/different was using the opposite to Scase et al's terminology, now they match. Also the default method for noiseDots was 'position' and this has been changed to 'direction'. The documentation explaining the algorithms has been clarified. (see :ref:`dotscomponent`)
 * CHANGED `MovieStim.playing` property to be called `MovieStim.status` (in keeping with other stimuli)
 * CHANGED names:
 

psychopy/GIT_SHA

@@ -1 +1 @@
-e64d50fd614fbc6da79183a58665f0c428606139
+n/a

psychopy/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2002-2019, Jon Peirce. (c) 2019-2024 Open Science Tools Ltd
+Copyright (c) 2002-2019, Jon Peirce. (c) 2019-2025 Open Science Tools Ltd
 All rights reserved.
 
 PsychoPy is a Registered Trademark of Open Science Tools Ltd.

psychopy/VERSION

@@ -1 +1 @@
-2024.2.5
+2025.1.0

psychopy/__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).
 
 import os
@@ -61,18 +61,18 @@ if 'installing' not in locals():
     if not useDefaultSite:
         env = os.environ.copy()
         if 'PYTHONPATH' in env:  # append entries to existing PYTHONPATH
+            _userPackages = str(prefs.paths['packages'])
+            if _userPackages not in env['PYTHONPATH']:
+                env['PYTHONPATH'] = os.pathsep.join([
+                    env['PYTHONPATH'], _userPackages])
             _userSitePackages = str(prefs.paths['userPackages'])
             if _userSitePackages not in env['PYTHONPATH']:
                 env['PYTHONPATH'] = os.pathsep.join([
                     env['PYTHONPATH'], _userSitePackages])
-            _userPackages = str(prefs.paths['packages'])
-            if _userPackages not in env['PYTHONPATH']:
-                env['PYTHONPATH'] = os.pathsep.join([
-                    env['PYTHONPATH'], _userPackages]) 
         else:
             env['PYTHONPATH'] = os.pathsep.join([
-                str(prefs.paths['userPackages']), 
-                str(prefs.paths['packages'])])
+                str(prefs.paths['packages']),
+                str(prefs.paths['userPackages'])])
 
         # set user site packages
         env['PYTHONUSERBASE'] = prefs.paths['packages']
@@ -87,6 +87,9 @@ if 'installing' not in locals():
                 env['_PIP_USE_IMPORTLIB_METADATA'] = 'True'
 
         # update environment, pass this to sub-processes (e.g. pip)
+        # make sure all environment variables are strings, sometimes these are
+        # pass as Path() objects
+        env = {k: str(v) for k, v in env.items()}
         os.environ.update(env)
 
         # make sure site knows about our custom user site-packages

psychopy/alerts/__init__.py

@@ -1,7 +1,7 @@
 """
 The Alert module
 """
-from ._alerts import alert, catalog
+from ._alerts import alert, isAlertHandler, addAlertHandler, removeAlertHandler, catalog
 
 import yaml
 from pathlib import Path

psychopy/alerts/_alerts.py

@@ -161,26 +161,62 @@ def alert(code=None, obj=object, strFields=None, trace=None):
                         cat=msg.cat,
                         msg=msg.msg,
                         trace=msg.trace))
-    # msgAsStr = ("Component Type: {type} | "
-    #             "Component Name: {name} | "
-    #             "Code: {code} | "
-    #             "Category: {cat} | "
-    #             "Message: {msg} | "
-    #             "Traceback: {trace}".format(type=msg.type,
-    #                                         name=msg.name,
-    #                                         code=msg.code,
-    #                                         cat=msg.cat,
-    #                                         msg=msg.msg,
-    #                                         trace=msg.trace))
-
-    # if a psychopy warning instead of a file-like stderr then pass a raw str
-    if hasattr(sys.stderr, 'receiveAlert'):
+    if len(_activeAlertHandlers):
+        # if we have any active handlers, send to them
+        for handler in _activeAlertHandlers:
+            # send alert
+            handler.receiveAlert(msg)
+    elif hasattr(sys.stderr, 'receiveAlert'):
+        # if there aren't any, but stdout can receive alerts, send to stdout
         sys.stderr.receiveAlert(msg)
     else:
-        # For tests detecting output - change when error handler set up
+        # otherwise, just write as a string to stdout
         sys.stderr.write(msgAsStr)
-        for handler in _activeAlertHandlers:
-            handler.receiveAlert(msg)
+
+
+def isAlertHandler(handler):
+    """
+    Is the given handler an alert handler?
+
+    Parameters
+    ----------
+    handler : ScriptOutputCtrl
+        Handler to query.
+    
+    Returns
+    -------
+    bool
+        True if the given handler is an alert handler.
+    """
+    return handler in _activeAlertHandlers
+
+
+def addAlertHandler(handler):
+    """
+    Add a handler to the list of active alert handlers.
+
+    Parameters
+    ----------
+    handler : ScriptOutputCtrl
+        Handler to add.
+    """
+    if not isAlertHandler(handler):
+        _activeAlertHandlers.append(handler)
+
+
+def removeAlertHandler(handler):
+    """
+    Remove a handler from the list of active alert handlers.
+
+    Parameters
+    ----------
+    handler : ScriptOutputCtrl
+        Handler to remove.
+    """
+    if isAlertHandler(handler):
+        _activeAlertHandlers.pop(
+            _activeAlertHandlers.index(handler)
+        )
 
 
 # Create catalog

psychopy/alerts/_errorHandler.py

@@ -2,11 +2,9 @@
 # -*- 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).
 
-from ._alerts import _activeAlertHandlers
-
 
 class _BaseErrorHandler:
     """A base class for handling PsychoPy alerts and exceptions.
@@ -17,7 +15,6 @@ class _BaseErrorHandler:
         self.alerts = []
         self.alwaysReceive = alwaysReceive
         self.autoFlush = autoFlush
-        _activeAlertHandlers.append(self)
 
     def write(self, toWrite):
         """This is needed for any Python Exceptions, which assume the stderr
@@ -46,6 +43,8 @@ class _BaseErrorHandler:
             A data object containing alert information.
         """
         self.alerts.append(alert)
+        if self.autoFlush:
+            self.flush()
 
     def __del__(self):
         self.flush()

psychopy/alerts/alertsCatalogue/3210.yaml

@@ -0,0 +1,27 @@
+# The first key-value pair is used for the alerts package
+
+code: 3210
+cat: Audio
+msg: Speaker {deviceName} is set to "Exclusive low latency" mode. As resampling is enabled, this mode has little benefit over "Shared low latency" mode, with some drawbacks.
+
+# The following are typically used for online help pages, and support reStructured Text.
+
+label: Exclusive latency mode
+
+synopsis: |
+  Speaker is set to "Exclusive low latency" mode. As resampling is enabled, this mode has little benefit over "Shared low latency" mode, with some drawbacks.
+
+details: |
+  "Exclusive low latency" mode differs from "Shared low latency" mode in two ways:
+  - PsychoPy will take exclusive control of the speaker, meaning that other apps won't be able to access it while your experiment is running, and may crash.
+  - Because of this exclusive control, we have more flexibility in the range of sample rates which we can play on the speaker.
+
+  However, if "resampling" is ticked, then audio is automatically resampled to match the speaker's sample rate anyway, so "Exclusive low latency" offers little benefit over "Shared low latency".
+
+solutions: |
+  If you actively want to prevent the speaker from being used by other applications (for example, you want to make sure the participant isn't playing music in the background), then no action is required and you can ignore this alert.
+
+  If you don't want this, then you most likely want "Shared low latency" mode instead.
+
+versions: |
+  >2025.1.0

psychopy/alerts/alertsCatalogue/3610.yaml

@@ -0,0 +1,19 @@
+
+code: 3610
+cat: Validation
+msg: Multiple Components in the same Routine are validated by {validator}, please ensure that the timing of these Components do not overlap.
+
+# The following are typically used for online help pages, and support reStructured Text.
+label: Multiple Components in same Routine validated by same validator
+
+synopsis: |
+  A validator can only validate one stimulus at a time, but it looks like you have multiple stimuli in the same Routine which are validated by the same validator. This may be fine, but you will need to be sure that they don't overlap in their timing.
+
+details: |
+  A validator can only validate one stimulus at a time, as they only respond True/False for whether there's light/sound, not distinguishing between different sources. If you have two stimuli at the same time, then they will obscure the start/stop times of one another, meaning your validator will give the wrong results. 
+
+solutions: |
+  This may be fine! You just need to make sure that the multiple Components in the same Routine which are validated by the same validator aren't overlapping in their timing. If they're not, you can ignore this!
+
+versions: |
+  >2025.1.0

psychopy/alerts/alertsCatalogue/4130.yaml

@@ -0,0 +1,19 @@
+
+code: 4130
+cat: Timing
+msg: Static Component `{name}` given infinite stop time
+
+# The following are typically used for online help pages, and support reStructured Text.
+label: Static Component given infinite stop time
+
+synopsis: |
+  Static Component pauses the frame loop while it's active, meaning that unlike other Components, it needs to have a fixed stop time to know when to finish. Otherwise, the experiment will simply stall forever, even if there's code in the Each Frame tab of a Code Component to end the experiment / stop the Static Component (as the frame loop is paused, so Each Frame code isn't happening). You won't even be able to end the experiment with the ESCAPE key as this is checked each frame!
+
+details: |
+  The only instance where you might want an infinite Static Component is if you're using threading, as threaded operations don't rely on a frame loop to execute their code. In this case, you can ignore this message. However, this is a rare and fairly advanced use case, so if the previous sentences sounded like jibberish, you almost certainly don't want an infinite Static Component!  
+
+solutions: |
+  Give your Static Component a fixed duration.
+
+versions: |
+  All

psychopy/alerts/alertsCatalogue/alertCategories.yaml

@@ -25,8 +25,14 @@
     cat: Visual
     3110: Component duration less than 1 screen refresh
     3115: Component start/stop times cannot sync with screen refresh
-  3200: Audio
+  3200:
+    cat: Audio
+    3210: Exclusive latency mode
+
   3400: Response
+  3600:
+    cat: Validation
+    3610: Multiple Components in same Routine validated by same validator
 
 4000:
   cat: Builder experiments
@@ -40,6 +46,7 @@
     4115: Frames must be given as whole numbers
     4120: Component stop duration with no start time
     4125: Microphone given no stop duration
+    4130: Static Component given infinite stop time
   4200:
     cat: Code component syntax
     4205: Python syntax error

psychopy/alerts/alertsCatalogue/alertmsg.py

@@ -76,7 +76,7 @@ _translate(
 
 # Alert 4325
 _translate(
-    "Font `{font} {style}` not available in weight `{weight}`, component `{name}` will default to Open Sans Regular.")
+    "Font `{font} {style}` not available in weight `{weight}`, component `{name}` will default to Noto Sans Regular.")
 
 # Alert 4330
 _translate(

psychopy/alerts/alerttools.py

@@ -5,9 +5,7 @@ from esprima import parseScript
 
 from psychopy.tools import monitorunittools
 from psychopy.alerts._alerts import alert
-from psychopy.tools.fontmanager import FontManager
 
-fontMGR = FontManager()
 
 class TestWin:
     """
@@ -261,20 +259,6 @@ def testDisabled(component):
     if component.params['disabled'].val:
         alert(4305, component, strFields={'name': component.params['name']})
 
-def testFont(component):
-    """
-    Tests whether font is stored locally or whether it needs to be retrieved from Google Fonts
-
-    Parameters
-    ----------
-    component: Component
-        The component used for testing
-    """
-    if 'font' in component.params:
-        fontInfo = fontMGR.getFontsMatching(component.params['font'].val, fallback=False)
-        if not fontInfo:
-            alert(4320, strFields={'param': component.params['font']})
-
 def testDollarSyntax(component):
     """
     Tests that use of dollar signs in Builder components to denote literal interpretation are used correctly