pyuiw 0.2.1

Command Line File Watcher for Qt ui file to python file.

pyuiw

Command Line Watcher for auto compile Qt ui to python file.

Original Tool Source from pyside2-tools pyside2uic I modified some code for customization.

Install pyuiw

pip install pyuiw

How to Use

python -m pyuiw
pyuiw

two command run the same alternatively.

pyuiw -h

run this command can show up the help documentation.

usage: pyuiw [-h] [-p] [-o FILE] [-x] [-d] [-i N] [--from-imports] [--useQt] [--QtModule module] [--black] [--isort] [-w [WATCH [WATCH ...]]] [-e [EXCLUDE [EXCLUDE ...]]]
             [-c FILE]

Qt User Interface Compiler version , running on PySide2 5.15.2.
Command Line Watcher for auto compile Qt ui to python file.

Usage Example:

optional arguments:
  -h, --help            show this help message and exit
  -p, --preview         show a preview of the UI instead of generating code
  -o FILE, --output FILE
                        write generated code to FILE instead of stdout
                        <EXP> to define a output expression (default: <${py_dir}/${py_name}_ui.py>)
                        ${py_dir} - input python directory path
                        ${py_name} - input python file name
  -x, --execute         generate extra code to test and display the class
  -d, --debug           show debug output
  -i N, --indent N      set indent width to N spaces, tab if N is 0 (default: 4)

Code generation options:
  --from-imports        generate imports relative to '.'
  --useQt               using Qt.py module for Qt compat
  --QtModule module     customize import Qt module name | only work in --useQt false
  --black               using black format code
  --isort               using isort format code

Watcher options:
  -w [WATCH [WATCH ...]], --watch [WATCH [WATCH ...]]
                        watch files or directories
  -e [EXCLUDE [EXCLUDE ...]], --exclude [EXCLUDE [EXCLUDE ...]]
                        exclude files re expression
  -c FILE, --config FILE
                        read specific config file

Configuration

pyuiw would read the pyproject.toml by default or you can set the --config flag to read specific config file.

here is the default options in config file.

[tool.pyuiw]
QtModule = "Qt"
exclude = [] # using glob pattern for exclude
useQt = true
watch = []
execute = true
debug = false
from_imports = false
preview = false
indent = 4
output = <${py_dir}/${py_name}_ui.py>
black = true
isort = true

here is a example setup.

[tool.pyuiw]
exclude = ["*launcher*"] # exclude file container `launcher`
watch = ["./tests/ui","./test2/test.ui"] # read the file or directory get all the `.ui` file for watch

TodoList

• import code to the top (implement isort)
• black format code
• implement Qt.py for QApplication.translate
• customize import
• poetry pypi python package
• poetry command line tool
• unittest