psychopy 2024.1.1__tar.gz → 2024.1.3__tar.gz

psychopy-2024.1.3/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: psychopy
+Version: 2024.1.3
+Summary: PsychoPy provides easy, precise, flexible experiments in behavioural sciences
+Author-Email: Open Science Tools Ltd <support@opensciencetools.org>
+Maintainer-Email: Open Science Tools Ltd <support@opensciencetools.org>
+Classifier: Development Status :: 4 - Beta
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Project-URL: Homepage, https://www.psychopy.org/
+Project-URL: Download, https://github.com/psychopy/psychopy/releases/
+Requires-Python: <3.11,>=3.8
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: pyglet==1.4.11; platform_system == "Windows"
+Requires-Dist: pyglet==1.5.27; platform_system != "Windows"
+Requires-Dist: pillow>=9.4.0
+Requires-Dist: pyqt6
+Requires-Dist: pandas>=1.5.3
+Requires-Dist: questplus>=2023.1
+Requires-Dist: openpyxl
+Requires-Dist: xmlschema
+Requires-Dist: soundfile
+Requires-Dist: imageio
+Requires-Dist: imageio-ffmpeg
+Requires-Dist: psychtoolbox
+Requires-Dist: pywinhook; platform_system == "Windows"
+Requires-Dist: gevent
+Requires-Dist: psutil
+Requires-Dist: pyzmq>=22.2.1
+Requires-Dist: ujson
+Requires-Dist: msgpack
+Requires-Dist: msgpack-numpy
+Requires-Dist: pyyaml
+Requires-Dist: freetype-py
+Requires-Dist: python-bidi
+Requires-Dist: arabic-reshaper
+Requires-Dist: javascripthon
+Requires-Dist: websockets
+Requires-Dist: wxPython>=4.1.1
+Requires-Dist: markdown-it-py
+Requires-Dist: requests
+Requires-Dist: future
+Requires-Dist: pypi-search>=1.2.1
+Requires-Dist: setuptools<=66.1.1
+Requires-Dist: python-gitlab
+Requires-Dist: gitpython
+Requires-Dist: cryptography
+Requires-Dist: javascripthon>=0.12
+Requires-Dist: astunparse
+Requires-Dist: esprima
+Requires-Dist: jedi>=0.16
+Requires-Dist: pyserial
+Requires-Dist: pyparallel; platform_system != "Darwin"
+Requires-Dist: ffpyplayer
+Requires-Dist: opencv-python
+Requires-Dist: python-vlc==3.0.11115; platform_system == "Windows"
+Requires-Dist: python-vlc>=3.0.12118; platform_system != "Windows"
+Requires-Dist: pypiwin32; platform_system == "Windows"
+Requires-Dist: pyobjc-core; platform_system == "Darwin"
+Requires-Dist: pyobjc-framework-Quartz<8.0; platform_system == "Darwin"
+Requires-Dist: pyobjc; platform_system == "Darwin"
+Requires-Dist: zeroconf; platform_system == "Darwin"
+Requires-Dist: python-xlib; platform_system == "Linux"
+Requires-Dist: tables<3.9; python_version < "3.9"
+Requires-Dist: tables; python_version >= "3.9"
+Requires-Dist: blosc2<2.2.8; python_version < "3.9"
+Requires-Dist: pytest>=6.2.5; extra == "tests"
+Requires-Dist: pytest-codecov; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-asyncio; extra == "tests"
+Requires-Dist: flake8; extra == "tests"
+Requires-Dist: xmlschema; extra == "tests"
+Requires-Dist: bdist-mpkg>=0.5.0; platform_system == "Darwin" and extra == "building"
+Requires-Dist: py2app; platform_system == "Darwin" and extra == "building"
+Requires-Dist: dmgbuild; platform_system == "Darwin" and extra == "building"
+Requires-Dist: pylsl>=1.16.1; extra == "suggested"
+Requires-Dist: xlwt; extra == "suggested"
+Requires-Dist: h5py; extra == "suggested"
+Requires-Dist: google-api-python-client; extra == "suggested"
+Requires-Dist: pygaze>=1.1.2; extra == "suggested"
+Requires-Dist: tobii_research; extra == "suggested"
+Requires-Dist: badapted>=0.0.3; extra == "suggested"
+Requires-Dist: egi-pynetstation>=0.0.0rc1; extra == "suggested"
+Requires-Dist: pyxid2>=1.0.5; extra == "suggested"
+Requires-Dist: Phidget22; extra == "suggested"
+Requires-Dist: pyo>=1.0.3; extra == "legacy"
+Requires-Dist: pyglfw; extra == "legacy"
+Requires-Dist: moviepy; extra == "legacy"
+Requires-Dist: pygame; extra == "legacy"
+Provides-Extra: tests
+Provides-Extra: building
+Provides-Extra: suggested
+Provides-Extra: legacy
+Description-Content-Type: text/markdown
+
+# PsychoPy
+
+[![PyPI version](https://img.shields.io/pypi/v/psychopy.svg)](https://pypi.python.org/pypi/PsychoPy)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)  
+
+---
+
+**Announcement!!**
+
+We are excited to announce that PsychoPy will be hosting a 3-day in-person code-sprint at the University of Nottingham from 15-17 April 2024. The code sprint will be an opportunity for us to get together in person and improve PsychoPy/JS. Anyone who would like to attend will need to fill out the [online application](https://run.pavlovia.org/pavlovia/survey/?surveyId=171ed328-d5ea-4819-83dc-9ba00ef5683b) by 31 January 2024. Those selected will be notified by the end of February.
+
+---
+
+PsychoPy is an open-source package for creating experiments in behavioral science. It aims to provide a single package that is:
+
+* precise enough for psychophysics
+* easy enough for teaching
+* flexible enough for everything else
+* able to run experiments in a local Python script or online in JavaScript
+
+To meet these goals PsychoPy provides a choice of interface - you can use a
+simple graphical user interface called Builder, or write your experiments in
+Python code. The entire application and library are written in Python and is
+platform independent.
+
+There is a range of documentation at:
+
+* [PsychoPy Homepage](https://www.psychopy.org)
+* [Youtube](https://www.youtube.com/playlist?list=PLFB5A1BE51964D587)
+* The textbook, [Building Experiments in PsychoPy](https://uk.sagepub.com/en-gb/eur/building-experiments-in-psychopy/book253480)
+* [The discourse user forum](https://discourse.psychopy.org)
+
+## Contributions
+
+To contribute, please fork the repository, hack in a feature branch, and send a
+pull request.  For more, see [CONTRIBUTING.md](CONTRIBUTING.md)
+and the developers documentation at [https://www.psychopy.org/developers](https://psychopy.org/developers)
+
+## Code Status
+
+[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/psychopy/psychopy.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/psychopy/psychopy/context:python)  
+Dev branch tests: [![GH tests](https://github.com/psychopy/psychopy/actions/workflows/pytests.yaml/badge.svg?branch=dev)](https://github.com/psychopy/psychopy/actions/workflows/pytests.yaml?query=branch%3Adev)  
+Release tests: [![GH tests](https://github.com/psychopy/psychopy/actions/workflows/pytests.yaml/badge.svg?branch=release)](https://github.com/psychopy/psychopy/actions/workflows/pytests.yaml?query=branch%3Arelease)
+
+## More information
+
+* Homepage: https://www.psychopy.org
+* Forum: https://discourse.psychopy.org
+* Issue tracker: https://github.com/psychopy/psychopy/issues
+* Changelog: https://www.psychopy.org/changelog.html

psychopy-2024.1.3/psychopy/__init__.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Part of the PsychoPy library
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Distributed under the terms of the GNU General Public License (GPL).
+
+# --------------------------------------------------------------------------
+# This file is automatically generated during build (do not edit directly).
+# --------------------------------------------------------------------------
+
+import os
+import sys
+
+__version__ = '2024.1.3'
+__license__ = 'GPL v3'
+__author__ = 'Open Science Tools Ltd'
+__author_email__ = 'support@opensciencetools.org'
+__maintainer_email__ = 'support@opensciencetools.org'
+__url__ = 'https://www.psychopy.org/'
+__download_url__ = 'https://github.com/psychopy/psychopy/releases/'
+__git_sha__ = 'a2e6ccdec'
+__build_platform__ = 'n/a'
+
+__all__ = ["gui", "misc", "visual", "core",
+           "event", "data", "sound", "microphone"]
+
+# for developers the following allows access to the current git sha from
+# their repository
+if __git_sha__ == 'n/a':
+    from subprocess import check_output, PIPE
+    # see if we're in a git repo and fetch from there
+    try:
+        thisFileLoc = os.path.split(__file__)[0]
+        output = check_output(['git', 'rev-parse', '--short', 'HEAD'],
+                              cwd=thisFileLoc, stderr=PIPE)
+    except Exception:
+        output = False
+    if output:
+        __git_sha__ = output.strip()  # remove final linefeed
+
+# update preferences and the user paths
+if 'installing' not in locals():
+    from psychopy.preferences import prefs
+    for _pathName in prefs.general['paths']:
+        sys.path.append(_pathName)
+    
+    # add paths from main plugins/packages (installed by plugins manager)
+    _userPackagePath = prefs.paths['userPackages']
+    _userScripts = prefs.paths['userScripts']
+    if _userPackagePath.is_dir():
+        sys.path.append(str(_userPackagePath))  # user site-packages
+        sys.path.append(str(_userScripts))  # user scripts
+
+    # add paths from individual plugins/packages (installed by plugins manager)
+    import pathlib as _pathlib
+    for _pathName in _pathlib.Path(prefs.paths['packages']).glob("*"):
+        if _pathName.is_dir():
+            sys.path.append(str(_pathName))
+
+    from psychopy.tools.versionchooser import useVersion, ensureMinimal
+
+if sys.version_info.major < 3:
+    raise ImportError("psychopy does not support Python2 installations. "
+                      "The last version to support Python2.7 was PsychoPy "
+                      "2021.2.x")
+
+# import readline here to get around an issue with sounddevice
+# issues GH-2230 GH-2344 GH-2662
+try:
+    import readline
+except ImportError:
+    pass  # all that will happen is the stderr/stdout might get redirected
+

psychopy-2024.1.3/psychopy/alerts/_alerts.py

@@ -0,0 +1,188 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from pathlib import Path
+import traceback
+import yaml
+import os
+import sys
+import codecs
+
+from psychopy.localization import _translate
+
+
+"""
+The Alerts module is used for generating alerts during PsychoPy integrity checks.
+
+Attributes
+----------
+catalog : AlertCatalog
+    For loading alert catalogues, or definitions of each alert, from a catalog of yaml files.
+    Each catalogue entry has a code key, with values of code, category, msg, and url.
+    Each entry has equivalent reStructuredText entries for insertion into help pages. 
+alertLog : List
+    For storing alerts that are otherwise lost when flushing standard stream. The stored
+    lists can be used to feed AlertPanel using in Project Info and new Runner frame.
+"""
+
+_activeAlertHandlers = []
+
+
+class AlertCatalog:
+    """A class for loading alerts from the alerts catalogue yaml file"""
+    def __init__(self):
+        self.alert = self.load()
+
+    @property
+    def alertPath(self):
+        return Path(__file__).parent / "alertsCatalogue"
+
+    @property
+    def alertFiles(self):
+        return list(self.alertPath.glob("*[0-9].*"))
+
+    def load(self):
+        """Loads alert catalogue yaml files
+
+        Returns
+        -------
+        dict
+            The alerts catalogue as a Python dictionary
+        """
+        alertDict = {}
+
+        for filePath in self.alertFiles:
+            # '{}'.format(filePath) instead of simple open(filePath,'r')
+            # is needed for Py2 support only
+            with codecs.open('{}'.format(filePath), 'r', 'utf-8') as ymlFile:
+                entry = yaml.load(ymlFile, Loader=yaml.SafeLoader)
+                if entry is None:
+                    continue  # this might be a stub for future entry
+                ID = entry['code']
+                alertDict[ID] = entry
+                if 'url' not in entry:  # give a default URL
+                    entry['url'] = ('https://psychopy.org/alerts/{}.html'
+                                    .format(ID))
+
+        return alertDict
+
+
+class AlertEntry:
+    """An Alerts data class holding alert data as attributes
+
+    Attributes
+    ----------
+
+    code: int
+        The 4 digit code for retrieving alert from AlertCatalogue
+    cat: str
+        The category of the alert
+    url: str
+        A URL for pointing towards information resources for solving the issue
+    obj: object
+        The object related to the alert e.g., TextComponent object.
+    type: str
+        Type of component being tested
+    name: str
+        Name of component being tested
+    msg: str
+        The alert message
+    trace: sys.exec_info() traceback object
+            The traceback
+
+    Parameters
+    ----------
+    code: int
+            The 4 digit code for retrieving alert from AlertCatalogue
+    obj: object
+        The object related to the alert e.g., TextComponent object.
+    strFields: dict
+            Dict containing relevant values for formatting messages
+    trace: sys.exec_info() traceback object
+            The traceback
+    """
+    def __init__(self, code, obj, strFields=None, trace=None):
+        self.label = catalog.alert[code]['label']
+        self.code = catalog.alert[code]['code']
+        self.cat = catalog.alert[code]['cat']
+        self.url = catalog.alert[code]['url']
+        self.obj = obj
+
+        if hasattr(obj, 'type'):
+            self.type = obj.type
+        else:
+            self.type = None
+
+        if hasattr(obj, "params"):
+            self.name = obj.params['name'].val
+        else:
+            self.name = None
+
+        # _translate(catalog.alert[code]['msg']) works, but string literals
+        # in _translate() (i.e., 'msg' in this case) cause false detection 
+        # by pybabel.
+        msg = catalog.alert[code]['msg']
+        if strFields:
+            self.msg = _translate(msg).format(**strFields)
+        else:
+            self.msg = _translate(msg)
+
+        if trace:
+            self.trace = ''.join(traceback.format_exception(
+                trace[0], trace[1], trace[2]))
+        else:
+            self.trace = None
+
+
+def alert(code=None, obj=object, strFields=None, trace=None):
+    """The alert function is used for writing alerts to the standard error stream.
+    Only the ErrorHandler class can receive alerts via the "receiveAlert" method.
+
+    Parameters
+    ----------
+    code: int
+        The 4 digit code for retrieving alert from AlertCatalogue
+    obj: object
+        The object related to the alert e.g., TextComponent object
+    strFields: dict
+        Dict containing relevant values for formatting messages
+    trace: sys.exec_info() traceback object
+            The traceback
+    """
+
+    msg = AlertEntry(code, obj, strFields, trace)
+
+    # format the warning into a string for console and logging targets
+    msgAsStr = ("Alert {code}: {msg}\n"
+                "For more info see https://docs.psychopy.org/alerts/{code}.html"
+                .format(type=msg.type,
+                        name=msg.name,
+                        code=msg.code,
+                        cat=msg.cat,
+                        msg=msg.msg,
+                        trace=msg.trace))
+    # msgAsStr = ("Component Type: {type} | "
+    #             "Component Name: {name} | "
+    #             "Code: {code} | "
+    #             "Category: {cat} | "
+    #             "Message: {msg} | "
+    #             "Traceback: {trace}".format(type=msg.type,
+    #                                         name=msg.name,
+    #                                         code=msg.code,
+    #                                         cat=msg.cat,
+    #                                         msg=msg.msg,
+    #                                         trace=msg.trace))
+
+    # if a psychopy warning instead of a file-like stderr then pass a raw str
+    if hasattr(sys.stderr, 'receiveAlert'):
+        sys.stderr.receiveAlert(msg)
+    else:
+        # For tests detecting output - change when error handler set up
+        sys.stderr.write(msgAsStr)
+        for handler in _activeAlertHandlers:
+            handler.receiveAlert(msg)
+
+
+# Create catalog
+catalog = AlertCatalog()
+alertLog = []

psychopy-2024.1.3/psychopy/alerts/alertsCatalogue/alertmsg.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# This file was generated by generateAlertmsg.py.
+# Following strings are used to localize alerts.
+# Rebuild this file if alert messages in *.yaml files are modified.
+
+from psychopy.localization import _translate
+
+# Alert 2115
+_translate(
+    "Your stimulus size exceeds the {dimension} dimension of your window.")
+
+# Alert 2120
+_translate(
+    "Your stimulus size is smaller than 1 pixel ({dimension} dimension).")
+
+# Alert 2155
+_translate(
+    "Your stimulus position exceeds the {dimension} dimension of your window.")
+
+# Alert 3110
+_translate(
+    "Your stimulus {type} time of {time} is less than a screen refresh for a {Hz}Hz monitor.")
+
+# Alert 3115
+_translate(
+    "Your stimulus {type} time of {time} seconds cannot be accurately presented for {time} on a {Hz}Hz monitor.")
+
+# Alert 4051
+_translate(
+    "Experiment was built in a future version of PsychoPy ({version}), we recommend either updating PsychoPy or changing the \"Use Version\" setting in Experiment Settings to this version.")
+
+# Alert 4052
+_translate(
+    "Experiment was built in a past version of PsychoPy ({version}), saving it in this version may add parameters which cannot be parsed.")
+
+# Alert 4105
+_translate(
+    "Your stimulus start {type} exceeds the stop {type}. Consider using a {type} duration.")
+
+# Alert 4115
+_translate(
+    "Your stimulus {type} type {frameType} must be expressed as a whole number.")
+
+# Alert 4120
+_translate(
+    "Component {component} has stop time set as a duration, but doesn't have a start time")
+
+# Alert 4125
+_translate(
+    "Microphone component `{name}` given blank stop time, using max duration allowed by buffer size ({stopVal}s).")
+
+# Alert 4205
+_translate(
+    "Python Syntax Error in '{codeTab}' tab. See '{code}' on line number {lineNumber} of the '{codeTab}' tab.")
+
+# Alert 4210
+_translate(
+    "JavaScript Syntax Error in '{codeTab}' tab. See '{lineNumber}' in the '{codeTab}' tab.")
+
+# Alert 4305
+_translate(
+    "The component {name} is currently disabled and will not be written to your experiment script.")
+
+# Alert 4310
+_translate("Cannot calculate parameter.")
+
+# Alert 4315
+_translate(
+    "Builder cannot interpret value \"{param.val}\" of {param.label} for {component.type} component \"{component.params[name].val}\" as a dollar sign has been used incorrectly.")
+
+# Alert 4320
+_translate(
+    "Font `{param.val}` not found locally, will check Google Fonts on next run.")
+
+# Alert 4325
+_translate(
+    "Font `{font} {style}` not available in weight `{weight}`, component `{name}` will default to Open Sans Regular.")
+
+# Alert 4330
+_translate(
+    "Recording device '{device}' not found, using default device instead.")
+
+# Alert 4335
+_translate(
+    "The component or routine '{comp}' is only implemented online, so will do nothing when running locally.")
+
+# Alert 4340
+_translate(
+    "The component or routine '{comp}' is only implemented locally, so will do nothing when running online.")
+
+# Alert 4405
+_translate(
+    "Editable textbox component {textbox} and keyboard component {keyboard} in the same routine may compete for keypresses")
+
+# Alert 4505
+_translate("Experiment includes components or routines which use eyetracking, but no eye tracker is configured.")
+
+# Alert 4510
+_translate(
+    "A {eyetracker} eye tracker has been configured, but no calibration routine is present.")
+
+# Alert 4520
+_translate("As {brand} eyetrackers do not support animations in their calibration routine, animation values have not been used in your calibration routine.")
+
+# Alert 4530
+_translate("Eyetrackers by {brand} do not support manual pacing")
+
+# Alert 4540
+_translate(
+    "Window mode is set to be windowed, but eyetracking requires the window to be full screen.")
+
+# Alert 4545
+_translate(
+    "A monitor config is required for accurate eyetracking measurements, but none was found.")
+
+# Alert 4550
+_translate(
+    "Eye tracker experiments should use 'ioHub' as the Input -> Keyboard Backend setting")
+
+# Alert 4605
+_translate(
+    "Audio transcription service \"{transcriber}\" is not supported online.")
+
+# Alert 4610
+_translate(
+    "Audio transcription service \"{transcriber}\" is not supported offline.")
+
+# Alert 4615
+_translate(
+    "Chosen transcriber '{engine}' requires an API key, please supply one in Preferences.")
+
+# Alert 4705
+_translate(
+    "Column name '{param}' in conditions file already exists as a variable in this experiment ({category}).")
+
+# Alert 4710
+_translate("Column name '{param}' is likely to cause name clashes. {msg}.")
+
+# Alert 5055
+_translate(
+    "Device parameter of microphone component \"{name}\" will not be used online.")
+
+# Alert 6105
+_translate(
+    "The file you are attempting to run does not seem to exist, the full path supplied to Runner was {path}")
+
+# Alert 7105
+_translate(
+    "Component {name} comes from the plugin {plugin}, which is either not installed or not activated.")
+
+# Alert 8105
+_translate(
+    "Color space attribute `.{colorSpaceAttrib}` is no longer in use, as colors are no longer tied to one space.")
+
+# Alert 8110
+_translate(
+    "RGB attribute `.{rgbAttrib}` is no longer in use, as non-RGB colors now handle their own conversion.")