Added Qt resource system usage demo and auto_create_qrc.py.

Author: Shuge Lee

resource_compiler/auto_create_qrc.py

@@ -0,0 +1,144 @@
+#!/usr/bin/env python
+"""
+auto scan resources file and create Qt resource(qrc) file for PySide/PyQt project
+
+Usage:
+    python auto_create_qrc.py your_pictures_path > bar.qrc
+    pyrcc4-2.7 -no-compress bar.qrc -o bar.py
+
+Author: Shuge Lee <[email protected]>
+License: MIT License
+"""
+import os
+import re
+import sys
+import web
+
+PWD = os.path.dirname(os.path.realpath(__file__))
+
+
+def tree(top = '.',
+         filters = None,
+         output_prefix = None,
+         max_level = 4,
+         followlinks = False,
+         top_info = False,
+         report = True):
+    # The Element of filters should be a callable object or
+    # is a byte array object of regular expression pattern.
+    topdown = True
+    total_directories = 0
+    total_files = 0
+
+    top_fullpath = os.path.realpath(top)
+    top_par_fullpath_prefix = os.path.dirname(top_fullpath)
+
+    if top_info:
+        lines = top_fullpath
+    else:
+        lines = ""
+
+    if filters is None:
+        _default_filter = lambda x : not x.startswith(".")
+        filters = [_default_filter]
+
+    for root, dirs, files in os.walk(top = top_fullpath, topdown = topdown, followlinks = followlinks):
+        assert root != dirs
+
+        if max_level is not None:
+            cur_dir = web.utils.strips(root, top_fullpath)
+            path_levels = web.utils.strips(cur_dir, "/").count("/")
+            if path_levels > max_level:
+                continue
+
+        total_directories += len(dirs)
+        total_files += len(files)
+
+        for filename in files:
+            for _filter in filters:
+                if callable(_filter):
+                    if not _filter(filename):
+                        total_files -= 1
+                        continue
+                elif not re.search(_filter, filename, re.UNICODE):
+                    total_files -= 1
+                    continue
+
+                if output_prefix is None:
+                    cur_file_fullpath = os.path.join(top_par_fullpath_prefix, root, filename)
+                else:
+                    buf = web.utils.strips(os.path.join(root, filename), top_fullpath)
+                    if output_prefix != "''":
+                        cur_file_fullpath = os.path.join(output_prefix, buf.strip('/'))
+                    else:
+                        cur_file_fullpath = buf
+
+                lines = "%s%s%s" % (lines, os.linesep, cur_file_fullpath)
+
+    lines = lines.lstrip(os.linesep)
+
+    if report:
+        report = "%d directories, %d files" % (total_directories, total_files)
+        lines = "%s%s%s" % (lines, os.linesep * 2, report)
+
+    return lines
+
+
+QRC_TPL = """<!DOCTYPE RCC><RCC version="1.0">
+<qresource>
+%s
+</qresource>
+</RCC>"""
+
+
+def scan_files(src_path = "."):
+    filters = ['.(png|jpg|gif)$']
+    output_prefix = './'
+    report = False
+    lines = tree(src_path, filters = filters, output_prefix = output_prefix, report = report)
+
+    lines = lines.split('\n')
+    if "" in lines:
+        lines.remove("")
+
+    return lines
+
+def create_qrc_body(src_path):
+    lines = scan_files(src_path)
+
+    buf = ["<file>%s</file>" % i for i in lines]
+    buf = "\n".join(buf)
+    buf = QRC_TPL % buf
+
+    return buf
+
+def create_qrc(src_path, dst_file):
+    buf = create_qrc_body(src_path)
+
+    if dst_file:
+        parent = os.path.dirname(dst_file)
+        if not os.path.exists(parent):
+            os.makedirs(parent)
+
+        f = file(dst_file, "w")
+        f.write(buf)
+        f.close()
+    else:
+        sys.stdout.write(buf)
+
+if __name__ == "__main__":
+    args = sys.argv[1:]
+
+    if not args:
+        msg = "python auto_create_qrc.py <src_path> [dst_qrc_file]"
+        sys.stdout.write('\n' + msg + '\n')
+        sys.exit(-1)
+
+    src_path = args[0]
+
+    if len(args) > 1:
+        dst_file = args[1]
+    else:
+        dst_file = None
+
+    create_qrc(src_path, dst_file)

resource_compiler/foo.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+"""
+Qt resource system usage
+
+Test environment:
+    Mac OS X 10.6.8
+
+http://doc.qt.nokia.com/latest/resources.html
+http://doc.qt.nokia.com/latest/rcc.html
+"""
+import sys
+
+try:
+    from PySide import QtCore
+    from PySide import QtGui
+except ImportError:
+    from PyQt4 import QtCore
+    from PyQt4 import QtGui
+
+
+import bar
+
+
+class Demo(QtGui.QWidget):
+    def __init__(self):
+        super(Demo, self).__init__()
+
+        x, y, w, h = 500, 200, 300, 400
+        self.setGeometry(x, y, w, h)
+
+        pix = QtGui.QPixmap(":/resources/icons/camera.png")
+        label = QtGui.QLabel(self)
+        label.setPixmap(pix)
+        label.move(10, 10)
+
+
+    def show_and_raise(self):
+        self.show()
+        self.raise_()
+
+
+if __name__ == "__main__":
+    app = QtGui.QApplication(sys.argv)
+
+    demo = Demo()
+    demo.show_and_raise()
+
+    sys.exit(app.exec_())

resource_compiler/notes_on_resources.md

@@ -0,0 +1,34 @@
+# Notes On Resources
+
+Qt resource system 用于在可执行应用程序里面保存二进制文件(icons, translation files 等等)。
+
+ - [The Qt Resource System](http://doc.qt.nokia.com/latest/resources.html)
+ - [Resource Compiler (rcc)](http://doc.qt.nokia.com/latest/rcc.html)
+
+rcc means Qt's **r**esour**c**e **c**ompiler .
+
+
+## Example
+
+    find . | grep -v DS_Store
+
+    .
+    ./foo.py
+    ./resources
+    ./resources/icons
+    ./resources/icons/camera.png
+    ./resources/icons/iblah.png
+    ./resources/icons/mic.png
+    ./resources/icons/send_files.png
+
+
+    rcc -project -o bar.qrc
+    pyrcc4-2.7 -no-compress bar.qrc -o bar.py
+
+
+in foo.py
+
+    import bar
+
+    ...
+    pix = QtGui.QPixmap(":/resources/icons/camera.png")

resource_compiler/resources/icons/camera.png

@@ -1,3 +1,4 @@
+#!/usr/bin/python
 """
 Detect platform name and SIP/Python/PyQt/PySide version.
 
@@ -9,51 +10,46 @@
 References:
  - http://www.pyside.org/docs/pyside/pysideversion.html
 """
-import platform
+
 import sys
-import time
+import platform
 
 try:
     import PySide
     from PySide import QtCore
+    print "Using PySide ..."
+    print
 except ImportError:
-    from PyQt4 import QtCore
     PySide = None
+    from PyQt4 import QtCore
+
 
 try:
     import sip
 except ImportError:
     sip = None
 
-def get_platform():
-    pl = None
-    while not pl:
-        try:
-            pl = platform.system()
-        except:
-            # sometime system call failed on MacOS 10.6,
-            # fix it in a quick and dirty way
-            time.sleep(0.1)
-            continue
-    return pl
-
-def get_python_version():
-    return sys.version[:3]
-
-print 'Platform:', get_platform()
-
-print 'Python:', get_python_version()
-
-if sip:
-    print 'SIP:', sip.SIP_VERSION_STR
 
-if not PySide:
-    print "Qt:", QtCore.QT_VERSION_STR
-    print 'PyQt:', QtCore.PYQT_VERSION_STR
-else:
-    print 'Qt:', QtCore.__version__
-    print "PySide:", PySide.__version__
+def get_qt_version():
+    if not PySide:
+        return QtCore.QT_VERSION_STR
+    else:
+        return QtCore.__version__
 
+def get_pyside_version():
+    return PySide and PySide.__version__
 
+def main():
+    print 'Platform: %s' % sys.platform
+    print "Python version: %s" % platform.python_version()
+    print "Qt version: %s" % get_qt_version()
 
+    if sip:
+        print "SIP version: %s" % sip.SIP_VERSION_STR
+    if PySide:
+        print "PySide version: %s" % PySide.__version__
+    else:
+        print "PyQt version: %s" % QtCore.PYQT_VERSION_STR
 
+if __name__ == "__main__":
+    main()