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

psychopy/experiment/components/_base.py

@@ -3,7 +3,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 copy
@@ -38,6 +38,10 @@ class BaseComponent:
     version = "0.0.0"
     # is it still in beta?
     beta = False
+    # what classes can validate this Component? Specify by name
+    validatorClasses = []
+    # hide this Component in Builder view?
+    hidden = False
 
     def __init__(self, exp, parentName, name='',
                  startType='time (s)', startVal='',
@@ -497,6 +501,14 @@ class BaseComponent:
         buff.writeIndentedLines(code % params)
         buff.setIndentLevel(+1, relative=True)
 
+        if self.checkNeedToUpdate('set every frame'):
+            # write param updates for first frame (if needed)
+            code = (
+                "// update params\n"
+            )
+            buff.writeIndentedLines(code % params)
+            self.writeParamUpdatesJS(buff, 'set every frame')
+
         code = (f"// keep track of start time/frame for later\n"
                 f"{params['name']}.tStart = t;  // (not accounting for frame time here)\n"
                 f"{params['name']}.frameNStart = frameN;  // exact frame index\n\n")
@@ -619,7 +631,7 @@ class BaseComponent:
         if validator:
             # queue validation
             code = (
-                "# tell attached validator (%(name)s) to start looking for a start flag\n"
+                "# tell attached validator (%(name)s) to start looking for a stop flag\n"
                 "%(name)s.status = STARTED\n"
             )
             buff.writeIndentedLines(code % validator.params)
@@ -712,6 +724,19 @@ class BaseComponent:
         # write if statement and indent
         buff.writeIndentedLines(code % params)
         buff.setIndentLevel(+1, relative=True)
+        # store stop
+        code = (
+            "// keep track of stop time/frame for later\n"
+            "%(name)s.tStop = t;  // not accounting for scr refresh\n"
+            "%(name)s.frameNStop = frameN;  // exact frame index\n"
+        )
+        buff.writeIndentedLines(code % params)
+        # set status
+        code = (
+            "// update status\n"
+            "%(name)s.status = PsychoJS.Status.FINISHED;\n"
+        )
+        buff.writeIndentedLines(code % params)
 
         # Return True if stop test was written
         return buff.indentLevel - startIndent
@@ -809,7 +834,7 @@ class BaseComponent:
         # construct if statement
         code = (
             "// if %(name)s is active this frame...\n"
-            "if (%(name)s.status == STARTED"
+            "if (%(name)s.status === PsychoJS.Status.STARTED"
         )
         # add any other conditions and finish the statement
         if extra and not extra.startswith(" "):
@@ -825,7 +850,7 @@ class BaseComponent:
                 "// update params\n"
             )
             buff.writeIndentedLines(code % params)
-            self.writeParamUpdates(buff, 'set every frame')
+            self.writeParamUpdatesJS(buff, 'set every frame')
 
         return buff.indentLevel - startIndent
 
@@ -1108,14 +1133,12 @@ class BaseComponent:
         list[str]
             List of Routine names/labels
         """
-        from psychopy.experiment.routines import BaseValidatorRoutine
-
         # iterate through all Routines in this Experiment
         names = [""]
         labels = [_translate("Do not validate")]
         for rtName, rt in self.exp.routines.items():
-            # if Routine is a validator, include it
-            if isinstance(rt, BaseValidatorRoutine):
+            # if Routine is the relevant validator type, include it
+            if type(rt).__name__ in self.validatorClasses:
                 # add name
                 names.append(rtName)
                 # construct label
@@ -1408,6 +1431,7 @@ class BaseVisualComponent(BaseComponent):
     targets = []
     iconFile = Path(__file__).parent / "unknown" / "unknown.png"
     tooltip = ""
+    validatorClasses = ["VisualValidatorRoutine"]
 
     def __init__(self, exp, parentName, name='',
                  units='from exp settings', color='white', fillColor="", borderColor="",
@@ -1600,16 +1624,6 @@ class BaseVisualComponent(BaseComponent):
             buff.writeIndented(f"// *{params['name']}* not supported by PsychoJS\n")
             return
 
-        # set parameters that need updating every frame
-        # do any params need updating? (this method inherited from _base)
-        if self.checkNeedToUpdate('set every frame'):
-            buff.writeIndentedLines(f"\nif ({params['name']}.status === PsychoJS.Status.STARTED){{ "
-                                    f"// only update if being drawn\n")
-            buff.setIndentLevel(+1, relative=True)  # to enter the if block
-            self.writeParamUpdatesJS(buff, 'set every frame')
-            buff.setIndentLevel(-1, relative=True)  # to exit the if block
-            buff.writeIndented("}\n")
-
         buff.writeIndentedLines(f"\n// *{params['name']}* updates\n")
         # writes an if statement to determine whether to draw etc
         indented = self.writeStartTestCodeJS(buff)
@@ -1623,7 +1637,18 @@ class BaseVisualComponent(BaseComponent):
                     "\n"
                 )
                 indented -= 1
-        # writes an if statement to determine whether to draw etc
+        # writes an if statement to determine whether we've started
+        indented = self.writeActiveTestCodeJS(buff)
+        if indented:
+            # to get out of the if statement
+            while indented > 0:
+                buff.setIndentLevel(-1, relative=True)
+                buff.writeIndentedLines(
+                    "}\n"
+                    "\n"
+                )
+                indented -= 1
+        # writes an if statement to determine whether to stop
         indented = self.writeStopTestCodeJS(buff)
         if indented:
             buff.writeIndentedLines(f"{params['name']}.setAutoDraw(false);\n")

psychopy/experiment/components/aperture/__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).
 
 from pathlib import Path

psychopy/experiment/components/brush/__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).
 
 from pathlib import Path
@@ -63,7 +63,7 @@ class BrushComponent(BaseVisualComponent):
         msg = _translate("The line opacity")
         self.params['opacity'].hint=msg
 
-        msg = _translate("Whether a button needs to be pressed to draw (True/False)")
+        msg = _translate("Should the participant have to press a button to paint (True), or should it be always on (False)?")
         self.params['buttonRequired'] = Param(
             buttonRequired, valType='bool', inputType="bool", allowedTypes=[], categ='Basic',
             updates='constant',

psychopy/experiment/components/button/__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).
 
 from os import path
@@ -97,7 +97,7 @@ class ButtonComponent(BaseVisualComponent):
             hint=_translate("The text to be displayed"),
             label=_translate("Button text"))
         self.params['font'] = Param(
-            font, valType='str', inputType="single", allowedTypes=[], categ='Formatting',
+            font, valType='str', inputType="font", allowedTypes=[], categ='Formatting',
             updates='constant', allowedUpdates=_allow3[:],  # copy the list
             hint=_translate("The font name (e.g. Comic Sans)"),
             label=_translate("Font"))
@@ -204,26 +204,26 @@ class ButtonComponent(BaseVisualComponent):
 
         code = (
             "%(name)s = new visual.ButtonStim({\n"
-        )
-        buff.writeIndentedLines(code % inits)
-        buff.setIndentLevel(1, relative=True)
-        code = (
-                "win: psychoJS.window,\n"
-                "name: '%(name)s',\n"
-                "text: %(text)s,\n"
-                "fillColor: %(fillColor)s,\n"
-                "borderColor: %(borderColor)s,\n"
-                "color: %(color)s,\n"
-                "colorSpace: %(colorSpace)s,\n"
-                "pos: %(pos)s,\n"
-                "letterHeight: %(letterHeight)s,\n"
-                "size: %(size)s,\n"
-                "ori: %(ori)s\n,\n"
-                "depth: %(depth)s\n"
-        )
-        buff.writeIndentedLines(code % inits)
-        buff.setIndentLevel(-1, relative=True)
-        code = (
+            "  win: psychoJS.window,\n"
+            "  name: '%(name)s',\n"
+            "  text: %(text)s,\n"
+            "  font: %(font)s,\n"
+            "  pos: %(pos)s,\n"
+            "  size: %(size)s,\n"
+            "  padding: %(padding)s,\n"
+            "  anchor: %(anchor)s,\n"
+            "  ori: %(ori)s,\n"
+            "  units: %(units)s,\n"
+            "  color: %(color)s,\n"
+            "  fillColor: %(fillColor)s,\n"
+            "  borderColor: %(borderColor)s,\n"
+            "  colorSpace: %(colorSpace)s,\n"
+            "  borderWidth: %(borderWidth)s,\n"
+            "  opacity: %(opacity)s,\n"
+            "  depth: %(depth)s,\n"
+            "  letterHeight: %(letterHeight)s,\n"
+            "  bold: %(bold)s,\n"
+            "  italic: %(italic)s,\n"
             "});\n"
             "%(name)s.clock = new util.Clock();\n\n"
         )
@@ -350,7 +350,7 @@ class ButtonComponent(BaseVisualComponent):
         # Get callback from params
         callback = inits['callback']
         if inits['callback'].val not in [None, "None", "none", "undefined"]:
-            callback = translatePythonToJavaScript(str(callback))
+            callback = translatePythonToJavaScript(str(callback), namespace=None)
         else:
             callback = ""
 
@@ -490,8 +490,4 @@ class ButtonComponent(BaseVisualComponent):
             "psychoJS.experiment.addData('%(name)s.timesOn', %(name)s.timesOn);\n"
             "psychoJS.experiment.addData('%(name)s.timesOff', %(name)s.timesOff);\n"
         )
-        buff.writeIndentedLines(code % self.params)
-
-    def integrityCheck(self):
-        super().integrityCheck()  # run parent class checks first
-        alerttools.testFont(self) # Test whether font is available locally
+        buff.writeIndentedLines(code % self.params)

psychopy/experiment/components/camera/__init__.py

@@ -8,24 +8,9 @@ from psychopy import logging
 from psychopy.experiment.components import (
     BaseComponent, BaseDeviceComponent, Param, _translate, getInitVals
 )
-from psychopy.sound.audiodevice import sampleRateQualityLevels
 from psychopy.tools import stringtools as st, systemtools as syst, audiotools as at
 
 
-_hasPTB = True
-try:
-    import psychtoolbox.audio as audio
-except (ImportError, ModuleNotFoundError):
-    logging.warning(
-        "The 'psychtoolbox' library cannot be loaded but is required for audio "
-        "capture (use `pip install psychtoolbox` to get it). Microphone "
-        "recording will be unavailable this session. Note that opening a "
-        "microphone stream will raise an error.")
-    _hasPTB = False
-# Get list of sample rates
-micSampleRates = {r[1]: r[0] for r in sampleRateQualityLevels.values()}
-
-
 class CameraComponent(BaseDeviceComponent):
     """
     This component provides a way to use the webcam to record participants during an experiment.
@@ -45,7 +30,7 @@ class CameraComponent(BaseDeviceComponent):
     version = "2022.2.0"
     iconFile = Path(__file__).parent / 'webcam.png'
     tooltip = _translate('Webcam: Record video from a webcam.')
-    beta = True
+    beta = False
     deviceClasses = ["psychopy.hardware.camera.Camera"]
 
     def __init__(
@@ -370,11 +355,16 @@ class CameraComponent(BaseDeviceComponent):
             hint=msg,
             label=_translate("Channels"))
 
+        def getSampleRates():
+            return [r[0] for r in at.sampleRateQualityLevels.values()]
+        def getSampleRateLabels():
+            return [r[1] for r in at.sampleRateQualityLevels.values()]
         msg = _translate(
             "How many samples per second (Hz) to record at")
         self.params['micSampleRate'] = Param(
             sampleRate, valType='num', inputType="choice", categ='Audio',
-            allowedVals=list(micSampleRates),
+            allowedVals=getSampleRates,
+            allowedLabels=getSampleRateLabels,
             hint=msg, direct=False,
             label=_translate("Sample rate (hz)"))
 
@@ -417,8 +407,9 @@ class CameraComponent(BaseDeviceComponent):
         inits = getInitVals(self.params)
         self.setupMicNameInInits(inits)
         # --- setup mic ---
-        # substitute sample rate value for numeric equivalent
-        inits['micSampleRate'] = micSampleRates[inits['micSampleRate'].val]
+        # make sure mic sample rate is numeric
+        if inits['micSampleRate'].val in at.sampleRateLabels:
+            inits['micSampleRate'].val = at.sampleRateLabels[inits['micSampleRate'].val]
         # substitute channel value for numeric equivalent
         inits['micChannels'] = {'mono': 1, 'stereo': 2, 'auto': None}[self.params['micChannels'].val]
         # initialise mic device
@@ -476,6 +467,12 @@ class CameraComponent(BaseDeviceComponent):
             "%(name)s = deviceManager.getDevice(%(deviceLabel)s)\n"
         )
         buff.writeIndentedLines(code % inits)
+        if self.params['saveFile']:
+            code = (
+                "# connect camera save method to experiment handler so it's called when data saves\n"
+                "thisExp.connectSaveMethod(%(name)s.save, os.path.join(%(name)sRecFolder, '_recovered.mp4'), encoderLib='ffpyplayer')\n"
+            )
+            buff.writeIndentedLines(code % inits)
 
     def writeInitCodeJS(self, buff):
         inits = getInitVals(self.params, target="PsychoJS")
@@ -521,28 +518,30 @@ class CameraComponent(BaseDeviceComponent):
 
     def writeFrameCodeJS(self, buff):
         # Start webcam at component start
-        self.writeStartTestCodeJS(buff)
-        code = (
-            "await %(name)s.record()\n"
-        )
-        buff.writeIndentedLines(code % self.params)
-        buff.setIndentLevel(-1, relative=True)
-        code = (
-            "};\n"
-        )
-        buff.writeIndentedLines(code)
+        indent = self.writeStartTestCodeJS(buff)
+        if indent:
+            code = (
+                "await %(name)s.record()\n"
+            )
+            buff.writeIndentedLines(code % self.params)
+            buff.setIndentLevel(-indent, relative=True)
+            code = (
+                "};\n"
+            )
+            buff.writeIndentedLines(code)
 
         # Stop webcam at component stop
-        self.writeStopTestCodeJS(buff)
-        code = (
-            "await %(name)s.stop()\n"
-        )
-        buff.writeIndentedLines(code % self.params)
-        buff.setIndentLevel(-1, relative=True)
-        code = (
-            "};\n"
-        )
-        buff.writeIndentedLines(code)
+        indent = self.writeStopTestCodeJS(buff)
+        if indent:
+            code = (
+                "await %(name)s.stop()\n"
+            )
+            buff.writeIndentedLines(code % self.params)
+            buff.setIndentLevel(-indent, relative=True)
+            code = (
+                "};\n"
+            )
+            buff.writeIndentedLines(code)
 
     def writeRoutineEndCode(self, buff):
         code = (

psychopy/experiment/components/code/__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).
 
 from pathlib import Path

psychopy/experiment/components/dots/__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).
 
 from os import path

psychopy/experiment/components/eyetracker_record/__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).
 
 from __future__ import absolute_import, print_function
@@ -21,7 +21,7 @@ class EyetrackerRecordComponent(BaseComponent):
     version = "2021.2.0"
     iconFile = Path(__file__).parent / 'eyetracker_record.png'
     tooltip = _translate('Start and / or Stop recording data from the eye tracker')
-    beta = True
+    beta = False
 
     def __init__(self, exp, parentName, name='etRecord',
                  startType='time (s)', startVal=0.0,
@@ -38,6 +38,10 @@ class EyetrackerRecordComponent(BaseComponent):
         self.type = 'EyetrackerRecord'
         self.url = "https://www.psychopy.org/builder/components/eyetracker.html"
         self.exp.requirePsychopyLibs(['iohub', 'hardware'])
+        self.exp.requireImport(
+            importName="EyetrackerControl",
+            importFrom="psychopy.hardware.eyetracker"
+        )
 
         self.params['actionType'] = Param(
             actionType,
@@ -113,7 +117,7 @@ class EyetrackerRecordComponent(BaseComponent):
         inits = self.params
         # Make a controller object
         code = (
-            "%(name)s = hardware.eyetracker.EyetrackerControl(\n"
+            "%(name)s = EyetrackerControl(\n"
         )
         buff.writeIndentedLines(code % inits)
         buff.setIndentLevel(1, relative=True)

psychopy/experiment/components/form/__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).
 
 from pathlib import Path
@@ -23,13 +23,13 @@ class FormComponent(BaseVisualComponent):
     version = "2020.2.0"
     iconFile = Path(__file__).parent / 'form.png'
     tooltip = _translate('Form: a Psychopy survey tool')
-    beta = True
+    beta = False
 
     def __init__(self, exp, parentName,
                  name='form',
                  items='',
                  textHeight=0.03,
-                 font="Open Sans",
+                 font="Noto Sans",
                  randomize=False,
                  fillColor='',
                  borderColor='',

psychopy/experiment/components/grating/__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).
 
 from pathlib import Path

psychopy/experiment/components/image/__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).
 
 from pathlib import Path

psychopy/experiment/components/joyButtons/__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).
 
 from pathlib import Path
@@ -110,7 +110,7 @@ class JoyButtonsComponent(BaseComponent):
             "Device number, if you have multiple devices which"
             " one do you want (0, 1, 2...)")
         self.params['deviceNumber'] = Param(
-            deviceNumber, valType='int', inputType="int", allowedTypes=[], categ='Hardware',
+            deviceNumber, valType='int', inputType="int", allowedTypes=[], categ="Device",
             updates='constant', allowedUpdates=[],
             hint=msg,
             label=_translate("Device number"))

psychopy/experiment/components/joyButtons/virtualJoyButtons.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).
 
 # Support for fake joystick/gamepad during development

psychopy/experiment/components/joystick/__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).
 
 from pathlib import Path
@@ -66,7 +66,7 @@ class JoystickComponent(BaseComponent):
             hint=msg, direct=False,
             label=_translate("End Routine on press"))
 
-        msg = _translate("What should the values of joystick.time should be "
+        msg = _translate("What should the values of joystick.time be "
                          "relative to?")
         self.params['timeRelativeTo'] = Param(
             timeRelativeTo, valType='str', inputType="choice", categ='Data',
@@ -100,7 +100,7 @@ class JoystickComponent(BaseComponent):
                          ' one do you want (0, 1, 2...)')
 
         self.params['deviceNumber'] = Param(
-            deviceNumber, valType='int', inputType="single", allowedTypes=[], categ='Hardware',
+            deviceNumber, valType='int', inputType="single", allowedTypes=[], categ="Device",
             updates='constant', allowedUpdates=[],
             hint=msg,
             label=_translate("Device number"))

psychopy/experiment/components/joystick/virtualJoystick.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).
 
 # Support for fake joystick/gamepad during development