Tutorial: Qt Quick and Python | Qt Creator Documentation
Description: How to develop a Qt Quick application with Python.

- Qt Creator Documentation
- Tutorial: Qt Quick and Python
- Qt Creator 19.0.1

Tutorial: Mobile application ◦ Tutorial: Qt Quick application

# Tutorial: Qt Quick and Python

First, create a Qt for Python application project. Then, edit the boilerplate code to develop a small application that uses Qt Quick to display the text Hello World in several languages.

For more examples of creating Qt for Python applications, see Qt for Python Examples and Tutorials.

## Create an empty project

To create a Qt for Python application that has a main QML file:

1. Go to File > New Project.
2. Select Application (Qt for Python) > Qt Quick Application - Empty > Choose to open the Project Location dialog.

3. In Name, enter the project name. For example, hello_world_quick.
4. In Create in, enter the path for the project files. For example, `C:\Examples`.
5. Select Next (on Windows and Linux) or Continue (on macOS) to open the Define Project Details dialog.

6. In PySide version, select the PySide version of the generated code.
7. Select Next or Continue to open the Kit Selection dialog.

8. Select Python kits for building, deploying, and running the project. By default, this creates a virtual environment for the project inside the source directory. To use the global interpreter, select the build configuration with the same name as the Python of the kit in Details.
9. Review the project settings, and select Finish (on Windows and Linux) or Done (on macOS) to create the project.

The wizard creates a subdirectory named after the project for a QML module of the same name and generates the following files:

- `pyproject.toml`, which lists the files in the Python project and other configurations.
- `main.py`, which has some boilerplate code.
- `<ProjectName>/Main.qml`, which imports Qt Quick controls.
- `<ProjectName>/qmldir`, declaring a QML module.
- `requirements.txt`, which stores the PySide version of the generated code. You can use this file to install the required PySide version using pip.

## Install PySide6 for the project

In the Edit mode, select Install to set up PySide6 for the project.

## Add Qt Quick imports

The wizard adds the following imports to the `main.py` source file for access to QGuiApplication and QQmlApplicationEngine:

     import sys
     from pathlib import Path

     from PySide6.QtGui import QGuiApplication
     from PySide6.QtQml import QQmlApplicationEngine

## Add a main function

The wizard also adds a main function, where it creates a QGuiApplication instance and passes system arguments to the QGuiApplication object:

     if __name__ == "__main__":
         app = QGuiApplication(sys.argv)
         ...

## Load the QML file

The following lines in the main class create a QQmlApplicationEngine instance and load the generated QML module to the engine object:

     ...
     engine = QQmlApplicationEngine()
     engine.addImportPath(Path(__file__).parent)
     engine.loadFromModule("ProjectName", "Main")
     ...

Finally, the wizard adds code that checks whether the file was successfully loaded. If loading the file fails, the application exits with an error code. If loading succeeds, the wizard calls the `app.exec()` method to enter the Qt main loop and start executing the Qt code:

     ...
     if not engine.rootObjects():
         sys.exit(-1)
     sys.exit(app.exec())
     ...

## Design the UI

Open the `Main.qml` file in the Edit mode to design a Qt Quick UI.

### Add imports

Add imports for Qt Quick Controls and Layouts:

     import QtQuick
     import QtQuick.Window
     import QtQuick.Controls
     import QtQuick.Layouts

### Add properties and functions

The wizard adds a main window:

     Window {
         width: 640
         height: 480
         visible: true
         title: qsTr("Hello World")
     }

Add a property and function to randomly select the language of the displayed text:

         ...
         readonly property list<string> texts: ["Hallo Welt", "Hei maailma",
                                            "Hola Mundo", "Привет мир"]

     function setText() {
         var i = Math.round(Math.random() * 3)
         text.text = texts[i]
     }

### Add Qt Quick Controls

Add Text and Button QML types within a ColumnLayout type to design the UI:

         ColumnLayout {
         anchors.fill:  parent

         Text {
             id: text
             text: "Hello World"
             Layout.alignment: Qt.AlignHCenter
         }
         Button {
             text: "Click me"
             Layout.alignment: Qt.AlignHCenter
             onClicked:  setText()
         }
     }

You can also use Qt Quick Designer or Qt Design Studio to design Qt Quick UIs.

## Run the application

Select (Run) to run the application.

See also Tutorial: Qt Widgets and Python, Tutorial: Qt Widgets UI and Python, and Develop Qt for Python applications.

Tutorial: Mobile application ◦ Tutorial: Qt Quick application