Skip to content

Python API (PySide6 / PyQt6)

Library v2.81. Python packages that load the same QML controls as C++ apps — shared kit (qml/ + native plugins) + bootstrap helpers.

Related: packaging-python.md · Component API · Getting started.

python scripts/generate_component_docs.py

2 packages · 33 functions · 3 classes · 3 QML-registered types.

Packages

qwinui3

PySide6 or PyQt6 bootstrap — locate a shared kit, configure environment, and wire QQmlApplicationEngine import paths (mirrors C++ Bootstrap).

Modules: __init__, bootstrap, rhi, fonts.

Full Gallery from Python — stage QWinUI3.Gallery QML, register Gallery helpers via @QmlElement / @QmlSingleton, and run the same smoke path as the C++ exe.

Modules: __init__, main, qml_module, types, graphics_backend, gallery_language, demo_tree_model, rhi.

QML types registered from Python

Gallery helpers — import in QML as QWinUI3.Gallery 1.0 after qwinui3_gallery.types.register_types(engine):

  • GraphicsBackend
  • GalleryLanguage
  • DemoTreeModel

QML controls from Python

All public controls documented under components.md work unchanged from Python: call setup_engine(engine) then import QWinUI3.Extras (etc.) in your .qml.

Generated by scripts/generate_component_docs.py — do not edit by hand.