winui3 namespace

Danger

None of the packages in this namespace can be used if the Windows App Runtime is not installed! You must manually install this from here. Also read the Boostrapping section below for how to initialize the runtime.

The winui3 namespace package contains the automatically generated bindings for the Windows App SDK, also known as WinUI 3. Each API namespace is distributed as a separate package on PyPI. For example, the winui3-Microsoft.UI.Xaml package contains the bindings for the APIs in the Microsoft.UI.Xaml namespace and can be imported in Python as winui3.microsoft.windows.ui.xaml.

Since most of the code is generated, there currently aren’t Python API docs. You can use https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/ instead, keeping in mind the Python naming conventions and other rules mentioned in The WinRT type system section.

Tip

The packages include type hints so you can use those if you are unsure of a return type or a parameter type.

Changed in version 3.0: The top-level package name has been changed from winrt to winui3.

Boostrapping

To use the Windows App SDK, you need to start the runtime at the beginning of your program:

from winui3.microsoft.windows.applicationmodel.dynamicdependency import bootstrap

# initialize Windows App runtime and prompt user if it is not installed
with bootstrap.initialize(options=bootstrap.InitializeOptions.ON_NO_MATCH_SHOW_UI):
    # your main entry point code here
    ...

Warning

If you are using a Python runtime installed rom the Microsoft Store, this method will fail with OSError(winerror=-2147009196) (ERROR_NOT_SUPPORTED = -2147009196). This happens because the Microsoft Store version of Python is a “packaged” app and expects the dependency to be included in the package manifest. This should be able to be worked around using other dynamic dependency APIs, but this has not been extensively tested yet. See Microsoft’s Docs for more information.

Interop modules

There are also special modules that provide extra functionality to bridge between WinRT and other interfaces.

• winui3.microsoft.ui.interop module
  • get_window_id_from_window()
  • get_window_from_window_id()
  • get_display_id_from_monitor()
  • get_monitor_from_display_id()
  • get_icon_id_from_icon()
  • get_icon_from_icon_id()
• winui3.microsoft.windows.applicationmodel.dynamicdependency.bootstrap module
  • initialize()
  • RELEASE_VERSION
  • RUNTIME_VERSION
  • InitializeOptions