Skip to content

domarm-comat/pyqt6rc

Repository files navigation

pyqt6rc

GitHub_repo

This library offers scripts to correct resource paths in files generated by the pyuic6 command. Since PyQt6 does not include the pyrcc6 script for converting resources, this package serves that purpose. In the current PyQt6 implementation, the .py files created by the pyuic6 command contain incorrect resource paths.

UPDATE: As of PyQt-6.3.1 it's possible to use Qt’s resource system again. We can use pyside6-rcc to convert rcc files into py.
Source for this solution can be found in StackOverflow answer.

Provided scripts are converting .ui files into .py files using three different ways:

  • Using pyside6-rcc script to convert rcc files into py and pyuic6 to convert all ui files [Use pyside6rc]
  • Native >= python3.7 solution using importlib [Use pyqt6rc].
  • Use of importlib_resources, for compatibility with Python3.6+ [Use pyqt6rc with -c option]
  • Adding resource search path using QtCore.QDir.addSearchPath() and modifying generated prefixes [Use pyqt6sp]

More on this topic can be found on StackOverflow.

From version 4.0, parameter -p, --package was removed. Pyqt6rc now determines package name automatically by crawling parent folders and looking for \_\_init\_\_.py file.

Conversion

Generated template using pyside6rc script:

import myPackage.resources.icons  # noqa

Generated template using pyuic6 script:

icon = QtGui.QIcon()
icon.addPixmap(QtGui.QPixmap(":/icons/icon1.png"), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.Off)

Generated template using pyqt6rc script:

from importlib.resources import path

icon = QtGui.QIcon()
with path("myPackage.resources.icons", "icon1.png") as f_path:
    icon.addPixmap(QtGui.QPixmap(str(f_path)), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.Off)

Generated template using pyqt6rc (-c, --compatible) script:

from importlib_resources import path

icon = QtGui.QIcon()
with path("myPackage.resources.icons", "icon1.png") as f_path:
    icon.addPixmap(QtGui.QPixmap(str(f_path)), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.Off)

Generated template using pyqt6sp script:

import os
from os.path import dirname, normpath
from PyQt6.QtCore import QDir

prefix_resources = [('icons', '../resources/')]
for prefix, resource in prefix_resources:
    sp = QDir.searchPaths(prefix)
    QDir.setSearchPaths(prefix, set(sp + [normpath(os.path.join(dirname(__file__), resource))]))

icon = QtGui.QIcon()
icon.addPixmap(QtGui.QPixmap("icons:icon1.png"), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.Off)

Usage examples

Package structure example

myPackage
│   __init__.py    
│
└───resources
|   |   __init__.py
│   │   image1.png
│   │   image2.png
│   │   resources.qrc
|   |   ...
|   |
|   └───icons
│       │   __init__.py
│       │   icon1.png
│       │   icon2.png
│       │   ...
│   
└───templates
    │   template1.ui
    │   template2.ui

Batch convert all .ui files located in the templates directory using pyside6-rcc

pyside6rc /myPackage/templates

Batch convert all .ui files located in the templates directory using pyside6-rcc
Without writing import line of resource package to ui files (-niw)

pyside6rc -niw /myPackage/templates

Batch convert all .ui files located in the templates directory using pyside6-rcc
Without ui to py conversion (-npc)

pyside6rc -npc /myPackage/templates

Batch convert all .ui files located in the templates directory using pyside6-rcc

pyside6-rcc /myPackage/templates

Batch convert all .ui files located in the templates directory

pyqt6rc /myPackage/templates

Convert template1.ui only

pyqt6rc /myPackage/templates/template1.ui

Convert template1.ui and save it in /tmp directory

pyqt6rc /myPackage/templates/template1.ui -o /tmp

Batch convert all .ui files located in templates directory using importlib_resources

pyqt6rc /myPackage/templates -c

Batch convert all .ui files located in templates directory using setSearchPaths method

pyqt6sp /myPackage/templates