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

psychopy/liaison.py

@@ -13,13 +13,13 @@ zeroRPC
 
 
 import inspect
-import logging
 import asyncio
 import signal
 import json
 import sys
 import traceback
-
+import logging as _logging
+from psychopy import logging
 from psychopy.localization import _translate
 
 try:
@@ -37,9 +37,13 @@ class LiaisonJSONEncoder(json.JSONEncoder):
 	string before JSONifying.
 	"""
 	def default(self, o):
-		# if object has a getJSON method, use it
-		if hasattr(o, "getJSON"):
-			return o.getJSON(asString=False)
+		try:
+			# if object has a getJSON method, use it
+			if hasattr(o, "getJSON"):
+				return o.getJSON(asString=False)
+		except:
+			# if there's an error in the getJSON method, continue so we can try regular encoding
+			pass
 		# if object is an error, transform in standardised form
 		if isinstance(o, BaseException):
 			tb = traceback.format_exception(type(o), o, o.__traceback__)
@@ -56,6 +60,36 @@ class LiaisonJSONEncoder(json.JSONEncoder):
 			return str(o)
 
 
+class LiaisonLogger(logging._Logger):
+	"""
+	Special logger for Liaison which logs any messages sent, and the direction they 
+	were sent in (Python to JS or JS to Python). Logs both at level INFO.
+	"""	
+	def sent(self, message):
+		"""
+		Log a message sent by Liaison
+		"""
+		self.log(
+			message=message,
+			level=logging.INFO,
+			levelname="LIAISON PY->JS",
+		)
+		# immediately flush - we're not in a frame loop
+		self.flush()
+	
+	def received(self, message):
+		"""
+		Log a message received by Liaison
+		"""
+		self.log(
+			message=message,
+			level=logging.INFO,
+			levelname="LIAISON JS->PY",
+		)
+		# immediately flush - we're not in a frame loop
+		self.flush()
+
+
 class WebSocketServer:
 	"""
 	A simple Liaison server, using WebSockets as communication protocol.
@@ -67,19 +101,32 @@ class WebSocketServer:
 		"""
 		# the set of currently established connections:
 		self._connections = set()
+		self.loop = None
 
-		# setup a logger:
-		self._logger = logging.getLogger('liaison.WebSocketServer')
+		# setup a dedicated logger for messages
+		self.logger = LiaisonLogger()
+		# setup a base Python logger
+		self._logger = _logging.getLogger('liaison.WebSocketServer')
 		self._logger.setLevel(logging.DEBUG)
-		consoleHandler = logging.StreamHandler()
-		consoleHandler.setLevel(logging.DEBUG)
-		consoleHandler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
+		consoleHandler = _logging.StreamHandler()
+		consoleHandler.setLevel(_logging.DEBUG)
+		consoleHandler.setFormatter(_logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
 		self._logger.addHandler(consoleHandler)
 
 		# register the Liaison methods available to clients:
 		self._methods = {
-			'liaison': (self, ['listRegisteredMethods', 'pingPong'])
+			'liaison': (self, ['listRegisteredMethods', 'addLogFile', 'pingPong'])
 		}
+	
+	def addLogFile(self, file, loggingLevel=logging.INFO):
+		# actualize logging level
+		if isinstance(loggingLevel, str):
+			loggingLevel = getattr(logging, loggingLevel.upper())
+		# if given a log file, add it
+		logFile = logging.LogFile(
+			file, level=logging.DEBUG
+		)
+		self._logger.addTarget(logFile)
 
 	def registerObject(self, targetObject, referenceName):
 		"""
@@ -205,7 +252,12 @@ class WebSocketServer:
 		port : int
 			the port number, e.g. 8001
 		"""
-		asyncio.run(self.run(host, port))
+		# create a loop
+		self.loop = asyncio.new_event_loop()
+		# run loop until complete
+		self.loop.run_until_complete(
+			self.run(host, port)
+		)
 
 	def pingPong(self):
 		"""
@@ -221,20 +273,20 @@ class WebSocketServer:
 		Parameters
 		----------
 		host : string
-			the hostname, e.g. 'localhost'
+			The hostname, e.g. 'localhost'
 		port : int
-			the port number, e.g. 8001
+			The port number, e.g. 8001
 		"""
+		# create future for the current loop
+		loopFuture = self.loop.create_future()
 		# set the loop future on SIGTERM or SIGINT for clean interruptions:
-		loop = asyncio.get_running_loop()
-		loopFuture = loop.create_future()
 		if sys.platform in ("linux", "linux2"):
-			loop.add_signal_handler(signal.SIGINT, loopFuture.set_result, None)
-
-		async with websockets.serve(self._connectionHandler, host, port):
+			self.loop.add_signal_handler(signal.SIGINT, loopFuture.set_result, None)
+		# await loop's future to continuously serve
+		async with websockets.serve(self._connectionHandler, host, port, compression=None):
 			self._logger.info(f"Liaison Server started on: {host}:{port}")
+			# run forever
 			await loopFuture
-			# await asyncio.Future()  # run forever
 
 		self._logger.info('Liaison Server terminated.')
 
@@ -250,6 +302,7 @@ class WebSocketServer:
 		if not isinstance(message, str):
 			message = json.dumps(message, cls=LiaisonJSONEncoder)
 		for websocket in self._connections:
+			self.logger.sent(message)
 			await websocket.send(message)
 
 	def broadcastSync(self, message):
@@ -261,13 +314,11 @@ class WebSocketServer:
 		message : string
 			the message to be sent to all clients
 		"""
-		try:
-			# try to run in new loop
-			asyncio.run(self.broadcast(message))
-		except RuntimeError:
-			# use existing if there's already a loop
-			loop = asyncio.get_event_loop()
-			loop.create_task(self.broadcast(message))
+		# run task
+		asyncio.run_coroutine_threadsafe(
+			self.broadcast(message),
+			loop=self.loop
+		)
 
 	async def _connectionHandler(self, websocket):
 		"""
@@ -329,6 +380,8 @@ class WebSocketServer:
 		message : string
 			the message sent by the client to the server, as a JSON string
 		"""
+		# log message
+		self.logger.received(message)
 		# decode the message:
 		try:
 			decodedMessage = json.loads(message)
@@ -356,7 +409,7 @@ class WebSocketServer:
 					# try to parse json string
 					try:
 						arg = json.loads(arg)
-					except json.decoder.JSONDecodeError:
+					except (json.decoder.JSONDecodeError, TypeError):
 						pass
 					# if arg is a known property, get its value
 					arg = self.actualizeAttributes(arg)
@@ -396,24 +449,23 @@ class WebSocketServer:
 							rawResult = await method(*args)
 						else:
 							rawResult = method(*args)
-
-					# convert result to a string
-					result = json.dumps(rawResult, cls=LiaisonJSONEncoder)
-
-					# send a response back to the client:
-					response = {
-						"result": result
+					# prepare a response to send back to the client
+					rawResponse = {
+						"result": rawResult
 					}
-
 					# if there is a messageId in the message, add it to the response:
 					if 'messageId' in decodedMessage:
-						response['messageId'] = decodedMessage['messageId']
-
-					await websocket.send(json.dumps(response))
+						rawResponse['messageId'] = decodedMessage['messageId']
+					# convert to a string before sending
+					response = json.dumps(rawResponse, cls=LiaisonJSONEncoder)
+					# send
+					self.logger.sent(response)
+					await websocket.send(response)
 
 		except BaseException as err:
 			# JSONify any errors
 			err = json.dumps(err, cls=LiaisonJSONEncoder)
 			# send to server
+			self.logger.sent(err)
 			await websocket.send(err)
 			

psychopy/locale_setup.py

@@ -28,4 +28,14 @@ if macVer:
         from psychopy import prefs
         if not prefs.app['locale']:
             prefs.app['locale'] = u'en_US'
-        locale.setlocale(locale.LC_ALL, str(prefs.app['locale']) + '.UTF-8')
+        
+        # set the requested locale
+        reqLocale = str(prefs.app['locale'])
+        reqLocale += '.UTF-8'
+        try:
+            locale.setlocale(locale.LC_ALL, reqLocale)
+        except locale.Error:
+            # locale not found, use en_US.UTF-8
+            locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
+            print('Warning: locale {} not found, using en_US.UTF-8'.format(
+                reqLocale))

psychopy/localization/__init__.py

@@ -9,7 +9,7 @@ translation _translate():
 """
 
 # 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).
 
 try:

psychopy/localization/_localization.py

@@ -9,7 +9,7 @@ translation _translate():
 """
 
 # 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).
 
 # Author: Jeremy Gray, July 2014

psychopy/localization/messages.pot

@@ -329,7 +329,7 @@ msgid "Copyright (C) {year} OpenScienceTools.org"
 msgstr ""
 
 #: ../app/_psychopyApp.py:518
-msgid "  Creating frames..."
+msgid "Creating frames..."
 msgstr ""
 
 #: ../app/_psychopyApp.py:559
@@ -365,7 +365,7 @@ msgid "tips.txt"
 msgstr ""
 
 #: ../app/_psychopyApp.py:662
-msgid "  Loading plugins..."
+msgid "Loading plugins..."
 msgstr ""
 
 #: ../app/_psychopyApp.py:746

psychopy/logging.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).
 
 """Provides functions for logging error and other messages to one or more
@@ -127,12 +127,14 @@ def setDefaultClock(clock):
 
 class _LogEntry():
 
-    def __init__(self, level, message, t=None, obj=None):
+    def __init__(self, level, message, t=None, obj=None, levelname=None):
         super(_LogEntry, self).__init__()
         self.t = t
         self.t_ms = t * 1000
         self.level = level
-        self.levelname = getLevel(level)
+        if levelname is None:
+            levelname = getLevel(level)
+        self.levelname = levelname
         self.message = message
         self.obj = obj
 
@@ -275,7 +277,7 @@ class _Logger():
         for target in self.targets:
             self.lowestTarget = min(self.lowestTarget, target.level)
 
-    def log(self, message, level, t=None, obj=None):
+    def log(self, message, level, t=None, obj=None, levelname=None):
         """Add the `message` to the log stack at the appropriate `level`
 
         If no relevant targets (files or console) exist then the message is
@@ -290,7 +292,7 @@ class _Logger():
             t = defaultClock.getTime()
         # add message to list
         self.toFlush.append(
-            _LogEntry(t=t, level=level, message=message, obj=obj))
+            _LogEntry(t=t, level=level, levelname=levelname, message=message, obj=obj))
 
     def flush(self):
         """Process all current messages to each target
@@ -329,7 +331,7 @@ def critical(msg, t=None, obj=None):
     Send the message to any receiver of logging info (e.g. a LogFile)
     of level `log.CRITICAL` or higher
     """
-    root.log(msg, level=CRITICAL, t=t, obj=obj)
+    root.log(msg, level=CRITICAL, t=t, obj=obj, levelname="CRITICAL")
 fatal = critical
 
 
@@ -339,7 +341,7 @@ def error(msg, t=None, obj=None):
     Send the message to any receiver of logging info (e.g. a LogFile)
     of level `log.ERROR` or higher
     """
-    root.log(msg, level=ERROR, t=t, obj=obj)
+    root.log(msg, level=ERROR, t=t, obj=obj, levelname="ERROR")
 
 
 def warning(msg, t=None, obj=None):
@@ -348,7 +350,7 @@ def warning(msg, t=None, obj=None):
     Sends the message to any receiver of logging info (e.g. a LogFile)
     of level `log.WARNING` or higher
     """
-    root.log(msg, level=WARNING, t=t, obj=obj)
+    root.log(msg, level=WARNING, t=t, obj=obj, levelname="WARNING")
 warn = warning
 
 
@@ -361,7 +363,7 @@ def data(msg, t=None, obj=None):
     Sends the message to any receiver of logging info (e.g. a LogFile)
     of level `log.DATA` or higher
     """
-    root.log(msg, level=DATA, t=t, obj=obj)
+    root.log(msg, level=DATA, t=t, obj=obj, levelname="DATA")
 
 
 def exp(msg, t=None, obj=None):
@@ -374,7 +376,7 @@ def exp(msg, t=None, obj=None):
     Sends the message to any receiver of logging info (e.g. a LogFile)
     of level `log.EXP` or higher
     """
-    root.log(msg, level=EXP, t=t, obj=obj)
+    root.log(msg, level=EXP, t=t, obj=obj, levelname="EXP")
 
 
 def info(msg, t=None, obj=None):
@@ -386,7 +388,7 @@ def info(msg, t=None, obj=None):
     Sends the message to any receiver of logging info (e.g. a LogFile)
     of level `log.INFO` or higher
     """
-    root.log(msg, level=INFO, t=t, obj=obj)
+    root.log(msg, level=INFO, t=t, obj=obj, levelname="INFO")
 
 
 def debug(msg, t=None, obj=None):
@@ -399,7 +401,7 @@ def debug(msg, t=None, obj=None):
     Sends the message to any receiver of logging info (e.g. a LogFile)
     of level `log.DEBUG` or higher
     """
-    root.log(msg, level=DEBUG, t=t, obj=obj)
+    root.log(msg, level=DEBUG, t=t, obj=obj, levelname="DEBUG")
 
 
 def log(msg, level, t=None, obj=None):

psychopy/microphone.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).
 
 """Audio capture and analysis using pyo.
@@ -13,12 +13,13 @@ These are optional components that can be obtained by installing the
 """
 
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 
 class AudioCapture(
     PluginStub,
-    plugin="psychopy-legacy-mic"
+    plugin="psychopy-legacy-mic",
+    docsHome="https://github.com/psychopy/psychopy-legacy-mic",
 ):
     pass
 

psychopy/misc.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).
 
 """Wrapper for all miscellaneous functions and classes from psychopy.tools

psychopy/monitors/MonitorCenter.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 time
@@ -42,7 +42,7 @@ if not hasattr(wx.grid, 'EVT_GRID_CELL_CHANGED'):
 
 # wx IDs for menu items
 def newIds(n):
-    return [wx.NewId() for i in range(n)]
+    return [wx.NewIdRef(count=1) for i in range(n)]
 
 [idMenuSave] = newIds(1)
 # wx IDs for controllers (admin panel)
@@ -228,7 +228,7 @@ class MainFrame(wx.Frame):
 
         # Edit
         editMenu = wx.Menu()
-        id = wx.NewId()
+        id = wx.NewIdRef(count=1)
         _hint = _translate("Copy the current monitor's name to clipboard")
         editMenu.Append(id, _translate('Copy\tCtrl+C'), _hint)
         self.Bind(wx.EVT_MENU, self.onCopyMon, id=id)

psychopy/monitors/__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 .calibTools import *

psychopy/monitors/calibData.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).
 
 """Data useful for calibrations (Smith-Pokorny cone fundamentals etc...)

psychopy/monitors/calibTools.py

@@ -5,11 +5,11 @@
 """
 
 # 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 .calibData import wavelength_5nm, juddVosXYZ1976_5nm, cones_SmithPokorny
-from psychopy import __version__, logging, hardware
+from psychopy import __version__, logging
 
 try:
     import serial
@@ -1116,6 +1116,7 @@ def getRGBspectra(stimSize=0.3, winSize=(800, 600), photometer='COM1'):
         photom = photometer
     else:
         # setup photom
+        from psychopy import hardware
         photom = hardware.Photometer(photometer)
     if photom != None:
         havephotom = 1

psychopy/platform_specific/__init__.py

@@ -4,7 +4,7 @@
 """Platform specific extensions (using ctypes)"""
 
 # 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 sys

psychopy/platform_specific/darwin.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 psychopy import logging

psychopy/platform_specific/linux.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).
 
 """Placeholder for adding c (or ctypes) extensions to PsychoPy on linux.

psychopy/platform_specific/win32.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).
 
 # These are correct for win32, not sure about 64bit versions

psychopy/plugins/__init__.py

@@ -2,11 +2,13 @@
 # -*- 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).
 """Utilities for extending PsychoPy with plugins."""
 
 __all__ = [
+    'PluginStub',
+    'PluginRequiredError',
     'loadPlugin',
     'listPlugins',
     'installPlugin',
@@ -25,6 +27,7 @@ __all__ = [
 ]
 
 import os
+from pathlib import Path
 import sys
 import inspect
 import collections
@@ -32,6 +35,7 @@ import hashlib
 import importlib, importlib.metadata
 from psychopy import logging
 from psychopy.preferences import prefs
+from .util import PluginStub, PluginRequiredError
 
 # Configure the environment to use our custom site-packages location for
 # user-installed packages (i.e. plugins).
@@ -780,6 +784,10 @@ def loadPlugin(plugin):
                     #     _failed_plugins_.append(plugin)
                     #
                     # return False
+            # log that we're loading the entry point
+            logging.debug(
+                f"Registering entry point {ep.value} (from {plugin}) to {ep.group}:{ep.name}"
+            )
             try:
                 ep = ep.load()  # load the entry point
 
@@ -788,26 +796,21 @@ def loadPlugin(plugin):
                     logging.warning(
                         "Plugin `{}` is being loaded from a zip file. This may "
                         "cause issues with the plugin's functionality.".format(plugin))
-
-            except ImportError as e:
-                logging.error(
-                    "Failed to load entry point `{}` of plugin `{}`. "
-                    "(`{}: {}`) "
-                    "Skipping.".format(str(ep), plugin, e.name, e.msg))
-
-                if plugin not in _failed_plugins_:
-                    _failed_plugins_.append(plugin)
-
-                return False
-            except Exception:  # catch everything else
-                logging.error(
-                    "Failed to load entry point `{}` of plugin `{}` for unknown"
-                    " reasons. Skipping.".format(str(ep), plugin))
+            except Exception as err:
+                # generic start of message
+                msg = f"Skipping entry point {ep.value} (from {plugin}) to {ep.group}:{ep.name}"
+                # append reason
+                if isinstance(err, ImportError):
+                    msg += f" as {ep.value} cannot be imported."
+                else:
+                    msg += f", reason: {err}"
+                # log message
+                logging.error(msg)
 
                 if plugin not in _failed_plugins_:
                     _failed_plugins_.append(plugin)
 
-                return False
+                continue
 
             # If we get here, the entry point is valid and we can safely add it
             # to PsychoPy's namespace.
@@ -839,6 +842,12 @@ def loadPlugin(plugin):
                 _registerBuilderStandaloneRoutine(ep)
             elif fqn == 'psychopy.hardware.photometer':  # photometer
                 _registerPhotometer(ep)
+            elif fqn == "psychopy.app.themes.icons":
+                # get module folder
+                folder = Path(ep.__file__).parent
+                # add all matching .png files from that folder
+                for file in folder.glob(f"**/*.png"):
+                    targObj.pluginIconFiles.append(file)
 
     # Retain information about the plugin's entry points, we will use this for
     # conflict resolution.