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

psychopy/sound/sound.py

@@ -0,0 +1,58 @@
+import importlib.metadata
+
+
+class Sound:
+    """
+    Class for playing a sound in PsychoPy. See specific sound backends for details and methods for 
+    implementations of Sound.
+    """
+    
+    # name of the backend to use for Sound objects
+    backend = "ptb"
+
+    def __new__(cls, *args, **kwargs):
+        # get backends
+        backends = cls.getBackends()
+        # if not present, error
+        if cls.backend not in backends:
+            raise ModuleNotFoundError(f"Invalid value '{cls.backend}' for Sound.backend, known backends are: {list(backends)}")
+        # import backend
+        backend = backends[cls.backend].load()
+        return backend.Sound(*args, **kwargs)
+    
+    @classmethod
+    def getBackends(cls):
+        """
+        Get all available Sound backends (by name)
+
+        Returns
+        -------
+        dict[str:importlib.metadata.EntryPoint]
+            Dict mapping backend names to backend entry points - call `.load` on an entry point to 
+            import the relevant module.
+        """
+        # start off with builtin backends
+        backends = {
+            ep.name: ep for ep in [
+                importlib.metadata.EntryPoint(
+                    name="ptb", 
+                    value="psychopy.sound.backend_ptb", 
+                    group="psychopy.sound.backends"
+                ),
+                importlib.metadata.EntryPoint(
+                    name="pygame", 
+                    value="psychopy.sound.backend_pygame", 
+                    group="psychopy.sound.backends"
+                ),
+                importlib.metadata.EntryPoint(
+                    name="pysound", 
+                    value="psychopy.sound.backend_pysound", 
+                    group="psychopy.sound.backends"
+                )
+            ]
+        }
+        # get others from plugins
+        for ep in importlib.metadata.entry_points(group="psychopy.sound.backends"):
+            backends[ep.name] = ep
+        
+        return backends

psychopy/tests/data/correctScript/python/correctNoiseStimComponent.py

@@ -110,7 +110,7 @@ for thisComponent in trialComponents:
 while continueRoutine and routineTimer.getTime() > 0:
     # get current time
     t = trialClock.getTime()
-    frameN = frameN + 1  # number of completed frames (so 0 is the first frame)
+    frameN += 1  # number of completed frames (so 0 is the first frame)
     # update/draw components on each frame
     
     # *noise* updates

psychopy/tests/data/duplicateHeaders.csv

@@ -0,0 +1,2 @@
+dupe;dupe;unique1;unique2
+red;blue;green;green

psychopy/tests/test_app/test_builder/test_BuilderFrame.py

@@ -122,8 +122,8 @@ class Test_BuilderFrame():
 
         # Define 'tykes' - combinations of values likely to cause an error if certain features aren't working
         tykes = [
-            {'fieldName': "brokenCode", 'param': Param(val="for + :", valType="code"), 'msg': "Python syntax error in field `{fieldName}`:  {param.val}"}, # Make sure it's picking up clearly broken code
-            {'fieldName': "variableDef", 'param': Param(val="visual = 1", valType="code"), 'msg': "Variable name $visual is in use (by Psychopy module). Try another name."},
+            {'fieldName': "brokenCode", 'param': Param(val="for + :", valType="code"), 'msg': "Python syntax error in field `brokenCode`:  "}, # Make sure it's picking up clearly broken code
+            {'fieldName': "variableDef", 'param': Param(val="visual = 1", valType="extendedCode"), 'msg': "Setting the variable `visual` will overwrite an existing variable (Psychopy module)"},
             {'fieldName': "correctAns", 'param': Param(val="'space'", valType="code"), 'msg': ""}, # Single-element lists should not cause warning
         ]
         for case in tykes:
@@ -140,12 +140,27 @@ class Test_BuilderFrame():
             timeout=500)
         # Does the message delivered by the validator match what is expected?
         for case in tykes:
+            # get warning for the relevant ctrl
+            warning = dlg.paramCtrls[case['fieldName']].valueCtrl.getWarning()
+            # make sure warning is correct
             if case['msg']:
-                assert case['msg'].format(**case) in dlg.warnings.messages, (
-                    "Error for param {fieldName} with value `{val}` should include:\n"
-                    "'{msg}'\n"
-                    "but instead was:\n"
+                assert case['msg'] in warning.msg, (
+                    "Param {fieldName} with value `{param}` should raise a warning:\n"
+                    "{msg}\n"
+                    "but instead raised:\n"
                     "{actual}\n"
-                ).format(**case, val=case['param'].val.format(**case), actual=dlg.warnings.messages)
+                ).format(
+                    **case, 
+                    actual=warning.msg
+                )
+            else:
+                assert warning is None, (
+                    "Param {fieldName} with value `{param}` should not raise a warning, but "
+                    "raised:\n"
+                    "{actual}"
+                ).format(
+                    **case, 
+                    actual=warning.msg
+                )
         # Cleanup
         dlg.Destroy()

psychopy/tests/test_app/test_builder/test_CompileFromBuilder.py

@@ -65,7 +65,6 @@ class Test_PsychoJS_from_Builder():
         exp = experiment.Experiment()
         exp.loadFromXML(demosDir/'builder'/'Experiments'/'stroop'/'stroop.psyexp')
         # try once packaging up the js libs
-        exp.settings.params['JS libs'].val = 'remote'
         outFolder = self.temp_dir/'stroopJS_remote/html'
         os.makedirs(outFolder)
         self.writeScript(exp, outFolder)
@@ -75,7 +74,6 @@ class Test_PsychoJS_from_Builder():
         exp = experiment.Experiment()
         exp.loadFromXML(demosDir/'builder'/'Design Templates'/'randomisedBlocks'/'randomisedBlocks.psyexp')
         # try once packaging up the js libs
-        exp.settings.params['JS libs'].val = 'packaged'
         outFolder = self.temp_dir/'blocked_packaged/html'
         os.makedirs(outFolder)
         self.writeScript(exp, outFolder)

psychopy/tests/test_data/test_utils.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 import os
+from pathlib import Path
 import pytest
 import numpy as np
 
@@ -57,7 +58,10 @@ class Test_utilsClass:
         with pytest.raises(exceptions.ConditionsImportError) as errMsg:
             utils.importConditions(fileName_docx)
         assert ('Your conditions file should be an ''xlsx, csv, dlm, tsv or pkl file') == str(errMsg.value)
-
+        # test that duplicate headers are caught
+        with pytest.raises(exceptions.ConditionsImportError) as err:
+            utils.importConditions(str(Path(fixturesPath) / "duplicateHeaders.csv"))
+        assert "'dupe'" in str(err.value)
         # test random selection of conditions
         all_conditions = utils.importConditions(standard_files[0])
         assert len(all_conditions) == 6

psychopy/tests/test_experiment/test_components/test_ButtonBoxComponent.py

@@ -13,11 +13,26 @@ from psychopy.experiment.components.buttonBox import ButtonBoxComponent
 from psychopy.experiment.components.code import CodeComponent
 from psychopy.tests.test_experiment.test_components.test_base_components import BaseComponentTests
 from psychopy.hardware.button import ButtonBox
+from psychopy.tests import utils
 
 
 class TestButtonBoxComponent(BaseComponentTests):
     comp = ButtonBoxComponent
     libraryClass = ButtonBox
+
+    def setup_class(cls):
+        """
+        Setup a keyboard response box for this test in prefs
+        """
+        from psychopy.preferences import prefs
+        from psychopy.experiment.components.buttonBox import KeyboardButtonBoxDeviceBackend
+        from psychopy.hardware import DeviceManager
+
+        for profile in DeviceManager.getAvailableDevices("psychopy.hardware.button.KeyboardButtonBox"):
+            device = KeyboardButtonBoxDeviceBackend(profile)
+            device.params['deviceLabel'].val = "testButtonBox"
+            prefs.devices['testButtonBox'] = device
+            break
     
     def test_values(self):
         """
@@ -60,6 +75,8 @@ class TestButtonBoxComponent(BaseComponentTests):
             cases.append(thisCase)
         # make minimal experiment just for this test
         comp, rt, exp = self.make_minimal_experiment()
+        # link to device
+        comp.params['deviceLabel'].val = "testButtonBox"
         # configure experiment
         exp.requireImport("ButtonResponse", importFrom="psychopy.hardware.button")
         exp.settings.params['Full-screen window'].val = False
@@ -114,10 +131,13 @@ class TestButtonBoxComponent(BaseComponentTests):
                 check=True,
             )
         except subprocess.CalledProcessError as err:
+            # save experiment file to fails folder
+            failScript = Path(utils.TESTS_FAILS_PATH) / tmpPy.name
+            failScript.write_text(script, encoding="utf-8")
             # if we get any errors, check their line number against error ranges
             matches = re.findall(
                 pattern=r"testButtonBox.py\", line (\d*),",
-                string=err.stderr
+                string=err.stderr.decode("utf-8")
             )
             # if no matches, raise error as is
             if not matches:
@@ -136,7 +156,7 @@ class TestButtonBoxComponent(BaseComponentTests):
                 f"Error in Routine with following params:\n"
                 f"{lastCase}\n"
                 f"Original traceback:\n"
-                f"{err.stdout}"
+                f"{err.stderr.decode('utf-8')}"
             )
             raise ValueError(msg)
 

psychopy/tests/test_hardware/test_ports.py

@@ -125,17 +125,5 @@ def test_findPhotometer():
     assert (hw.findPhotometer(device=[]) is None)
     # even when both are empty
     assert (hw.findPhotometer(device=[],ports=[]) is None)
-
     # non-existent photometers return None, for now
     assert (hw.findPhotometer(device="thisIsNotAPhotometer!") is None)
-
-    # if the photometer raises an exception don't crash, return None
-    assert (hw.findPhotometer(device=[_exceptionRaisingPhotometer],ports="foobar") is None)
-
-    # specifying a photometer should work
-    assert hw.findPhotometer(device=[_workingPhotometer],ports="foobar") == _MockPhotometer
-
-
-    # one broken, one working
-    device = [_exceptionRaisingPhotometer,_workingPhotometer]
-    assert hw.findPhotometer(device=device,ports="foobar") == _MockPhotometer

psychopy/tests/test_tools/test_stringtools.py

@@ -30,7 +30,7 @@ def test_get_variables():
         {"code": "x=\"(1, 2)\"\ny=\"(3, 4)\"", "ans": {'x': "(1, 2)", 'y': "(3, 4)"}},  # string representation of array (double)
     ]
     for case in exemplars + tykes:
-        assert tools.getVariables(case['code']) == case['ans']
+        assert tools.getVariableDefs(case['code']) == case['ans']
 
 
 @pytest.mark.stringtools

psychopy/tools/attributetools.py

@@ -58,12 +58,19 @@ class attributeSetter:
     """Makes functions appear as attributes. Takes care of autologging.
     """
 
-    def __init__(self, func, doc=None):
+    def __init__(self, func):
         self.func = func
-        if doc is not None:
-            self.__doc__ = doc
-        else:
-            self.__doc__ = func.__doc__
+        self.__doc__ = func.__doc__
+    
+    def __set_name__(self, owner: type, name: str):
+        # if we already have docs, no further action needed
+        if self.__doc__ is not None:
+            return
+        # inherit docs from first base class which has any for this method
+        for base in owner.__bases__:
+            if hasattr(base, name) and getattr(base, name).__doc__ is not None:
+                self.__doc__ = getattr(base, name).__doc__
+                break
 
     def __set__(self, obj, value):
         newValue = self.func(obj, value)

psychopy/tools/fontmanager.py

@@ -641,13 +641,17 @@ class TextureGlyph:
             return 0
 
 
-def findFontFiles(folders=(), recursive=True):
+def findFontFiles(folders=(), recursive=True, currentDir=Path(".")):
     """Search for font files in the folder (or system folders)
 
     Parameters
     ----------
     folders: iterable
         folders to search. If empty then search typical system folders
+    recursive : bool
+        If True, recursively search within subfolders
+    currentDir : pathlib.Path
+        Path to use as current directory when making paths absolute
 
     Returns
     -------
@@ -665,14 +669,13 @@ def findFontFiles(folders=(), recursive=True):
     # make sure font paths is a list
     if isinstance(searchPaths, tuple):
         searchPaths = list(searchPaths)
-    # always look in the local directory, unless it's inside PsychoPy itself
-    thisDir = Path(".").absolute()
-    if all((
-        thisDir not in Path(prefs.paths['psychopy']).parents,
-        thisDir != Path(prefs.paths['psychopy']),
-        Path(prefs.paths['psychopy']) not in thisDir.parents,
-    )):
-        searchPaths.append(thisDir)
+    # if local directory has a /fonts or /assets subdirectory, search those
+    for localSubdir in (
+        currentDir / "fonts",
+        currentDir / "assets" / "fonts"
+    ):
+        if localSubdir.is_dir():
+            searchPaths.append(localSubdir.absolute())
     # always look inside the app
     searchPaths.append(Path(prefs.paths['assets']) / "fonts")
     # always look in the user folder
@@ -797,14 +800,14 @@ class FontManager():
         return self.fontStyles
 
     def getFontsMatching(self, fontName, bold=False, italic=False,
-                         fontStyle=None, fallback=True):
+                         fontStyle=None, fallback=True, currentDir=Path(".")):
         """
         Returns the list of FontInfo instances that match the provided
         fontName and style information. If no matching fonts are
         found, None is returned.
         """
-        if not self._fontInfos:
-            self.updateFontInfo()
+        if not self._fontInfos or currentDir != Path("."):
+            self.updateFontInfo(currentDir=currentDir)
         if type(fontName) != bytes:
             fontName = bytes(fontName, sys.getfilesystemencoding())
         # Convert value of "bold" to a numeric font weight
@@ -971,10 +974,10 @@ class FontManager():
 
         return glFont
 
-    def updateFontInfo(self, monospaceOnly=False):
+    def updateFontInfo(self, monospaceOnly=False, currentDir=Path(".")):
         self._fontInfos.clear()
         del self.fontStyles[:]
-        fonts_found = findFontFiles()
+        fonts_found = findFontFiles(currentDir=currentDir)
         self.addFontFiles(fonts_found, monospaceOnly)
 
     def booleansFromStyleName(self, style):

psychopy/tools/gltools.py

@@ -121,7 +121,6 @@ __all__ = [
     'createTexImage2D',
     'createTexImage2dFromFile',
     'bindTexture',
-    'unbindTexture',
     'createCubeMap',
     'TexCubeMap',
     'getModelViewMatrix',
@@ -405,7 +404,10 @@ def getOpenGLInfo():
 
 
 # OpenGL limits for this system
-MAX_TEXTURE_UNITS = getOpenGLInfo().maxTextureUnits
+try:
+    MAX_TEXTURE_UNITS = getOpenGLInfo().maxTextureUnits
+except:
+    MAX_TEXTURE_UNITS = 32
 
 
 # -------------------------------

psychopy/tools/movietools.py

@@ -11,7 +11,9 @@ __all__ = [
     'MovieFileWriter',
     'closeAllMovieWriters',
     'addAudioToMovie',
+    'MOVIE_READER_FFPYPLAYER',
     'MOVIE_WRITER_FFPYPLAYER',
+    'MOVIE_READER_OPENCV',
     'MOVIE_WRITER_OPENCV',
     'MOVIE_WRITER_NULL',
     'VIDEO_RESOLUTIONS'
@@ -24,10 +26,11 @@ import queue
 import atexit
 import numpy as np
 import psychopy.logging as logging
+import sys
 
 # constants for specifying encoders for the movie writer
-MOVIE_WRITER_FFPYPLAYER = u'ffpyplayer'
-MOVIE_WRITER_OPENCV = u'opencv'
+MOVIE_WRITER_FFPYPLAYER = MOVIE_READER_FFPYPLAYER = u'ffpyplayer'
+MOVIE_WRITER_OPENCV = MOVIE_READER_OPENCV = u'opencv'
 MOVIE_WRITER_NULL = u'null'   # use prefs for default
 
 # Common video resolutions in pixels (width, height). Users should be able to
@@ -1066,5 +1069,43 @@ def addAudioToMovie(outputFile, videoFile, audioFile, useThreads=True,
     compositorThread.start()
 
 
+def extractAudioFromMovie(videoFile, audioFile, removeFiles=False):
+    """Extract the audio track from a video file.
+
+    This function will extract the audio track from a video file and save it to
+    a separate audio file. The audio file will be saved in the same format as
+    the audio track in the video file.
+
+    Parameters
+    ----------
+    videoFile : str
+        Path to the input video file.
+    audioFile : str
+        Path to the output audio file where the audio track will be saved.
+    removeFiles : bool
+        If `True`, the input video file (`videoFile`) will be removed (i.e.
+        deleted from disk) after the audio has been extracted. Defaults to
+        `False`.
+
+    Examples
+    --------
+    Extract the audio track from a video file::
+
+        from psychopy.tools.movietools import extractAudioFromMovie
+        extractAudioFromMovie('video.mp4', 'audio.mp3')
+
+    """
+    from moviepy.video.io.VideoFileClip import VideoFileClip
+
+    # extract the audio track from the video file
+    videoClip = VideoFileClip(videoFile)
+    audioClip = videoClip.audio
+    audioClip.write_audiofile(audioFile)
+
+    if removeFiles:
+        # remove the input video file
+        os.remove(videoFile)
+
+
 if __name__ == "__main__":
     pass

psychopy/tools/stringtools.py

@@ -393,26 +393,51 @@ def _actualizeAstValue(item):
         return tuple(_actualizeAstValue(i) for i in item.elts)
 
 
-def getVariables(code):
+def getVariableDefs(code):
     """
-    Use AST tree parsing to convert a string of valid Python code to a dict containing each variable created and its
-    value.
+    Returns a dict of variables defined in the given code, and their values.
+
+    Parameters
+    ----------
+    code : str
+        Code to parse for variable defs
     """
-    assert isinstance(code, str), "First input to `getArgs()` must be a string"
-    # Make blank output dict
+    assert isinstance(code, str), "First input to `getVariableDefs()` must be a string"
+    # make blank output dict
     vars = {}
-    # Construct tree
+    # construct tree
     tree = compile(code, '', 'exec', flags=ast.PyCF_ONLY_AST)
-    # Iterate through each line
+    # iterate through each node
     for line in tree.body:
         if hasattr(line, "targets") and hasattr(line, "value"):
-            # Append targets and values this line to arguments dict
+            # append targets and values this line to arguments dict
             for target in line.targets:
                 if hasattr(target, "id"):
                     vars[target.id] = _actualizeAstValue(line.value)
 
     return vars
 
+def getVariables(code):
+    """
+    Returns a list of variables referenced in the given code.
+
+    Parameters
+    ----------
+    code : str
+        Code to parse for variables
+    """
+    assert isinstance(code, str), "First input to `getVariables()` must be a string"
+    # make blank output list
+    vars = set()
+    # construct tree
+    tree = compile(code, '', 'exec', flags=ast.PyCF_ONLY_AST)
+    # iterate through each node
+    for node in ast.walk(tree):
+        if isinstance(node, ast.Name):
+            vars.add(node.id)
+    
+    return list(vars)
+
 
 def getArgs(code):
     """

psychopy/tools/versionchooser.py

@@ -204,7 +204,7 @@ def getPsychoJSVersionStr(currentVersion, preferredVersion=''):
         # e.g. 2021.1.0 not 2021.1.0.dev3
         useVerStr = '.'.join(useVerStr.split('.')[:3])
     # PsychoJS doesn't have additional rc1 or dev1 releases
-    for versionSuffix in ["rc", "dev", "post", "a", "b"]:
+    for versionSuffix in ["rc", "dev", "post", "a", "b", "beta"]:
         if versionSuffix in useVerStr:
             useVerStr = useVerStr.split(versionSuffix)[0]
 

psychopy/validation/audio.py

@@ -14,7 +14,11 @@ class AudioValidator:
         # set autolog
         self.autoLog = autoLog
         # store voicekey handle
-        self.sensor = sensor
+        from psychopy.hardware import DeviceManager, soundsensor
+        self.sensor = DeviceManager.resolveDevice(
+            sensor, 
+            deviceClass=soundsensor.BaseSoundSensorGroup
+        )
         self.channel = channel
         # initial values (written during experiment)
         self.tStart = self.tStartRefresh = self.tStartDelay = None

psychopy/validation/visual.py

@@ -15,7 +15,11 @@ class VisualValidator:
         # store window handle
         self.win = win
         # store sensor handle
-        self.sensor = sensor
+        from psychopy.hardware import DeviceManager, lightsensor
+        self.sensor = DeviceManager.resolveDevice(
+            sensor, 
+            deviceClass=lightsensor.BaseLightSensorGroup
+        )
         self.channel = channel
         # initial values (written during experiment)
         self.tStart = self.tStartRefresh = self.tStartDelay = None

psychopy/visual/basevisual.py

@@ -1065,16 +1065,17 @@ class TextureMixin:
                 try:
                     im = Image.open(filename)
                     im = im.transpose(Image.FLIP_TOP_BOTTOM)
-                except IOError:
-                    msg = "Found file '%s', failed to load as an image"
-                    logging.error(msg % (filename))
+                except IOError as err:
+                    msg = (
+                        "Found file '{}' ('{}'), but failed to load as an image. Reason: {}"
+                    ).format(filename, os.path.abspath(tex), err)
+                    logging.error(msg)
                     logging.flush()
-                    msg = "Found file '%s' [= %s], failed to load as an image"
-                    raise IOError(msg % (tex, os.path.abspath(tex)))
-            elif hasattr(tex, 'getVideoFrame'):  # camera or movie textures
+                    raise IOError(msg)
+            elif hasattr(tex, 'getRecentVideoFrame'):  # camera or movie textures
                 # get an image to configure the initial texture store
                 if hasattr(tex, 'frameSize'):
-                    if tex.frameSize is None:
+                    if tex.frameSize is None or tex.frameSize == (-1, -1):
                         raise RuntimeError(
                             "`Camera.frameSize` is not yet specified, cannot "
                             "initialize texture!")

psychopy/visual/circle.py

@@ -118,12 +118,12 @@ class Circle(Polygon):
                  depth=0,
                  interpolate=True,
                  draggable=False,
-                 lineRGB=False,
-                 fillRGB=False,
                  name=None,
                  autoLog=None,
                  autoDraw=False,
                  # legacy
+                 lineRGB=undefined,
+                 fillRGB=undefined,
                  color=undefined,
                  fillColorSpace=undefined,
                  lineColorSpace=undefined,

psychopy/visual/helpers.py

@@ -216,7 +216,9 @@ def setColor(obj, color, colorSpace=None, operation='',
     raw = color
     color = colors.Color(raw, colorSpace)
     assert color.valid, f"Could not create valid Color object from value {raw} in space {colorSpace}"
-
+    # set opacity from object if not given by color
+    if hasattr(obj, "opacity") and not hasattr(color, "_alpha"):
+        color.alpha = obj.opacity
     # Apply new value
     if operation in ('=', '', None):
         # If no operation, just set color from object