Functions¶

loadUiType¶

loadUiType(uifile: str, path_search: bool = False)¶

Parameters:

uifile (str) – The name of the .ui file
path_search (bool) – Wether to search the pyside6-uic in path in case it is not found

Returns:

tuple(object, object)

This function generates and loads a .ui file at runtime, and it returns a tuple containing the reference to the Python class, and the base class.

We recommend not to use this approach as the workflow should be to generate a Python file from the .ui file, and then import and load it to use it, but we do understand that there are some corner cases when such functionality is required.

The internal process relies on uic being in the PATH. The pyside6-uic wrapper uses a shipped uic that is located in the site-packages/PySide6/uic, so PATH needs to be updated to use that if there is no uic in the system.

A simple use case is:

from PySide6.QtUiTools import loadUiType

generated_class, base_class = loadUiType("themewidget.ui")
# the values will be:
#  (<class '__main__.Ui_ThemeWidgetForm'>, <class 'PySide6.QtWidgets.QWidget'>)

widget = base_class()
form = generated_class()
form.setupUi(widget)
# form.a_widget_member.a_method_of_member()
widget.show()

Security Considerations¶

We strongly advise against using this function in security-critical environments.

The function runs the external tool pyside6-uic to convert the .ui files into Python code, which is then executed to create the return types.

In particular, the parameter path_search should always be left at its default value False to ensure that the correct version of pyside6-uic is used.

Manipulation of the executable or loading .ui files from untrusted sources can lead to security threats in your application, such as denial of service attacks, UI deception, or the loading of unexpected plugins.