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

psychopy/hardware/crs/shaders.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).
 
 # Acknowledgements:
@@ -12,10 +12,23 @@
 #    (Mario Kleiner) but does not use that code directly
 #    It is, for example, Mario's idea to add the 0.01 to avoid rounding issues
 
-try:
-    from psychopy_crs.shaders import bitsMonoModeFrag, bitsColorModeFrag
-except Exception:
+
+from psychopy.plugins import PluginStub
+
+
+class bitsMonoModeFrag(
+    PluginStub, 
+    plugin="psychopy-crs", 
+    docsHome="https://psychopy.github.io/psychopy-crs",
+    docsRef="/coder/shaders"
+):
     pass
 
-if __name__ == "__main__":
+
+class bitsColorModeFrag(
+    PluginStub, 
+    plugin="psychopy-crs", 
+    docsHome="https://psychopy.github.io/psychopy-crs",
+    docsRef="/coder/shaders"
+):
     pass

psychopy/hardware/emotiv.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).
 
 """Interfaces for EMOTIV devices such as button boxes.

psychopy/hardware/emulator.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).
 
 """Software fMRI machine emulator.
@@ -19,22 +19,28 @@ These are optional components that can be obtained by installing the
 """
 
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 
 class SyncGenerator(
     PluginStub,
-    plugin="psychopy-mri-emulator"
+    plugin="psychopy-mri-emulator",
+    docsHome="https://github.com/psychopy/psychopy-mri-emulator"
 ):
     pass
 
 
 class ResponseEmulator(
     PluginStub,
-    plugin="psychopy-mri-emulator"
+    plugin="psychopy-mri-emulator",
+    docsHome="https://github.com/psychopy/psychopy-mri-emulator"
 ):
     pass
 
 
-if __name__ == "__main__":
+class launchScan(
+    PluginStub,
+    plugin="psychopy-mri-emulator",
+    docsHome="https://github.com/psychopy/psychopy-mri-emulator"
+):
     pass

psychopy/hardware/exceptions.py

@@ -0,0 +1,86 @@
+import json
+import traceback
+
+
+class DeviceNotConnectedError(BaseException):
+    """
+    Raised when a subclass of BaseDevice is initialised but the physical device it represents can't 
+    be found.
+
+    Parameters
+    ----------
+    msg : str
+        Message to display
+    deviceClass : type
+        Device class which the error came from
+    context : dict, optional
+        Dict of any additional information to store
+    """
+    def __init__(self, msg, deviceClass=None, context=None, *args):
+        # make exception
+        BaseException.__init__(self, msg, *args)
+        # store device class
+        if deviceClass is not None and not isinstance(deviceClass, type):
+            deviceClass = type(deviceClass)
+        self.deviceClass = deviceClass
+        # store additional context
+        self.context = context
+    
+    def getJSON(self, asString=True):
+        """
+        Allow this type of error to be converted to JSON if requested.
+
+        Parameters
+        ----------
+        asString : bool, optional
+            Convert to a string or leave as a serializable dict? By default True
+        """
+        # get name of device class
+        if self.deviceClass is not None:
+            deviceType = self.deviceClass.__name__
+        else:
+            deviceType = "None"
+        # construct message
+        message = {
+            'type': "device_not_connected_error",
+            'device_type': deviceType,
+            'msg': str(self),
+            'traceback': traceback.format_exception(type(self), self, self.__traceback__),
+            'context': self.context
+        }
+        # stringify if requested
+        if asString:
+            message = json.dumps(message)
+
+        return message
+
+
+class ManagedDeviceError(BaseException):
+    """
+    Exception arising from a managed device, which will include information about the device from
+    DeviceManager.
+    """
+    def __init__(self, msg, deviceName, traceback=None):
+        # create exception
+        BaseException.__init__(self, msg)
+        # store device name
+        self.deviceName = deviceName
+        # store traceback
+        if traceback is not None:
+            self.traceback = traceback
+        else:
+            self.traceback = self.__traceback__
+
+    def getJSON(self, asString=True):
+        message = {
+            'type': "hardware_error",
+            'device': self.deviceName,
+            'msg': str(self),
+            'traceback': traceback.format_exception(type(self), self, self.traceback),
+            'context': getattr(self, "userdata", None)
+        }
+        # stringify if requested
+        if asString:
+            message = json.dumps(message)
+
+        return message

psychopy/hardware/forp.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).
 
 """Interfaces for Current Designs Inc. devices such as button boxes.
@@ -17,26 +17,21 @@ These are optional components that can be obtained by installing the
 
 """
 
-import psychopy.logging as logging
-
-try:
-    from psychopy_curdes import (
-        ButtonBox,
-        BUTTON_RED,
-        BUTTON_BLUE,
-        BUTTON_GREEN,
-        BUTTON_YELLOW,
-        BUTTON_TRIGGER,
-        BUTTON_MAP)
-except (ModuleNotFoundError, ImportError):
-    logging.error(
-        "Support for Current Designs Inc. hardware is not available this "
-        "session. Please install `psychopy-curdes` and restart the session "
-        "to enable support.")
-except Exception as e:
-    logging.error(
-        "Error encountered while loading `psychopy-curdes`. Check logs for "
-        "more information.")
-
-if __name__ == "__main__":
+
+from psychopy.plugins import PluginStub
+
+
+class ButtonBox(
+    PluginStub,
+    plugin="psychopy-curdes",
+    docsHome="https://github.com/psychopy/psychopy-curdes"
+):
     pass
+
+
+BUTTON_RED: int
+BUTTON_BLUE: int
+BUTTON_GREEN: int
+BUTTON_YELLOW: int
+BUTTON_TRIGGER: int
+BUTTON_MAP: dict

psychopy/hardware/gammasci.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).
 
 """Interfaces for Gamma-Scientific light-measuring devices.
@@ -14,8 +14,13 @@ These are optional components that can be obtained by installing the
 
 """
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 
-class S470(PluginStub, plugin="psychopy-gammasci", doclink="https://psychopy.github.io/psychopy-gammasci/coder/S470"):
+class S470(
+    PluginStub, 
+    plugin="psychopy-gammasci", 
+    docsHome="https://psychopy.github.io/psychopy-gammasci",
+    docsRef="/coder/S470"
+):
     pass

psychopy/hardware/iolab.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).
 
 """Interfaces for ioLab Systems button boxes.
@@ -12,24 +12,13 @@ These are optional components that can be obtained by installing the
 
 """
 
-import psychopy.logging as logging
+from psychopy.plugins import PluginStub
 
-try:
-    from psychopy_iolabs import ButtonBox
-except (ModuleNotFoundError, ImportError):
-    logging.error(
-        "Support for ioLab Systems hardware is not available this session. "
-        "Please install `psychopy-iolabs` and restart the session to enable "
-        "support.")
-except Exception as e:
-    logging.error(
-        "Error encountered while loading `psychopy-iolabs`. Check logs for "
-        "more information.")
-finally:
-    logging.warning(
-        "Support for ioLabs Systems hardware has been discontinued and will "
-        "likely break in the future."
-    )
 
-if __name__ == "__main__":
+class ButtonBox(
+    PluginStub,
+    plugin="psychopy-iolabs",
+    docsHome="http://psychopy.github.io/psychopy-iolabs",
+    docsRef="/coder/ButtonBox/"
+):
     pass