psychopy 2025.2.4__py3-none-any.whl

psychopy/app/psychopyApp.py

@@ -0,0 +1,207 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Part of the PsychoPy library
+# 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 argparse
+from pathlib import Path
+import sys
+
+# fix macOS locale-bug on startup: sets locale to LC_ALL (must be defined!)
+import psychopy.locale_setup  # noqa
+
+
+# NB the PsychoPyApp classes moved to _psychopyApp.py as of version 1.78.00
+# to allow for better upgrading possibilities from the mac app bundle. this
+# file now used solely as a launcher for the app, not as the app itself.
+
+
+def main():
+    # parser to process input arguments
+    argParser = argparse.ArgumentParser(
+        prog="PsychoPyApp", description=(
+"""Starts the PsychoPy application.
+
+Usage:  python psychopy.app [options] [files]
+
+Without options or files provided this starts PsychoPy using prefs to
+decide on the view(s) to open.  If optional [files] is provided action
+depends on the type of the [files]:
+
+ Python script 'file.py' -- opens coder
+
+ Experiment design 'file.psyexp' -- opens builder
+ """
+        )
+    )
+    # first argument is always the calling script
+    argParser.add_argument("callscript")
+    # recognise version query
+    argParser.add_argument(
+        "--version", "-v", dest="version", action="store_true", help=(
+        "Print the current PsychoPy version."
+    ))
+    # add option to directly run a script
+    argParser.add_argument(
+        "--direct", "-x", dest="direct", action="store_true", help=(
+            "Use PsychoPy to run a Python script (.py) or a PsychoPy experiment (.psyexp), without "
+            "opening the app."
+        )
+    )
+    # add options for starting view
+    argParser.add_argument(
+        "--builder", "-b", dest="startView", const="builder", action="append_const", help=(
+            "Open PsychoPy with a Builder window open. Combine with --coder/-c and --runner/-r "
+            "to open a specific set of frames."
+        )
+    )
+    argParser.add_argument(
+        "--coder", "-c", dest="startView", const="coder", action="append_const", help=(
+            "Open PsychoPy with the Coder window open. Combine with --builder/-b and --runner/-r "
+            "to open a specific set of frames."
+        )
+    )
+    argParser.add_argument(
+        "--runner", "-r", dest="startView", const="runner", action="append_const", help=(
+            "Open PsychoPy with the Runner window open. Combine with --coder/-c and --builder/-b "
+            "to open a specific set of frames."
+        )
+    )
+    # add option to show config wizard
+    argParser.add_argument(
+        "--firstrun", dest="firstRun", action="store_true", help=(
+            "Launches configuration wizard"
+        )
+    )
+    # add option to hide splash
+    argParser.add_argument(
+        "--no-splash", dest="showSplash", action="store_false", default=None, help=(
+            "Suppresses splash screen"
+        )
+    )
+    # add option to include app profiling
+    argParser.add_argument(
+        "--profiling", dest="profiling", action="store_true", help=(
+            "Launches app with profiling to see what specific processes are taking up resources."
+        )
+    )
+    # add option to supply custom user directory
+    argParser.add_argument(
+        "--user-dir", dest="userDir", action="store", help=(
+            "Launches app with a custom location for the prefs folder."
+        )
+    )
+    # parse args
+    args, startFilesRaw = argParser.parse_known_args(sys.argv)
+
+    # import app and prefs now that args have been parsed
+    from psychopy.preferences import prefs
+    from psychopy.app import startApp, quitApp
+    # setup prefs
+    prefs.loadAll(userDir=args.userDir)
+    # insert fallbacks from prefs for unsupplied call args
+    if args.showSplash is None:
+        args.showSplash = prefs.app['showSplash']
+    # pathify startFiles
+    startFiles = None
+    for thisFile in startFilesRaw:
+        if startFiles is None:
+            startFiles = []
+        try:
+            startFiles.append(Path(thisFile))
+        except:
+            print(
+                "Could not interpret {} as a path.".format(thisFile)
+            )
+            continue
+
+    # run files directly if requested
+    if args.direct:
+        from psychopy import core
+        import os
+        # make sure there's a file to run
+        assert startFiles, (
+            "Argument -x was used to directly run a script or experiment, but no script or "
+            "experiment path was given."
+        )
+        # run all .py scripts from the command line using StandAlone python
+        for targetScript in startFiles:
+            # skip non-runnable files
+            if targetScript.suffix not in (".psyexp", ".py"):
+                print(
+                    "Could not run file '{}' as it is not a Python script or PsychoPy experiment."
+                    .format(targetScript)
+                )
+                continue
+            # compile Python code if given a psyexp
+            if targetScript.suffix == ".psyexp":
+                from psychopy import experiment
+                exp = experiment.Experiment.fromFile(targetScript)
+                script = exp.writeScript()
+                targetScript = targetScript.parent / (targetScript.stem + ".py")
+                targetScript.write_text(script, encoding="utf-8")
+            # run file
+            stderr = core.shellCall([sys.executable, targetScript.absolute()], stderr=True)
+            for line in stderr:
+                print(line)
+        sys.exit()
+    # print version info if requested
+    if '-v' in sys.argv or '--version' in sys.argv:
+        from psychopy import __version__
+        msg = ('PsychoPy3, version %s (c)Jonathan Peirce 2018, GNU GPL license'
+               % __version__)
+        print(msg)
+        sys.exit()
+
+    if (sys.platform == 'darwin' and
+            ('| packaged by conda-forge |' in sys.version or
+             '|Anaconda' in sys.version)):
+
+        # On macOS with Anaconda, GUI applications used to need to be run using
+        # `pythonw`. Since we have no way to determine whether this is currently
+        # the case, we run this script again -- ensuring we're definitely using
+        # pythonw.
+        import os
+        env = os.environ
+        PYTHONW = env.get('PYTHONW', 'False')
+        pyw_exe = sys.executable + 'w'
+
+        # Updated 2024.1.6: as of Python 3, `pythonw` and `python` can be used
+        # interchangeably for wxPython applications on macOS with GUI support.
+        # The defaults and conda-forge channels no longer install python with a
+        # framework build (to do so: `conda install python=3.8 python.app`).
+        # Therefore `pythonw` often doesn't exist, and we can just use `python`.
+        if PYTHONW != 'True' and os.path.isfile(pyw_exe):
+            from psychopy import core
+            cmd = [pyw_exe] + sys.argv
+
+            stdout, stderr = core.shellCall(cmd,
+                                            env=dict(env, PYTHONW='True'),
+                                            stderr=True)
+            print(stdout, file=sys.stdout)
+            print(stderr, file=sys.stderr)
+            sys.exit()
+        else:
+            startApp(
+                startView=args.startView, 
+                showSplash=args.showSplash, 
+                startFiles=startFiles,
+                firstRun=args.firstRun,
+                profiling=args.profiling
+            )
+    else:
+        # start app
+        _ = startApp(
+            startView=args.startView, 
+            showSplash=args.showSplash, 
+            startFiles=startFiles,
+            firstRun=args.firstRun,
+            profiling=args.profiling
+        )
+        quitApp()
+
+
+if __name__ == '__main__':
+    main()