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

psychopy/tests/test_visual/test_textbox.py

@@ -102,6 +102,42 @@ class Test_textbox(_TestColorMixin, _TestUnitsMixin, _TestBoilerplateMixin):
                 #self.win.getMovieFrame(buffer='back').save(Path(utils.TESTS_DATA_PATH) / filename)
                 utils.compareScreenshot(Path(utils.TESTS_DATA_PATH) / filename, self.win, crit=20)
 
+    def test_ori(self):
+        # setup textbox
+        self.textbox.color = "black"
+        self.textbox.fillColor = "white"
+        self.textbox.units = "pix"
+        self.textbox.size = (100, 50)
+        self.textbox.pos = (0, 0)
+        self.textbox.letterHeight = 5
+        # define params to use
+        orientations = [
+            0, 120, 180, 240,
+        ]
+        anchors = [
+            "top left", "center", "bottom right",
+        ]
+        # try each combination
+        for ori in orientations:
+            for anchor in anchors:
+                # flip
+                self.win.flip()
+                # set params
+                self.textbox.ori = ori
+                self.textbox.anchor = anchor
+                self.textbox._layout()
+                # draw
+                self.textbox.draw()
+                # construct exemplar filename
+                exemplar = f"test_ori_{ori}_{anchor}.png"
+                # check/make exemplar
+                # self.win.getMovieFrame(buffer='back').save(
+                #     Path(utils.TESTS_DATA_PATH) / "Test_textbox" / exemplar
+                # )
+                utils.compareScreenshot(
+                    Path(utils.TESTS_DATA_PATH) / "Test_textbox" / exemplar, self.win, crit=20
+                )
+
     def test_colors(self):
         # Do base tests
         _TestColorMixin.test_colors(self)

psychopy/tests/utils.py

@@ -6,6 +6,7 @@ import shutil
 import numpy as np
 import io
 from psychopy import logging, colors
+from psychopy.tools import systemtools
 
 try:
     from PIL import Image
@@ -14,6 +15,9 @@ except ImportError:
 
 import pytest
 
+# boolean indicating whether tests are running in a VM
+RUNNING_IN_VM = systemtools.isVM_CI() is not None
+
 # define the path where to find testing data
 # so tests could be ran from any location
 TESTS_PATH = abspath(dirname(__file__))

psychopy/tools/filetools.py

@@ -74,7 +74,7 @@ def _synonymiseExtensions(assets):
 
 
 # Names accepted by stimulus classes & the filename of the default stimulus to use
-defaultStimRoot = Path(__file__).parent.parent / "app" / "Resources"
+defaultStimRoot = Path(__file__).parent.parent / "assets"
 defaultStim = {
     # Image stimuli
     "default.png": "default.png",

psychopy/tools/pkgtools.py

@@ -26,8 +26,7 @@ import subprocess as sp
 from psychopy.preferences import prefs
 from psychopy.localization import _translate
 import psychopy.logging as logging
-import importlib
-import pkg_resources
+import importlib, importlib.metadata, importlib.resources
 import sys
 import os
 import os.path
@@ -37,23 +36,69 @@ import site
 
 # On import we want to configure the user site-packages dir and add it to the
 # import path. 
-
 # set user site-packages dir
-site.USER_BASE = prefs.paths['packages']
-site.USER_SITE = None  # clear, recompute this value 
-logging.debug('User site-packages dir set to: %s' % site.getusersitepackages())
+if os.environ.get('PSYCHOPYNOPACKAGES', '0') == '1':
+    site.ENABLE_USER_SITE = True
+    site.USER_SITE = str(prefs.paths['userPackages'])
+    site.USER_BASE = None
+    logging.debug(
+        'User site-packages dir set to: %s' % site.getusersitepackages())
+    
+    # add paths from main plugins/packages (installed by plugins manager)
+    site.addsitedir(prefs.paths['userPackages'])  # user site-packages
+    site.addsitedir(prefs.paths['userInclude'])  # user include
+    site.addsitedir(prefs.paths['packages'])  # base package dir
 
 if not site.USER_SITE in sys.path:
     site.addsitedir(site.getusersitepackages()) 
 
-# add packages dir to import path
-if prefs.paths['packages'] not in pkg_resources.working_set.entries:
-    pkg_resources.working_set.add_entry(prefs.paths['packages'])
-
 # cache list of packages to speed up checks
 _installedPackageCache = []
 _installedPackageNamesCache = []
 
+# reference the user packages path
+USER_PACKAGES_PATH = str(prefs.paths['userPackages'])
+
+
+class PluginStub:
+    """
+    Class to handle classes which have moved out to plugins.
+
+    Example
+    -------
+    ```
+    class NoiseStim(PluginStub, plugin="psychopy-visionscience", doclink="https://psychopy.github.io/psychopy-visionscience/builder/components/NoiseStimComponent/):
+    ```
+    """
+
+    def __init_subclass__(cls, plugin, doclink="https://plugins.psychopy.org/directory.html"):
+        """
+        Subclassing PluginStub will create documentation pointing to the new documentation for the replacement class.
+        """
+        # store ref to plugin and docs link
+        cls.plugin = plugin
+        cls.doclink = doclink
+        # create doc string point to new location
+        cls.__doc__ = (
+            "`{mro}` is now located within the `{plugin}` plugin. You can find the documentation for it `here <{doclink}>`_."
+        ).format(
+            mro=cls.__mro__,
+            plugin=plugin,
+            doclink=doclink
+        )
+    
+    def __call__(self, *args, **kwargs):
+        """
+        When initialised, rather than creating an object, will log an error.
+        """
+        raise NameError(
+            "Support for `{mro}` is not available this session. Please install "
+            "`{plugin}` and restart the session to enable support."
+        ).format(
+            mro=type(self).__mro__,
+            plugin=self.plugin,
+        )
+
 
 def refreshPackages():
     """Refresh the packaging system.
@@ -61,28 +106,27 @@ def refreshPackages():
     This needs to be called after adding and removing packages, or making any
     changes to `sys.path`. Functions `installPackages` and `uninstallPackages`
     calls this everytime.
-
-    Warnings
-    --------
-    Calling this forces a reload of `pkg_resources`. This can cause side-effects
-    for other modules using it!
-
     """
     global _installedPackageCache
     global _installedPackageNamesCache
 
     _installedPackageCache.clear()
     _installedPackageNamesCache.clear()
-
-    importlib.reload(pkg_resources)  # reload since package paths might be stale
-
-    # this is like calling `pip freeze` and parsing the output, but faster!
-    for pkg in pkg_resources.working_set:
-        thisPkg = pkg_resources.get_distribution(pkg.key)
+    
+    # iterate through installed packages in the user folder
+    for dist in importlib.metadata.distributions(path=sys.path + [USER_PACKAGES_PATH]):
+        # get name if in 3.8
+        if sys.version.startswith("3.8"):
+            distName = dist.metadata['name']
+        else:
+            distName = dist.name
+        # mark as installed
         _installedPackageCache.append(
-            (thisPkg.project_name, thisPkg.version))
-        _installedPackageNamesCache.append(pkg_resources.safe_name(
-            thisPkg.project_name))  # names only
+            (distName, dist.version)
+        )
+        _installedPackageNamesCache.append(
+            distName
+        )
 
 
 def getUserPackagesPath():
@@ -111,10 +155,12 @@ def getDistributions():
         plugins can be found.
 
     """
-    toReturn = list()
-    toReturn.extend(pkg_resources.working_set.entries)  # copy
-
-    return toReturn
+    logging.error(
+        "`pkgtools.getDistributions` is now deprecated as packages are detected via "
+        "`importlib.metadata`, which doesn't need a separate working set from the system path. "
+        "Please use `sys.path` instead."
+    )
+    return sys.path
 
 
 def addDistribution(distPath):
@@ -130,8 +176,13 @@ def addDistribution(distPath):
         file (e.g. ZIP).
 
     """
-    if distPath not in pkg_resources.working_set.entries:
-        pkg_resources.working_set.add_entry(distPath)
+    logging.error(
+        "`pkgtools.addDistribution` is now deprecated as packages are detected via "
+        "`importlib.metadata`, which doesn't need a separate working set from the system path. "
+        "Please use `sys.path.append` instead."
+    )
+    if distPath not in sys.path:
+        sys.path.append(distPath)
 
 
 def installPackage(package, target=None, upgrade=False, forceReinstall=False,
@@ -169,7 +220,7 @@ def installPackage(package, target=None, upgrade=False, forceReinstall=False,
 
     """
     if target is None:
-        target = prefs.paths['packages']
+        target = prefs.paths['userPackages']
 
     # check the directory exists before installing
     if not os.path.exists(target):
@@ -194,17 +245,33 @@ def installPackage(package, target=None, upgrade=False, forceReinstall=False,
     if noDeps:
         cmd.append('--no-deps')
 
+    # check if we are in a virtual environment, if so, dont use --user
+    if hasattr(sys, 'real_prefix') or (
+            hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix):
+        # we are in a venv
+        logging.warning(
+            "You are installing a package inside a virtual environment. "
+            "The package will be installed in the user site-packages directory."
+        )
+    else:
+        cmd.append('--user')
+
+    cmd.append('--prefer-binary')  # use binary wheels if available
     cmd.append('--no-input')  # do not prompt, we cannot accept input
     cmd.append('--no-color')  # no color for console, not supported
     cmd.append('--no-warn-conflicts')  # silence non-fatal errors
 
+    # get the environment for the subprocess
+    env = os.environ.copy()
+
     # run command in subprocess
     output = sp.Popen(
         cmd,
         stdout=sp.PIPE,
         stderr=sp.PIPE,
         shell=False,
-        universal_newlines=True)
+        universal_newlines=True,
+        env=env)
     stdout, stderr = output.communicate()  # blocks until process exits
 
     sys.stdout.write(stdout)
@@ -272,14 +339,18 @@ def _isUserPackage(package):
         `True` if the package is present in the user's PsychoPy directory.
 
     """
-    userPackagePath = getUserPackagesPath()
-    for pkg in pkg_resources.working_set:
-        if pkg_resources.safe_name(package) == pkg.key:
-            thisPkg = pkg_resources.get_distribution(pkg.key)
-            if thisPkg.location == userPackagePath:
-                return True
-
-    return False
+    # get packages in the user path
+    userPackages = []
+    for dist in importlib.metadata.distributions(path=[USER_PACKAGES_PATH]):
+        # substitute name if using 3.8
+        if sys.version.startswith("3.8"):
+            distName = dist.metadata['name']
+        else:
+            distName = dist.name
+        # get name
+        userPackages.append(distName)
+    
+    return package in userPackages
 
 
 def _uninstallUserPackage(package):
@@ -315,95 +386,47 @@ def _uninstallUserPackage(package):
     logging.info(msg)
     stdout += msg + "\n"
 
-    # figure out he name of the metadata directory
-    pkgName = pkg_resources.safe_name(package)
-    thisPkg = pkg_resources.get_distribution(pkgName)
-
-    # build path to metadata based on project name
-    pathHead = pkg_resources.to_filename(thisPkg.project_name) + '-'
-    metaDir = pathHead + thisPkg.version
-    metaDir += '' if thisPkg.py_version is None else '.' + thisPkg.py_version
-    metaDir += '.dist-info'
-
-    # check if that directory exists
-    metaPath = os.path.join(userPackagePath, metaDir)
-    if not os.path.isdir(metaPath):
-        return False, {
-            "cmd": cmd,
-            "stdout": stdout,
-            "stderr": "No package metadata found at {metaPath}"}
-
-    # Get the top-levels for all packages in the user's PsychoPy directory, this
-    # is intended to safely remove packages without deleting common directories
-    # like `bin` which some packages insist on putting in there.
-    allTopLevelPackages = _getUserPackageTopLevels()
-
-    # get the top-levels associated with the package we want to uninstall
-    pkgTopLevelDirs = allTopLevelPackages[metaDir].copy()
-    del allTopLevelPackages[metaDir]  # remove from mapping
-
-    # Check which top-level directories are safe to remove if they are not used
-    # by other packages.
-    toRemove = []
-    for pkgTopLevel in pkgTopLevelDirs:
-        safeToRemove = True
-        for otherPkg, otherTopLevels in allTopLevelPackages.items():
-            if pkgTopLevel in otherTopLevels:
-                # check if another version of this package is sharing the dir
-                if otherPkg.startswith(pathHead):
-                    msg = (
-                        'Found metadata for an older version of package `{}` in '
-                        '`{}`. This will also be removed.'
-                    ).format(pkgName, otherPkg)
-                    logging.warning(msg)
-                    stdout += msg + "\n"
-                    toRemove.append(otherPkg)
-                else:
-                    # unrelated package
-                    msg = (
-                        'Found matching top-level directory `{}` in metadata '
-                        'for `{}`. Can not safely remove this directory since '
-                        'another package appears to use it.'
-                    ).format(pkgTopLevel, otherPkg)
-                    logging.warning(msg)
-                    stdout += msg + "\n"
-                    safeToRemove = False
-                    break
-
-        if safeToRemove:
-            toRemove.append(pkgTopLevel)
-
-    # delete modules from the paths we found
-    for rmDir in toRemove:
-        if os.path.isfile(rmDir):
-            msg = (
-                'Removing file `{}` from user package directory.'
-            ).format(rmDir)
-            logging.info(msg)
-            stdout += msg + "\n"
-            os.remove(rmDir)
-        elif os.path.isdir(rmDir):
-            msg = (
-                'Removing directory `{}` from user package '
-                'directory.'
-            ).format(rmDir)
-            logging.info(msg)
-            stdout += msg + "\n"
-            shutil.rmtree(rmDir)
-
-    # cleanup by also deleting the metadata path
-    shutil.rmtree(metaPath)
-
+    # get distribution object
+    thisPkg = importlib.metadata.distribution(package)
+    # iterate through its files
+    for file in thisPkg.files:
+        # get absolute path (not relative to package dir)
+        absPath = thisPkg.locate_file(file)
+        # skip pycache
+        if absPath.stem == "__pycache__":
+            continue
+        # delete file
+        if absPath.is_file():
+            try:
+                absPath.unlink()
+            except PermissionError as err:
+                stdout += _translate(
+                    "Could not remove {absPath}, reason: {err}".format(absPath=absPath, err=err)
+                )
+        # skip pycache
+        if absPath.parent.stem == "__pycache__":
+            continue
+        # delete folder if empty
+        if absPath.parent.is_dir() and not [f for f in absPath.parent.glob("*")]:
+            # delete file
+            try:
+                absPath.parent.unlink()
+            except PermissionError as err:
+                stdout += _translate(
+                    "Could not remove {absPath}, reason: {err}".format(absPath=absPath, err=err)
+                )
+    
+    # log success
     msg = 'Uninstalled package `{}`.'.format(package)
     logging.info(msg)
     stdout += msg + "\n"
-
-    # Return the return code and a dict of information from the console
+    
+    # return the return code and a dict of information from the console
     return True, {
         "cmd": cmd,
         "stdout": stdout,
-        "stderr": ""}
-
+        "stderr": ""
+    }
 
 def uninstallPackage(package):
     """Uninstall a package from the current distribution.
@@ -437,7 +460,6 @@ def uninstallPackage(package):
 
         # setup the environment to use the user's site-packages
         env = os.environ.copy()
-        env["PYTHONUSERBASE"] = site.USER_BASE
 
         # run command in subprocess
         output = sp.Popen(
@@ -505,10 +527,16 @@ def getInstalledPackages():
     """
     # this is like calling `pip freeze` and parsing the output, but faster!
     installedPackages = []
-    for pkg in pkg_resources.working_set:
-        thisPkg = pkg_resources.get_distribution(pkg.key)
+    for dist in importlib.metadata.distributions(path=[USER_PACKAGES_PATH]):
+        # substitute name if using 3.8
+        if sys.version.startswith("3.8"):
+            distName = dist.metadata['name']
+        else:
+            distName = dist.name
+        # get name and version
         installedPackages.append(
-            (thisPkg.project_name, thisPkg.version))
+            (distName, dist.version)
+        )
 
     return installedPackages
 
@@ -523,7 +551,7 @@ def isInstalled(packageName):
 
     """
     # installed packages are given as keys in the resulting dicts
-    return pkg_resources.safe_name(packageName) in _installedPackageNamesCache
+    return packageName in _installedPackageNamesCache
 
 
 def getPackageMetadata(packageName):
@@ -544,16 +572,11 @@ def getPackageMetadata(packageName):
     import email.parser
 
     try:
-        dist = pkg_resources.get_distribution(packageName)
-    except pkg_resources.DistributionNotFound:
+        dist = importlib.metadata.distribution(packageName)
+    except importlib.metadata.PackageNotFoundError:
         return  # do nothing
 
-    metadata = dist.get_metadata(dist.PKG_INFO)
-
-    # parse the metadata using
-    metadict = dict()
-    for key, val in email.message_from_string(metadata).raw_items():
-        metadict[key] = val
+    metadict = dict(dist.metadata)
 
     return metadict
 

psychopy/tools/versionchooser.py

@@ -17,7 +17,7 @@ import psychopy  # for currently loaded version
 from psychopy import prefs
 # the following will all have been imported so import here and reload later
 from psychopy import logging, tools, web, constants, preferences, __version__
-from pkg_resources import parse_version
+from packaging.version import Version
 from importlib import reload
 from packaging.version import Version, InvalidVersion, VERSION_PATTERN
 
@@ -194,7 +194,7 @@ def getPsychoJSVersionStr(currentVersion, preferredVersion=''):
 
     # do we shorten minor versions ('3.4.2' to '3.4')?
     # only from 3.2 onwards
-    if (parse_version('3.2')) <= parse_version(useVerStr) < parse_version('2021') \
+    if (Version('3.2')) <= Version(useVerStr) < Version('2021') \
             and len(useVerStr.split('.')) > 2:
         # e.g. 2020.2 not 2021.2.5
         useVerStr = '.'.join(useVerStr.split('.')[:2])
@@ -385,9 +385,9 @@ def versionOptions(local=True):
     majorMinor = sorted(
         list({'.'.join(v.split('.')[:2])
               for v in availableVersions(local=local)}),
-        key=parse_version, 
+        key=Version, 
         reverse=True)
-    major = sorted(list({v.split('.')[0] for v in majorMinor}), key=parse_version, reverse=True)
+    major = sorted(list({v.split('.')[0] for v in majorMinor}), key=Version, reverse=True)
     special = ['latest']
     return special + major + majorMinor
 
@@ -402,7 +402,7 @@ def _localVersions(forceCheck=False):
             tagInfo = subprocess.check_output(cmd.split(), cwd=VERSIONSDIR,
                                               env=constants.ENVIRON).decode('UTF-8')
             allTags = tagInfo.splitlines()
-            _localVersionsCache = sorted(allTags, key=parse_version, reverse=True)
+            _localVersionsCache = sorted(allTags, key=Version, reverse=True)
     return _localVersionsCache
 
 
@@ -421,7 +421,7 @@ def _remoteVersions(forceCheck=False):
                        for line in tagInfo.decode().splitlines()
                        if '^{}' not in line]
             # ensure most recent (i.e., highest) first
-            _remoteVersionsCache = sorted(allTags, key=parse_version, reverse=True)
+            _remoteVersionsCache = sorted(allTags, key=Version, reverse=True)
     return _remoteVersionsCache
 
 
@@ -443,19 +443,19 @@ def _versionFilter(versions, wxVersion):
     # logging.info(msg)
     versions = [ver for ver in versions
                 if ver == 'latest'
-                or parse_version(ver) >= parse_version('1.90')
+                or Version(ver) >= Version('1.90')
                 and len(ver) > 1]
 
     # Get WX Compatibility
     compatibleWX = '4.0'
-    if wxVersion is not None and parse_version(wxVersion) >= parse_version(compatibleWX):
+    if wxVersion is not None and Version(wxVersion) >= Version(compatibleWX):
         # msg = _translate("wx version: {}. Filtering versions of "
         #                  "PsychoPy only compatible with wx >= version {}".format(wxVersion,
         #                                                                       compatibleWX))
         # logging.info(msg)
         return [ver for ver in versions
                 if ver == 'latest'
-                or parse_version(ver) > parse_version('1.85.04')
+                or Version(ver) > Version('1.85.04')
                 and len(ver) > 1]
     return versions
 
@@ -474,7 +474,7 @@ def availableVersions(local=True, forceCheck=False):
             return sorted(
                 list(set([psychopy.__version__] + _localVersions(forceCheck) + _remoteVersions(
                     forceCheck))),
-                key=parse_version,
+                key=Version,
                 reverse=True)
     except subprocess.CalledProcessError:
         return []

psychopy/tools/wizard.py

@@ -17,9 +17,9 @@ import wx
 import numpy as np
 import platform
 import codecs
-from pkg_resources import parse_version
+from packaging.version import Version
 
-if parse_version(wx.__version__) < parse_version('2.9'):
+if Version(wx.__version__) < Version('2.9'):
     tmpApp = wx.PySimpleApp()
 else:
     tmpApp = wx.App(False)
@@ -88,7 +88,7 @@ class BaseWizard():
             'prefs.html#application-settings-app">Preferences -> App</a>')
         report.append(('locale', items['systemLocale'], msg, False))
         msg = ''
-        v = parse_version
+        v = Version
         thisV = v(items['pythonVersion'])
         if (thisV < v('2.7') or (v('3.0') <= thisV < v('3.6'))
             ):

psychopy/visual/backends/pygletbackend.py

@@ -179,20 +179,27 @@ class PygletBackend(BaseBackend):
                     'integer greater than two. Disabling.')
                 win.multiSample = False
 
+        skip_screen_warn = False
         if platform.system() == 'Linux':
-            display = pyglet.canvas.Display()
+            from pyglet.canvas.xlib import NoSuchDisplayException
+            try:
+                display = pyglet.canvas.Display(x_screen=win.screen)
+                # in this case, we'll only get a single x-screen back
+                skip_screen_warn = True
+            except NoSuchDisplayException:
+                # Maybe xinerama? Try again and get the specified screen later
+                display = pyglet.canvas.Display(x_screen=0)
+
             allScrs = display.get_screens()
         else:
-            if pyglet.version < '1.4':
-                allScrs = _default_display_.get_screens()
-            else:
-                allScrs = _default_display_.get_screens()
+            allScrs = _default_display_.get_screens()
 
-        # Screen (from Exp Settings) is 1-indexed,
+        # Screen (from Exp Settings) is 0-indexed,
         # so the second screen is Screen 1
         if len(allScrs) < int(win.screen) + 1:
-            logging.warn("Requested an unavailable screen number - "
-                         "using first available.")
+            if not skip_screen_warn:
+                logging.warn("Requested an unavailable screen number - "
+                             "using first available.")
             thisScreen = allScrs[0]
         else:
             thisScreen = allScrs[win.screen]
@@ -247,7 +254,7 @@ class PygletBackend(BaseBackend):
             self.winHandle = pyglet.window.Window(
                 width=w, height=h,
                 caption="PsychoPy",
-                fullscreen=self._isFullScr,
+                fullscreen=win._isFullScr,
                 config=config,
                 screen=thisScreen,
                 style=style)
@@ -258,8 +265,12 @@ class PygletBackend(BaseBackend):
                 "graphics card and/or graphics drivers.")
         try:
             icns = [
-                pyglet.image.load(prefs.paths['resources'] + os.sep + "Psychopy Window Favicon@16w.png"),
-                pyglet.image.load(prefs.paths['resources'] + os.sep + "Psychopy Window Favicon@32w.png"),
+                pyglet.image.load(
+                    prefs.paths['assets'] + os.sep + "Psychopy Window Favicon@16w.png"
+                ),
+                pyglet.image.load(
+                    prefs.paths['assets'] + os.sep + "Psychopy Window Favicon@32w.png"
+                ),
             ]
             self.winHandle.set_icon(*icns)
         except BaseException:
@@ -347,8 +358,8 @@ class PygletBackend(BaseBackend):
                                         int(win.pos[1] + thisScreen.y))
 
         try:  # to load an icon for the window
-            iconFile = os.path.join(psychopy.prefs.paths['resources'],
-                                    'psychopy.ico')
+            iconFile = os.path.join(psychopy.prefs.paths['assets'],
+                                    'window.ico')
             icon = pyglet.image.load(filename=iconFile)
             self.winHandle.set_icon(icon)
         except Exception: