forked from qt-creator/qt-creator
431b0c314a
Update the other Python tutorials to describe setting up PySide6 for a project. Change-Id: Ia0a13f41c1f270fa0ec6c1445f1546e884b7e78f Reviewed-by: David Schulz <david.schulz@qt.io>
115 lines
4.6 KiB
Plaintext
115 lines
4.6 KiB
Plaintext
// Copyright (C) 2023 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
|
|
|
/*!
|
|
\page creator-python-development.html
|
|
\previouspage creator-how-tos.html
|
|
|
|
\ingroup creator-how-to-projects
|
|
|
|
\title Develop Qt for Python applications
|
|
|
|
With \l {https://doc.qt.io/qtforpython/index.html}{Qt for Python}, you can
|
|
use Qt 6 API in Python applications. Use the PySide6 modules to gain access
|
|
to individual Qt modules, such as \l {Qt Core}, \l {Qt GUI}, and
|
|
\l {Qt Widgets}.
|
|
|
|
The following sections describe using \QC for developing with Qt for Python:
|
|
|
|
\list
|
|
\li \l{Set up PySide6}
|
|
\li \l{Create Qt for Python applications}
|
|
\li \l{Select the Python version}
|
|
\li \l{Create kits for Python}
|
|
\li \l{Use Python interactive shell}
|
|
\li \l{Configure Python language servers}
|
|
\li \l{Run Python applications}
|
|
\li \l{Python Run Settings}
|
|
\li \l{PDB versions}
|
|
\li \l{Supported Debuggers}
|
|
\endlist
|
|
|
|
For more information about developing with Qt for Python, including
|
|
limitations, see \l {https://doc.qt.io/qtforpython/index.html}
|
|
{Qt for Python}.
|
|
|
|
\section1 Set up PySide6
|
|
|
|
The recommended way to run PySide6 projects from \QC is to install PySide6
|
|
for each project. \QC prompts you to do so the first time you open a .py file
|
|
for a project.
|
|
|
|
\image qtcreator-python-install.webp {Prompts to install PySide6 and Python language server}
|
|
|
|
Further, \QC prompts you to install the \l {Configure Python language servers}
|
|
{Python language server} that offers services such as code completion
|
|
and annotations. Select \uicontrol Install to install PySide6 and the
|
|
language server.
|
|
|
|
\section1 Create Qt for Python applications
|
|
|
|
Use wizards to create Qt for Python application projects. The wizards
|
|
generate a project file, \c {.pyproject}, that lists the files in the Python
|
|
project. They also generate a \c {.py} file that has some boilerplate code
|
|
and \c {reguirements.txt} that stores the PySide version of the generated code.
|
|
In addition, the widget-based UI wizard creates a \c {.ui} file that has a
|
|
\QD form, and the Qt Quick Application wizard creates a \c {.qml} file that
|
|
imports Qt Quick controls.
|
|
|
|
The \uicontrol Window wizard adds code to the source file, without the UI
|
|
file.
|
|
|
|
The \uicontrol Empty wizard adds code to the source file, but it
|
|
does not add any classes, so you need to add and instantiate them yourself.
|
|
|
|
The \c{.pyproject} files are JSON-based configuration files that replace
|
|
the previously used \c {.pyqtc} configuration files. You can still open and
|
|
use \c {.pyqtc} files, but we recommend that you choose \c{.pyproject} files
|
|
for new projects.
|
|
|
|
\section1 Select the Python version
|
|
|
|
The \l{Kits}{kits} you select for the project in \uicontrol Projects >
|
|
\uicontrol {Build & Run} set the Python version to use.
|
|
|
|
The \l {Edit Mode}{Edit mode} toolbar shows the current Python version.
|
|
|
|
\image qtcreator-python-interpreter-edit-mode.webp {Python version on the Edit mode toolbar}
|
|
|
|
To use another Python version, activate another kit for the project.
|
|
|
|
\section1 Create kits for Python
|
|
|
|
\QC automatically adds all Python versions it can find to the list of
|
|
Python versions in \preferences > \uicontrol Python > \uicontrol Interpreters.
|
|
It generates kits for the global Python versions that are not inside a
|
|
virtual environment.
|
|
|
|
\image qtcreator-python-interpreters.webp {Python Interpreters in Preferences}
|
|
|
|
You can add and remove Python versions and clean up references to Python
|
|
versions that you uninstalled, but that still appear in the list.
|
|
|
|
To use the selected Python version when opening \c {.py} files that don't
|
|
belong to a project, select \uicontrol {Make Default}.
|
|
|
|
To use a virtual environment as a kit, select it in \uicontrol Interpreters,
|
|
and then select \uicontrol {Generate Kit}.
|
|
|
|
\section1 Use Python interactive shell
|
|
|
|
You can write Python code in the \uicontrol Edit mode. Select \uicontrol REPL
|
|
on the toolbar to start the \l{https://pythonprogramminglanguage.com/repl/}
|
|
{Python interactive shell} in the \l Terminal view.
|
|
|
|
\image qtcreator-terminal-python.webp {Python shell in the Terminal view}
|
|
|
|
To start the shell and import the current file as a module, select
|
|
\uicontrol {REPL Import File}. To also import all functions from
|
|
the file, select \uicontrol {REPL Import *}.
|
|
|
|
\sa {Tutorial: Qt Widgets and Python}, {Tutorial: Qt Widgets UI and Python},
|
|
{Tutorial: Qt Quick and Python},
|
|
{Activate kits for a project}
|
|
*/
|