diff options
Diffstat (limited to 'sources/pyside-tools/pyside_tool.py')
-rw-r--r-- | sources/pyside-tools/pyside_tool.py | 267 |
1 files changed, 200 insertions, 67 deletions
diff --git a/sources/pyside-tools/pyside_tool.py b/sources/pyside-tools/pyside_tool.py index d4f283bfc..b369be8a2 100644 --- a/sources/pyside-tools/pyside_tool.py +++ b/sources/pyside-tools/pyside_tool.py @@ -1,51 +1,41 @@ #!/usr/bin/env python -# -*- coding: utf-8 -*- -############################################################################# -## -## Copyright (C) 2020 The Qt Company Ltd. -## Contact: https://www.qt.io/licensing/ -## -## This file is part of Qt for Python. -## -## $QT_BEGIN_LICENSE:LGPL$ -## Commercial License Usage -## Licensees holding valid commercial Qt licenses may use this file in -## accordance with the commercial license agreement provided with the -## Software or, alternatively, in accordance with the terms contained in -## a written agreement between you and The Qt Company. For licensing terms -## and conditions see https://www.qt.io/terms-conditions. For further -## information use the contact form at https://www.qt.io/contact-us. -## -## GNU Lesser General Public License Usage -## Alternatively, this file may be used under the terms of the GNU Lesser -## General Public License version 3 as published by the Free Software -## Foundation and appearing in the file LICENSE.LGPL3 included in the -## packaging of this file. Please review the following information to -## ensure the GNU Lesser General Public License version 3 requirements -## will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -## -## GNU General Public License Usage -## Alternatively, this file may be used under the terms of the GNU -## General Public License version 2.0 or (at your option) the GNU General -## Public license version 3 or any later version approved by the KDE Free -## Qt Foundation. The licenses are as published by the Free Software -## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -## included in the packaging of this file. Please review the following -## information to ensure the GNU General Public License requirements will -## be met: https://www.gnu.org/licenses/gpl-2.0.html and -## https://www.gnu.org/licenses/gpl-3.0.html. -## -## $QT_END_LICENSE$ -## -############################################################################# -import sys +# Copyright (C) 2022 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +import importlib import os -from pathlib import Path import subprocess +import sys +import sysconfig +from pathlib import Path -from subprocess import Popen, PIPE import PySide6 as ref_mod +VIRTUAL_ENV = "VIRTUAL_ENV" + + +def is_pyenv_python(): + pyenv_root = os.environ.get("PYENV_ROOT") + + if pyenv_root: + resolved_exe = Path(sys.executable).resolve() + if str(resolved_exe).startswith(pyenv_root): + return True + + return False + + +def is_virtual_env(): + return sys.prefix != sys.base_prefix + + +def init_virtual_env(): + """PYSIDE-2251: Enable running from a non-activated virtual environment + as is the case for Visual Studio Code by setting the VIRTUAL_ENV + variable which is used by the Qt Designer plugin.""" + if is_virtual_env() and not os.environ.get(VIRTUAL_ENV): + os.environ[VIRTUAL_ENV] = sys.prefix + def main(): # This will take care of "pyside6-lupdate" listed as an entrypoint @@ -56,54 +46,197 @@ def main(): sys.exit(subprocess.call(command)) -def qt_tool_wrapper(qt_tool, args): +def qt_tool_wrapper(qt_tool, args, libexec=False): # Taking care of pyside6-uic, pyside6-rcc, and pyside6-designer # listed as an entrypoint in setup.py - pyside_dir = os.path.dirname(ref_mod.__file__) - exe = os.path.join(pyside_dir, qt_tool) - - cmd = [exe] + args - proc = Popen(cmd, stderr=PIPE) - out, err = proc.communicate() - if err: - msg = err.decode("utf-8") + pyside_dir = Path(ref_mod.__file__).resolve().parent + if libexec and sys.platform != "win32": + exe = pyside_dir / 'Qt' / 'libexec' / qt_tool + else: + exe = pyside_dir / qt_tool + + cmd = [os.fspath(exe)] + args + returncode = subprocess.call(cmd) + if returncode != 0: command = ' '.join(cmd) - print(f"Error: {msg}\nwhile executing '{command}'") - sys.exit(proc.returncode) + print(f"'{command}' returned {returncode}", file=sys.stderr) + sys.exit(returncode) + + +def pyside_script_wrapper(script_name): + """Launch a script shipped with PySide.""" + script = Path(__file__).resolve().parent / script_name + command = [sys.executable, os.fspath(script)] + sys.argv[1:] + sys.exit(subprocess.call(command)) + + +def ui_tool_binary(binary): + """Return the binary of a UI tool (App bundle on macOS).""" + if sys.platform != "darwin": + return binary + name = binary[0:1].upper() + binary[1:] + return f"{name}.app/Contents/MacOS/{name}" + + +def lrelease(): + qt_tool_wrapper("lrelease", sys.argv[1:]) + + +def lupdate(): + qt_tool_wrapper("lupdate", sys.argv[1:]) def uic(): - qt_tool_wrapper("uic", ['-g', 'python'] + sys.argv[1:]) + qt_tool_wrapper("uic", ['-g', 'python'] + sys.argv[1:], True) def rcc(): - qt_tool_wrapper("rcc", ['-g', 'python'] + sys.argv[1:]) + args = [] + user_args = sys.argv[1:] + if "--binary" not in user_args: + args.extend(['-g', 'python']) + args.extend(user_args) + qt_tool_wrapper("rcc", args, True) + + +def qmltyperegistrar(): + qt_tool_wrapper("qmltyperegistrar", sys.argv[1:], True) + +def qmlimportscanner(): + qt_tool_wrapper("qmlimportscanner", sys.argv[1:], True) -def _append_to_path_var(var, value): + +def qmlcachegen(): + qt_tool_wrapper("qmlcachegen", sys.argv[1:], True) + + +def qmllint(): + qt_tool_wrapper("qmllint", sys.argv[1:]) + + +def qmlformat(): + qt_tool_wrapper("qmlformat", sys.argv[1:]) + + +def qmlls(): + qt_tool_wrapper("qmlls", sys.argv[1:]) + + +def assistant(): + qt_tool_wrapper(ui_tool_binary("assistant"), sys.argv[1:]) + + +def _extend_path_var(var, value, prepend=False): env_value = os.environ.get(var) if env_value: - env_value = f'{env_value}{os.pathsep}{value}' + env_value = (f'{value}{os.pathsep}{env_value}' + if prepend else f'{env_value}{os.pathsep}{value}') else: env_value = value os.environ[var] = env_value def designer(): - # Add the examples to PYSIDE_DESIGNER_PLUGINS, as determined by starting from - # PySide6/scripts. + init_virtual_env() + + # https://www.python.org/dev/peps/pep-0384/#linkage : + # "On Unix systems, the ABI is typically provided by the python executable + # itself", that is, libshiboken does not link against any Python library + # and expects to get these symbols from a python executable. Since no + # python executable is involved when loading this plugin, pre-load python.so + # This should also help to work around a numpy issue, see + # https://stackoverflow.com/questions/49784583/numpy-import-fails-on-multiarray-extension-library-when-called-from-embedded-pyt + major_version = sys.version_info[0] + minor_version = sys.version_info[1] + os.environ['PY_MAJOR_VERSION'] = str(major_version) + os.environ['PY_MINOR_VERSION'] = str(minor_version) + if sys.platform == 'linux': + # Determine library name (examples/utils/pyside_config.py) + version = f'{major_version}.{minor_version}' + library_name = f'libpython{version}{sys.abiflags}.so' + if is_pyenv_python(): + library_name = str(Path(sysconfig.get_config_var('LIBDIR')) / library_name) + os.environ['LD_PRELOAD'] = library_name + elif sys.platform == 'darwin': + library_name = sysconfig.get_config_var("LDLIBRARY") + framework_prefix = sysconfig.get_config_var("PYTHONFRAMEWORKPREFIX") + lib_path = None + if framework_prefix: + lib_path = os.fspath(Path(framework_prefix) / library_name) + elif is_pyenv_python(): + lib_path = str(Path(sysconfig.get_config_var('LIBDIR')) / library_name) + else: + # ideally this should never be reached because the system Python and Python installed + # from python.org are all framework builds + print("Unable to find Python library directory. Use a framework build of Python.", + file=sys.stderr) + sys.exit(0) + os.environ['DYLD_INSERT_LIBRARIES'] = lib_path + elif sys.platform == 'win32': + # Find Python DLLs from the base installation + if is_virtual_env(): + _extend_path_var("PATH", os.fspath(Path(sys._base_executable).parent), True) + + qt_tool_wrapper(ui_tool_binary("designer"), sys.argv[1:]) + + +def linguist(): + qt_tool_wrapper(ui_tool_binary("linguist"), sys.argv[1:]) + + +def genpyi(): pyside_dir = Path(__file__).resolve().parents[1] + support = pyside_dir / "support" + cmd = support / "generate_pyi.py" + command = [sys.executable, os.fspath(cmd)] + sys.argv[1:] + sys.exit(subprocess.call(command)) + + +def metaobjectdump(): + pyside_script_wrapper("metaobjectdump.py") - # Add the Wiggly Widget example - wiggly_dir = os.fspath(pyside_dir / 'examples' / 'widgetbinding') - _append_to_path_var('PYSIDE_DESIGNER_PLUGINS', wiggly_dir) - taskmenu_dir = os.fspath(pyside_dir / 'examples' / 'designer' / 'taskmenuextension') - _append_to_path_var('PYSIDE_DESIGNER_PLUGINS', taskmenu_dir) - if sys.platform == "darwin": - qt_tool_wrapper("Designer.app/Contents/MacOS/Designer", sys.argv[1:]) +def project(): + pyside_script_wrapper("project.py") + + +def qml(): + pyside_script_wrapper("qml.py") + + +def qtpy2cpp(): + pyside_script_wrapper("qtpy2cpp.py") + + +def deploy(): + pyside_script_wrapper("deploy.py") + + +def android_deploy(): + if not sys.platform == "linux": + print("pyside6-android-deploy only works from a Linux host") else: - qt_tool_wrapper("designer", sys.argv[1:]) + android_requirements_file = Path(__file__).parent / "requirements-android.txt" + with open(android_requirements_file, 'r', encoding='UTF-8') as file: + while line := file.readline(): + dependent_package = line.rstrip() + if not bool(importlib.util.find_spec(dependent_package)): + command = [sys.executable, "-m", "pip", "install", dependent_package] + subprocess.run(command) + pyside_script_wrapper("android_deploy.py") + + +def qsb(): + qt_tool_wrapper("qsb", sys.argv[1:]) + + +def balsam(): + qt_tool_wrapper("balsam", sys.argv[1:]) + + +def balsamui(): + qt_tool_wrapper("balsamui", sys.argv[1:]) if __name__ == "__main__": |