Qt for Python 入门 ¶

一般要求 ¶

• Python ：3.5+ 和 2.7

• Qt: 推荐 5.12+

• libclang: libclang 库，推荐：PySide2 5.12 第 6 版。预建版本可以从 这里下载 .

• CMake: 需要 3.1+。

每平台指南 ¶

可以参考以下特定平台指导页面：

• Windows

• macOS

• Linux

• 移动平台 (iOS/Android) (不支持)

• 嵌入式平台 (没有官方支持)

  注意

  大多数基于 Linux 的嵌入式 OS 为 PySide2 提供官方包管理器 (如 Raspbian and ArchlinuxARM ).

正常构建命令看起来像这样：

python setup.py install --qmake=/path/to/qmake \
                        --ignore-git \
                        --debug \
                        --build-tests \
                        --parallel=8 \
                        --make-spec=ninja \
                        --verbose-build \
                        --module-subset=Core,Gui,Widgets
									

当构建和安装工程采用 debug 符号时，要包括 tests ，使用 ninja (而不是 make)，并只考虑 模块子集 的 QtCore、QtGUI 及 QtWidgets。

要考虑的其它重要选项：

• --cmake 指定 CMake 二进制文件路径，

• --reuse-build 仅重构修改文件，

• --openssl=/path/to/openssl/bin ，使用不同 OpenSSL 路径，

• --standalone 将 Qt 库复制到最终包中，使其能够在其它机器上工作，

• --doc-build-online 使用在线模板构建文档编制。

测试安装 ¶

一旦安装完成，就能执行任何范例：

python examples/widgets/widgets/tetrix.py
									

运行测试 ¶

使用 --build-tests 选项使我们能够在工程内运行所有自动测试：

python testrunner.py test > testlog.txt
									

还可以运行特定测试 (例如 qpainter_test ) 通过运行：

ctest -R qpainter_test --verbose
									

构建文档编制 ¶

要生成文档编制使用 qdoc 以获取 API 信息，及 sphinx 对于本地 Python 相关注意事项。

系统需要 libxml2 and libxslt ，及 Python 环境中， sphinx and graphviz 需要在运行安装进程之前安装：

pip install graphviz sphinx
									

之后安装 graphviz ， dot 命令需要位于 PATH 中，否则，进程将失败。安装 graphviz system-wide is also an option.

Since the process rely on a Qt installation, you need to specify where the qtbase directory you will use with your qmake is located:

export QT_SRC_DIR=/path/to/qtbase
									

Once the build process finishes, you can go to the generated *_build/*_release/pyside2 directory, and run:

make apidoc
									

Finally, you will get a html directory containing all the generated documentation. The offline help files, PySide.qch and Shiboken.qch , can be moved to any directory of your choice. You can find Shiboken.qch in the build directory, *_build\*_release\shiboken2\doc\html .

使用内部工具 ¶

A set of tools can be found under the tools/ directory inside the pyside-setup repository.

• checklibs.py : Script to analyze dynamic library dependencies of Mach-O binaries. To use this utility, just run:

  python checklibs.py /path/to/some.app/Contents/MacOS/Some
  											

  This script was fetched from this repository .

• create_changelog.py : Script used to create the CHANGELOG that you can find in the dist/ directory. Usage:

  python create_changelog.py -r 5.14.1 -v v5.14.0..5.14 -t bug-fix
  											

• debug_windows.py : This script can be used to find out why PySide2 modules fail to load with various DLL errors like Missing DLL or Missing symbol in DLL.

  You can think of it as a Windows version of ldd / LD_DEBUG .

  Underneath it uses the cdb.exe command line debugger, and the gflags.exe tool, both installed with the latest Windows Kit.

  The aim is to ask users to run this script when they encounter PySide2 imports not working on Windows. The user should then provide the generated log file.

  Incidentally it can also be used for any Windows executables, not just Python. To use it just run:

  python debug_windows.py
  											

• missing_bindings.py : This script is used to compare the state of PySide2 and PyQt5 regarding available modules and classses. This content is displayed in our wiki page , and can be used as follows:

  python missing_bindings.py --qt-version 5.14.1 -w all
  											

  Please keep in mind we rely on BeautifulSoup to parse the content, so you will be to install it besides PySide2 and PyQt5 (Including additional modules like DataVisualiztion, QtCharts, WebEngine, etc).