PySide6 Essentials

6.11.0 · active · verified Sat Apr 11

PySide6 Essentials (version 6.11.0) provides the core Python bindings for the Qt 6 cross-platform application and UI framework. Developed by The Qt Company, it offers essential Qt modules like QtCore, QtGui, and QtWidgets under an LGPLv3 or GPLv2/GPLv3 license. It is released frequently, generally following the Qt framework's release cadence, with minor updates and bug fixes.

Warnings

breaking When migrating from PySide2, the main module name changed from `PySide2` to `PySide6`. All imports must reflect this change.
Fix: Update all `from PySide2.<module> import ...` statements to `from PySide6.<module> import ...`.
breaking The `QAction` class was moved from `PySide6.QtWidgets` to `PySide6.QtGui` in PySide6 compared to PySide2.
Fix: Change `from PySide6.QtWidgets import QAction` to `from PySide6.QtGui import QAction`.
gotcha The `pos()` and `globalPos()` methods on `QMouseEvent` are deprecated. They now return `QPointF` objects via `position()` and `globalPosition()`.
Fix: Replace `event.pos().x()` with `event.position().x()` and `event.globalPos().x()` with `event.globalPosition().x()`.
gotcha The `QLayout.setMargin()` method has been removed. Use `QLayout.setContentsMargins()` instead.
Fix: Replace calls to `layout.setMargin(...)` with `layout.setContentsMargins(left, top, right, bottom)` or `layout.setContentsMargins(QMargins(left, top, right, bottom))`.
gotcha For better compatibility with PyQt6 (which enforces fully qualified names), prefer using fully qualified enum names like `Qt.ItemDataRole.DisplayRole` instead of shorter forms like `Qt.DisplayRole`, even though PySide6 supports both.
Fix: Use the full path for enums and flags: e.g., `Qt.AlignmentFlag.AlignLeft` instead of `Qt.AlignLeft`.
gotcha When upgrading PySide6 from versions 6.2.x to 6.3 or newer, issues may arise due to the packaging split into `pyside6-essentials` and `pyside6-addons`. A direct `pip install --upgrade` might not correctly update the dependencies.
Fix: It is recommended to first `pip uninstall pyside6 pyside6-essentials pyside6-addons shiboken6` and then `pip install pyside6` to ensure a clean installation of the new modular structure.
gotcha By default, PySide6 uses `camelCase` for methods and properties, consistent with C++ Qt. To use `snake_case` (PEP8 compliant) and direct property access, you must import them from `__feature__`.
Fix: Add `from __feature__ import snake_case, true_property` at the top of your Python file to enable these Pythonic conventions.

Install

pip install pyside6-essentials Install PySide6 Essentials

Imports

QApplication

from PySide6.QtWidgets import QApplication

QWidget
```
from PySide6.QtWidgets import QWidget
```
QLabel
```
from PySide6.QtWidgets import QLabel
```

QPushButton

from PySide6.QtWidgets import QPushButton

QMainWindow

from PySide6.QtWidgets import QMainWindow

QVBoxLayout

from PySide6.QtWidgets import QVBoxLayout

Qt
```
from PySide6.QtCore import Qt
```
QAction
```
from PySide6.QtGui import QAction
```
QAction moved from QtWidgets to QtGui in PySide6 from PySide2.

Quickstart

A minimal PySide6 application demonstrating how to create a basic window with a label. It initializes QApplication, creates a QWidget as the main window, adds a QLabel, sets a layout, and starts the event loop.

import sys
from PySide6.QtWidgets import QApplication, QLabel, QWidget, QVBoxLayout

def main():
    app = QApplication(sys.argv)
    window = QWidget()
    window.setWindowTitle("PySide6 Essentials App")

    layout = QVBoxLayout()
    label = QLabel("Hello from PySide6 Essentials!")
    layout.addWidget(label)
    window.setLayout(layout)

    window.show()
    sys.exit(app.exec())

if __name__ == "__main__":
    main()

view raw JSON →