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

psychopy/iohub/devices/deviceConfigValidation.py

@@ -7,6 +7,7 @@ import socket
 import os
 import numbers  # numbers.Integral is like (int, long) but supports Py3
 from psychopy import colors
+from psychopy.iohub.devices import importDeviceModule
 from psychopy.tools import arraytools
 from ..util import yload, yLoader, module_directory, getSupportedConfigSettings
 from ..errors import print2err
@@ -488,7 +489,7 @@ def validateDeviceConfiguration(
         current_device_config):
     """Validate the device configuration settings provided.
     """
-    validation_module = importlib.import_module(relative_module_path)
+    validation_module = importDeviceModule(relative_module_path)
     validation_file_path = getSupportedConfigSettings(validation_module)
 
     # use a default config if we can't get the YAML file

psychopy/iohub/devices/experiment/default_experiment.yaml

@@ -6,13 +6,24 @@
 # indicated here.
 #
 Experiment:
-    # name: The unique name to assign to the evice instance created.
+    # name: The unique name to assign to the device instance created.
     #   The device is accessed from within the PsychoPy script 
     #   using the name's value; therefore it must be a valid Python
     #   variable name as well.
     #
     name: experiment
 
+    # filename: The name of files saved by an attached PsychoPy experiment.
+    #   This is usually provided as PsychoPy ExperimentHandler.dataFileName.
+    #   It gives ioHub server awareness of filenames used by PsychoPy when a
+    #   DataStore file is not being saved by the ioHub. This handle is useful
+    #   when the ioHub is being used to monitor the PsychoPy experiment, but
+    #   all data is being saved by the PsychoPy ExperimentHandler, while there
+    #   are external data files transferred through the ioHub server that need
+    #   to be saved in the same naming convention as the PsychoPy data files.
+    #   Default value is Python None type. Valid value is any string.
+    filename:
+
     # monitor_event_types: Specify which of the device's supported event
     #   types you would like the ioHub to monitor for.
     #

psychopy/iohub/devices/experiment/supported_config_settings.yaml

@@ -4,7 +4,11 @@ Experiment:
         IOHUB_STRING:
             min_length: 1
             max_length: 32
-            first_char_alpha: True    
+            first_char_alpha: True
+    filename: 
+        IOHUB_STRING:
+            min_length: 0
+            first_char_alpha: False
     save_events: IOHUB_BOOL
     stream_events: True
     auto_report_events: True    

psychopy/iohub/devices/eyetracker/__init__.py

@@ -250,6 +250,52 @@ class EyeTrackerDevice(Device):
             None
         """
         return EyeTrackerConstants.EYETRACKER_INTERFACE_METHOD_NOT_SUPPORTED
+    
+    @staticmethod
+    def getCalibrationDict(calib):
+        """
+        Create a dict describing the given Calibration object, respecting this 
+        eyetracker's specific limitations. If not overloaded by a subclass, this 
+        will use the same fields and values as MouseGaze.
+
+        Parameters
+        ----------
+        calib : psychopy.hardware.eyetracker.EyetrackerCalibration
+            Object to create a dict from
+        
+        Returns
+        -------
+        dict
+            Dict describing the given Calibration object
+        """
+        return {
+            'target_attributes': {
+                # target outer circle
+                'outer_diameter': calib.target.radius * 2,
+                'outer_stroke_width': calib.target.outer.lineWidth,
+                'outer_fill_color': getattr(calib.target.outer._fillColor, calib.colorSpace) if calib.target.outer._fillColor else getattr(calib.target.win._color, calib.colorSpace),
+                'outer_line_color': getattr(calib.target.outer._borderColor, calib.colorSpace) if calib.target.outer._borderColor else getattr(calib.target.win._color, calib.colorSpace),
+                # target inner circle
+                'inner_diameter': calib.target.innerRadius * 2,
+                'inner_stroke_width': calib.target.inner.lineWidth,
+                'inner_fill_color': getattr(calib.target.inner._borderColor, calib.colorSpace) if calib.target.inner._borderColor else getattr(calib.target.win._color, calib.colorSpace),
+                'inner_line_color': getattr(calib.target.inner._borderColor, calib.colorSpace) if calib.target.inner._borderColor else getattr(calib.target.win._color, calib.colorSpace),
+                # target animation
+                'animate':{
+                    'enable': calib.movementAnimation,
+                    'expansion_ratio': calib.expandScale,
+                    'contract_only': calib.expandScale == 1,
+                },
+            },
+            'type': calib.targetLayout,
+            'randomize': calib.randomisePos,
+            'auto_pace': calib.progressMode == "time",
+            'pacing_speed': calib.targetDelay,
+            'unit_type': calib.units,
+            'color_type': calib.colorSpace,
+            'text_color': calib.textColor if str(calib.textColor).lower() != "auto" else None,
+            'screen_background_color': getattr(calib.win._color, calib.colorSpace),
+        }
 
     def setRecordingState(self, recording):
         """The setRecordingState method is used to start or stop the recording

psychopy/iohub/devices/eyetracker/calibration/procedure.py

@@ -157,10 +157,10 @@ class BaseCalibrationProcedure:
         def setDefaultCalibrationTarget():
             # convert sizes to stimulus units
             radiusPix = self.getCalibSetting(['target_attributes', 'outer_diameter']) / 2
-            radiusObj = layout.Size(radiusPix, units="pix", win=self.window)
+            radiusObj = layout.Size(radiusPix, units=unit_type, win=self.window)
             radius = getattr(radiusObj, unit_type)[1]
             innerRadiusPix = self.getCalibSetting(['target_attributes', 'inner_diameter']) / 2
-            innerRadiusObj = layout.Size(innerRadiusPix, units="pix", win=self.window)
+            innerRadiusObj = layout.Size(innerRadiusPix, units=unit_type, win=self.window)
             innerRadius = getattr(innerRadiusObj, unit_type)[1]
             # make target
             self.targetStim = visual.TargetStim(

psychopy/iohub/devices/eyetracker/hw/gazepoint/__init__.py

@@ -6,7 +6,19 @@
 import psychopy.logging as logging
 
 try:
-    from psychopy_eyetracker_gazepoint.gazepoint import gp3
+    from psychopy_eyetracker_gazepoint.gazepoint.gp3 import (
+        __file__,
+        EyeTracker, 
+        MonocularEyeSampleEvent,
+        BinocularEyeSampleEvent, 
+        FixationStartEvent,
+        FixationEndEvent, 
+        SaccadeStartEvent,
+        SaccadeEndEvent, 
+        BlinkStartEvent,
+        BlinkEndEvent,
+        GazepointSampleEvent
+    )
 except (ModuleNotFoundError, ImportError, NameError):
     logging.error(
         "The Gazepoint eyetracker requires package " 
@@ -14,4 +26,4 @@ except (ModuleNotFoundError, ImportError, NameError):
         "package and restart the session to enable support.")
 
 if __name__ == "__main__":
-    pass
+    pass

psychopy/iohub/devices/eyetracker/hw/mouse/eyetracker.py

@@ -408,11 +408,10 @@ class EyeTracker(EyeTrackerDevice):
         cal_run = calibration.runCalibration()
         calibration.window.close()
 
-        # NOTE - The following line has been commented out to prevent ioHub from 
-        # losing keyboard input after the window is closed. The new keyboard 
-        # input system does not require this call anymore.
-        # calibration._unregisterEventMonitors()
+        calibration._unregisterEventMonitors()
         calibration.clearAllEventBuffers()
+        del calibration.window
+        del calibration
 
         if cal_run:
             return {"RESULT": "CALIBRATION_OK"}

psychopy/iohub/server.py

@@ -28,7 +28,7 @@ from .net import MAX_PACKET_SIZE
 from .util import convertCamelToSnake, win32MessagePump
 from .util import yload, yLoader
 from .constants import DeviceConstants, EventConstants
-from .devices import DeviceEvent, import_device
+from .devices import DeviceEvent, import_device, importDeviceModule
 from .devices import Computer
 from .devices.deviceConfigValidation import validateDeviceConfiguration
 getTime = Computer.getTime
@@ -846,7 +846,7 @@ class ioServer():
         else:
             dev_mod_pth += dev_cls_name.lower()
         # convert subdirectory to path
-        dev_mod = importlib.import_module(dev_mod_pth)
+        dev_mod = importDeviceModule(dev_mod_pth)
         dev_file_pth = os.path.dirname(dev_mod.__file__)
         # get config from path
         dev_conf_pth = os.path.join(dev_file_pth,

psychopy/iohub/start_iohub_process.py

@@ -79,6 +79,9 @@ def run(rootScriptPathDir, configFilePath):
         else:
             gevent.joinall(glets)
 
+        # Wait for the server to be ready to shutdown
+        gevent.wait()
+
         lrtime = Computer.global_clock.getLastResetTime()
         s.log('Server END Time Offset: {0}'.format(lrtime), 'DEBUG')
         return True

psychopy/iohub/util/__init__.py

@@ -16,6 +16,10 @@ import collections.abc
 import pathlib
 import psychopy.logging as logging
 import psychopy.plugins as plugins
+from psychopy.plugins.util import getEntryPoints
+from importlib.metadata import entry_points
+from pathlib import Path
+from psychopy.preferences import prefs
 
 ########################
 #
@@ -33,8 +37,6 @@ try:
 except ImportError:
     from collections import Iterable
 
-from psychopy.preferences import prefs
-
 
 def saveConfig(config, dst_path):
     '''
@@ -141,7 +143,7 @@ def module_directory(local_function):
 def getSupportedConfigSettings(moduleName, deviceClassName=None):
     """Get the supported configuration settings for a device.
 
-    These are usually stored as YAML files within the module directory that 
+    These are usually stored as YAML files within the module directory that
     defines the device class.
 
     Parameters
@@ -150,10 +152,10 @@ def getSupportedConfigSettings(moduleName, deviceClassName=None):
         The name of the module to get the path for. Must be a package that defines
         `__init__.py`.
     deviceClassName : str, optional
-        The name of the specific device class to get the path for. If not provided, 
-        the default configuration file will be searched for in the module 
+        The name of the specific device class to get the path for. If not provided,
+        the default configuration file will be searched for in the module
         directory.
-    
+
     Returns
     -------
     str
@@ -174,13 +176,13 @@ def getSupportedConfigSettings(moduleName, deviceClassName=None):
             "Found ioHub device configuration file: {0}".format(yamlFile))
 
         return str(yamlFile)
-        
+
     # file name for yaml file name convention for single file
     yamlFile = yamlRoot / pathlib.Path('supported_config_settings.yaml')
     if not yamlFile.exists():  # nothing is found
         raise FileNotFoundError(
             "No config file found in module dir {0}".format(moduleName))
-    
+
     logging.debug(
         "Found ioHub device configuration file: {0}".format(yamlFile))
 
@@ -231,9 +233,17 @@ def getDevicePaths(device_name=""):
 
         """
         yaml_paths = []
-        # try to walk both the internal iohub_device_path and user-level packages folder
-        for route in (os.walk(iohub_device_path), os.walk(prefs.paths['packages'])):
-            for root, _, files in route:
+
+        if '.zip' in iohub_device_path:
+            # if the entry point is in a zip file, it is likely loading from a precompiled
+            # library instead of a user installed plugin module. Raise warning.
+            logging.error(
+                f"Bad entry point loaded: {ep}\n"
+                f"It is pointing into a zip file: {iohub_device_path}"
+            )
+        else:
+            # search the provided iohub_device_path for device config files
+            for root, _, files in os.walk(iohub_device_path):
                 # check each file in the route to see if it's a config yaml
                 device_folder = None
                 for file in files:
@@ -253,65 +263,40 @@ def getDevicePaths(device_name=""):
     scs_yaml_paths = []  # stores the paths to the device config files
     plugins.refreshBundlePaths()  # make sure eyetracker external plugins are reachable
 
-    # get device paths for extant extensions
-    try:  # tobii eyetrackers
-        logging.debug("Looking for Tobii device configuration file...")
-        import psychopy_eyetracker_tobii.tobii as tobii
-        deviceConfig = _getDevicePaths(os.path.dirname(tobii.__file__))
-        if deviceConfig:
-            logging.debug("Found Tobii device configuration file.")
-            scs_yaml_paths.extend(deviceConfig)
-    except ImportError:
-        logging.debug("No Tobii device configuration file found.")
-
-    try:  # for SR Research EyeLink
-        logging.debug("Looking for SR Research EyeLink device configuration file...")
-        import psychopy_eyetracker_sr_research.sr_research.eyelink as eyelink
-        deviceConfig = _getDevicePaths(os.path.dirname(eyelink.__file__))
-        if deviceConfig:
-            logging.debug("Found SR Research EyeLink device configuration file.")
-            scs_yaml_paths.extend(deviceConfig)
-    except ImportError:
-        logging.debug("No SR Research EyeLink device configuration file found.")
-
-    try:  # for Gazepoint eye trackers
-        logging.debug("Looking for Gazepoint device configuration file...")
-        import psychopy_eyetracker_gazepoint.gazepoint.gp3 as gp3
-        deviceConfig = _getDevicePaths(os.path.dirname(gp3.__file__))
-        if deviceConfig:
-            logging.debug("Found Gazepoint device configuration file.")
-            scs_yaml_paths.extend(deviceConfig)
-    except ImportError:
-        logging.debug("No Gazepoint device configuration file found.")
-
-    try:  # for PupilLabs eye trackers
-        logging.debug("Looking for PupilLabs device configuration file...")
-        import psychopy_eyetracker_pupil_labs.pupil_labs.pupil_core as pupil_core
-        deviceConfig = _getDevicePaths(os.path.dirname(pupil_core.__file__))
-        if deviceConfig:
-            logging.debug("Found PupilLabs device configuration file.")
-            scs_yaml_paths.extend(deviceConfig)
-
-        import psychopy_eyetracker_pupil_labs.pupil_labs.neon as neon
-        deviceConfig = _getDevicePaths(os.path.dirname(neon.__file__))
-        if deviceConfig:
-            logging.debug("Found PupilLabs Neon device configuration file.")
-            scs_yaml_paths.extend(deviceConfig)
-
-    except ImportError:
-        logging.debug("No PupilLabs device configuration file found.")
-
-    # use this method for built-in devices
+    # NOTE: The “selectable” entry points were introduced in importlib_metadata 3.6 and Python 3.10.
+    # Prior to those changes, entry_points accepted no parameters and always returned a dictionary
+    # of entry points, keyed by group. With importlib_metadata 5.0 and Python 3.12, entry_points
+    # always returns an EntryPoints object.
+
+    if 'eyetracker' in device_name.lower():
+        # Find entry points targeting psychopy.iohub.devices.eyetracker
+        for ep in getEntryPoints('psychopy.iohub.devices.eyetracker', submodules=False, flatten=True):
+            # load the target the entry point points to, it could be a class or a module
+            try:
+                ep_target = ep.load()
+            except:  # noqa: E722
+                logging.error(f"Failed to load entry point: {ep}")
+                continue
+
+            if hasattr(ep_target, "configFile"):
+                # if entry point target binds to a yaml file, use it
+                scs_yaml_paths.append(
+                    (ep_target.configFile.parent, ep_target.configFile.name)
+                )
+            else:  # otherwise, check the local folder of the target module or class
+                deviceConfig = _getDevicePaths(os.path.dirname(inspect.getfile(ep_target)))
+                scs_yaml_paths.extend(deviceConfig)
+
+    # Use import_device() method for built-in devices
     iohub_device_path = module_directory(import_device)
     if device_name:
         iohub_device_path = os.path.join(
             iohub_device_path, device_name.replace('.', os.path.sep))
-
     deviceConfigs = _getDevicePaths(iohub_device_path)
-    if deviceConfigs:
-        scs_yaml_paths.extend(deviceConfigs)
+    scs_yaml_paths.extend(deviceConfigs)
 
-    return scs_yaml_paths
+    # Return a unique list of device config paths
+    return list(set(scs_yaml_paths))
 
 
 def getDeviceDefaultConfig(device_name, builder_hides=True):
@@ -381,10 +366,10 @@ def getDeviceNames(device_name="eyetracker.hw", get_paths=True):
         print(eyetrackers)
 
     Output:
-        [('GazePoint', 'eyetracker.hw.gazepoint.gp3.EyeTracker'),
+        [('GazePoint', 'eyetracker.gazepoint.EyeTracker'),
          ('MouseGaze', 'eyetracker.hw.mouse.EyeTracker'),
-         ('SR Research Ltd', 'eyetracker.hw.sr_research.eyelink.EyeTracker'),
-         ('Tobii Technology', 'eyetracker.hw.tobii.EyeTracker')]
+         ('SR Research Ltd', 'eyetracker.eyelink.EyeTracker'),
+         ('Tobii Technology', 'eyetracker.tobii.EyeTracker')]
     """
     names = []
     dconfigs = getDeviceDefaultConfig(device_name)
@@ -397,6 +382,7 @@ def getDeviceNames(device_name="eyetracker.hw", get_paths=True):
             names.append((d_config.get('manufacturer_name'), d_path))
     return names
 
+
 def getDeviceFile(device_name, file_name):
     """
     Returns the contents of file_name for the specified device. If file_name does not exist, None is returned.
@@ -408,6 +394,7 @@ def getDeviceFile(device_name, file_name):
     if device_name.endswith(".EyeTracker"):
         device_name = device_name[:-11]
     device_paths = getDevicePaths(device_name)
+
     device_sconfigs = []
     for dpath, _ in device_paths:
         device_sconfigs.append(readConfig(os.path.join(dpath, file_name)))
@@ -416,6 +403,7 @@ def getDeviceFile(device_name, file_name):
         return list(device_sconfigs[0].values())[0]
     return device_sconfigs
 
+
 def getDeviceSupportedConfig(device_name):
     """
     Returns the contents of the supported_config_settings.yaml for the specified device.
@@ -425,6 +413,7 @@ def getDeviceSupportedConfig(device_name):
     """
     return getDeviceFile(device_name, 'supported_config_settings.yaml')
 
+
 if sys.platform == 'win32':
     import pythoncom
 
@@ -446,6 +435,7 @@ else:
     def win32MessagePump():
         pass
 
+
 # PsychoPy Window Hide / Show functions.
 # Windows 10 and macOS have different code that needs to be called
 # to show a second full screen window on top of an existing one, like
@@ -468,6 +458,7 @@ def hideWindow(win, force=False):
     else:
         print("Warning: Unhandled sys.platform: ", sys.platform)
 
+
 def showWindow(win, force=False):
     """
     If needed, hide / minimize the in.
@@ -486,6 +477,7 @@ def showWindow(win, force=False):
     else:
         print("Warning: Unhandled sys.platform: ", sys.platform)
 
+
 def createCustomCalibrationStim(win, cal_settings):
     """
     Create a custom calibration target using the CUSTOM eyetracker calibration settings. Returns an instance of
@@ -549,12 +541,12 @@ def updateDict(add_to, add_from):
 
 def updateSettings(d, u):
     for k, v in u.items():
-        if type(k) == bytes:
+        if isinstance(k, bytes):
             k = k.decode('UTF-8')
         if isinstance(v, collections.abc.Mapping):
             d[k] = updateSettings(d.get(k, {}), v)
         else:
-            if type(v) == bytes:
+            if isinstance(v, bytes):
                 v = v.decode('UTF-8')
             d[k] = v
     return d
@@ -575,7 +567,7 @@ def convertCamelToSnake(name, lower_snake=True):
 # A couple date / time related utility functions
 
 getCurrentDateTime = datetime.datetime.now
-getCurrentDateTimeString = lambda: getCurrentDateTime().strftime("%Y-%m-%d %H:%M")
+getCurrentDateTimeString = lambda: getCurrentDateTime().strftime("%Y-%m-%d %H:%M")  # noqa: E731
 
 
 # rgb255 color utils

psychopy/layout.py

@@ -171,16 +171,16 @@ class Vector:
             self.valid = False
 
         # Replace None with the matching window dimension
-        if (value == None).any() or np.isnan(value).any():
+        if (value == None).any() or np.isnan(value).any():  # noqa: E711
             win = Vector((1, 1), units="norm", win=self.win)
             if len(value.shape) == 1:
-                value[value == None] = getattr(win, units)[value == None]
+                value[value == None] = getattr(win, units)[value == None]  # noqa: E711
                 value[np.isnan(value)] = getattr(win, units)[np.isnan(value)]
             else:
                 value[np.isnan(value[:, 0]), 0] = getattr(win, units)[0]
                 value[np.isnan(value[:, 1]), 1] = getattr(win, units)[1]
-                value[value[:, 0] == None, 0] = getattr(win, units)[0]
-                value[value[:, 1] == None, 1] = getattr(win, units)[1]
+                value[value[:, 0] == None, 0] = getattr(win, units)[0]  # noqa: E711
+                value[value[:, 1] == None, 1] = getattr(win, units)[1]  # noqa: E711
 
         assert self.valid, (f"Array of position/size values must be either "
                             f"Nx1, Nx2 or Nx3, not {value.shape}")
@@ -913,4 +913,4 @@ class Vertices:
 
 
 if __name__ == "__main__":
-    pass
+    pass

psychopy/logging.py

@@ -76,6 +76,9 @@ _levelNames = {
     'DEBUG': DEBUG,
     'NOTSET': NOTSET}
 
+# string to search for level names in a log message
+_levelNamesRe = "|".join(key for key in _levelNames if isinstance(key, str))
+
 _prefEncoding = locale.getpreferredencoding()
 
 def getLevel(level):
@@ -188,6 +191,10 @@ class LogFile():
     def setLevel(self, level):
         """Set a new minimal level for the log file/stream
         """
+        # if given a name, get corresponding integer value
+        if isinstance(level, str):
+            level = getLevel(level)
+        # make sure we (now) have an integer
         if type(level) is not int:
             raise TypeError("LogFile.setLevel() should be given an int, which"
                             "is usually one of logging.INFO (not logging.info)")
@@ -305,7 +312,7 @@ class _Logger():
         self.toFlush = []  # a new empty list
 
 root = _Logger()
-console = LogFile()
+console = LogFile(level=WARNING)
 
 
 def flush(logger=root):

psychopy/microphone.py

@@ -12,43 +12,16 @@ These are optional components that can be obtained by installing the
 
 """
 
-import psychopy.logging as logging
-
-try:
-    from psychopy_legacy_mic import (
-        haveMic,
-        FLAC_PATH,
-        AudioCapture,
-        AdvAudioCapture,
-        getMarkerOnset,
-        readWavFile,
-        getDftBins,
-        getDft,
-        getRMSBins,
-        getRMS,
-        SoundFormatNotSupported,
-        SoundFileError,
-        MicrophoneError,
-        Speech2Text,
-        BatchSpeech2Text,
-        flac2wav,
-        wav2flac,
-        switchOn,
-        switchOff,
-        _getFlacPath)
-except (ModuleNotFoundError, ImportError, NameError):
-    logging.error(
-        "Support for `psychopy.microphone` hardware is not available this "
-        "session. Please install `psychopy-legacy-mic` and restart the session "
-        "to enable support.")
-else:
-    # if we successfully load the package, warn the user to use the newer stuff
-    logging.warning(
-        "Attempting to import `psychopy.microphone`. Note that this library is "
-        "deprecated for the purpose of audio capture, but may still provide "
-        "other useful functionality. Use `psychopy.sound.microphone` for audio "
-        "capture instead."
-    )
+
+from psychopy.tools.pkgtools import PluginStub
+
+
+class AudioCapture(
+    PluginStub,
+    plugin="psychopy-legacy-mic"
+):
+    pass
+
 
 if __name__ == "__main__":
     pass

psychopy/platform_specific/__init__.py

@@ -44,5 +44,3 @@ elif sys.platform == 'darwin':
     from .darwin import *  # pylint: disable=W0401
 elif sys.platform.startswith('linux'):  # normally 'linux2'
     from .linux import *  # pylint: disable=W0401
-elif sys.platform == 'posix':  # ever?!
-    from .posix import *  # pylint: disable=W0401

psychopy/platform_specific/darwin.py

@@ -105,8 +105,6 @@ def getBusFreq():
 def rush(value=True, realtime=False):
     """Raise the priority of the current thread / process.
 
-    Win32 and macOS only so far - on linux use os.nice(niceIncrement)
-
     Set with rush(True) or rush(False).
 
     realtime arg is not used by osx implementation.
@@ -149,7 +147,7 @@ def rush(value=True, realtime=False):
                                       # send the address of the struct
                                       ctypes.byref(extendedPolicy),
                                       THREAD_STANDARD_POLICY_COUNT)
-    return True
+    return err == KERN_SUCCESS
 
 
 def getThreadPolicy(getDefault, flavour):