Merge pull request #132 from abstractfactory/master

Implement #131

Author: mottosso

Qt.py

@@ -19,19 +19,20 @@
     - PyQt4
 
 Usage:
-    >>> import sys
-    >>> from Qt import QtWidgets
-    >>> app = QtWidgets.QApplication(sys.argv)
-    >>> button = QtWidgets.QPushButton("Hello World")
-    >>> button.show()
-    >>> app.exec_()
+    >> import sys
+    >> from Qt import QtWidgets
+    >> app = QtWidgets.QApplication(sys.argv)
+    >> button = QtWidgets.QPushButton("Hello World")
+    >> button.show()
+    >> app.exec_()
 
 """
 
 import os
 import sys
+import shutil
 
-__version__ = "0.4.3"
+__version__ = "0.5.0"
 
 # All unique members of Qt.py
 __added__ = list()
@@ -84,6 +85,31 @@ def add(object, name, value, safe=True):
     remap(object, name, value, safe)
 
 
+def convert(lines):
+    """Convert compiled .ui file from PySide2 to Qt.py
+
+    Arguments:
+        lines (list): Each line of of .ui file
+
+    Usage:
+        >> with open("myui.py") as f:
+        ..   lines = convert(f.readlines())
+
+    """
+
+    def parse(line):
+        line = line.replace("from PySide2 import", "from Qt import")
+        line = line.replace("QtWidgets.QApplication.translate", "Qt.translate")
+        return line
+
+    parsed = list()
+    for line in lines:
+        line = parse(line)
+        parsed.append(line)
+
+    return parsed
+
+
 def pyqt5():
     import PyQt5.Qt
     from PyQt5 import QtCore, uic
@@ -100,6 +126,10 @@ def pyqt5():
     add(PyQt5, "__remapped__", __remapped__)
     add(PyQt5, "__modified__", __modified__)
     add(PyQt5, "load_ui", lambda fname: uic.loadUi(fname))
+    add(PyQt5, "convert", convert)
+    add(PyQt5, "translate", lambda
+        context, sourceText, disambiguation, n: QtCore.QCoreApplication(
+            context, sourceText, disambiguation, n))
 
     return PyQt5
 
@@ -150,6 +180,10 @@ def pyqt4():
     add(PyQt4, "__remapped__", __remapped__)
     add(PyQt4, "__modified__", __modified__)
     add(PyQt4, "load_ui", lambda fname: uic.loadUi(fname))
+    add(PyQt4, "convert", convert)
+    add(PyQt4, "translate", lambda
+        context, sourceText, disambiguation, n: QtCore.QCoreApplication(
+            context, sourceText, disambiguation, None, n))
 
     return PyQt4
 
@@ -168,6 +202,10 @@ def pyside2():
     add(PySide2, "__remapped__", __remapped__)
     add(PySide2, "__modified__", __modified__)
     add(PySide2, "load_ui", lambda fname: QtUiTools.QUiLoader().load(fname))
+    add(PySide2, "convert", convert)
+    add(PySide2, "translate", lambda
+        context, sourceText, disambiguation, n: QtCore.QCoreApplication(
+            context, sourceText, disambiguation, n))
 
     return PySide2
 
@@ -198,6 +236,10 @@ def pyside():
     add(PySide, "__remapped__", __remapped__)
     add(PySide, "__modified__", __modified__)
     add(PySide, "load_ui", lambda fname: QtUiTools.QUiLoader().load(fname))
+    add(PySide, "convert", convert)
+    add(PySide, "translate", lambda
+        context, sourceText, disambiguation, n: QtCore.QCoreApplication(
+            context, sourceText, disambiguation, None, n))
 
     return PySide
 
@@ -207,6 +249,60 @@ def log(text, verbose):
         sys.stdout.write(text)
 
 
+def cli(args):
+    """Qt.py command-line interface"""
+    import argparse
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--convert",
+                        help="Path to compiled Python module, e.g. my_ui.py")
+    parser.add_argument("--compile",
+                        help="Accept raw .ui file and compile with native "
+                             "PySide2 compiler.")
+    parser.add_argument("--stdout",
+                        help="Write to stdout instead of file",
+                        action="store_true")
+    parser.add_argument("--stdin",
+                        help="Read from stdin instead of file",
+                        action="store_true")
+
+    args = parser.parse_args(args)
+
+    if args.stdout:
+        raise NotImplementedError("--stdout")
+
+    if args.stdin:
+        raise NotImplementedError("--stdin")
+
+    if args.compile:
+        raise NotImplementedError("--compile")
+
+    if args.convert:
+        sys.stdout.write("#\n"
+                         "# WARNING: --convert is an ALPHA feature.\n#\n"
+                         "# See https://github.com/mottosso/Qt.py/pull/132\n"
+                         "# for details.\n"
+                         "#\n")
+
+        #
+        # ------> Read
+        #
+        with open(args.convert) as f:
+            lines = convert(f.readlines())
+
+        backup = "%s_backup%s" % os.path.splitext(args.convert)
+        sys.stdout.write("Creating \"%s\"..\n" % backup)
+        shutil.copy(args.convert, backup)
+
+        #
+        # <------ Write
+        #
+        with open(args.convert, "w") as f:
+            f.write("".join(lines))
+
+        sys.stdout.write("Successfully converted \"%s\"\n" % args.convert)
+
+
 def init():
     """Try loading each binding in turn
 
@@ -216,6 +312,9 @@ def init():
     This means no functions or variables can be called after
     this has executed.
 
+    For debugging and testing, this module may be accessed
+    through `Qt.__shim__`.
+
     """
 
     preferred = os.getenv("QT_PREFERRED_BINDING")
@@ -272,4 +371,4 @@ def init():
     raise ImportError("No Qt binding were found.")
 
 
-init()
+cli(sys.argv[1:]) if __name__ == "__main__" else init()

README.md

@@ -135,7 +135,27 @@ Using the OS path separator (`os.pathsep`) which is `:` on Unix systems and `;`
 
 <br>
 
-##### Load Qt Designer .ui files
+##### Compile Qt Designer files
+
+> WARNING - ALPHA FUNCTIONALITY<br>
+> See [#132](https://github.com/mottosso/Qt.py/pull/132) for details.
+
+`.ui` files compiled via `pyside2-uic` inherently contain traces of PySide2 - e.g. the line `from PySide2 import QtGui`.
+
+In order to use these with Qt.py, or any other binding, one must first erase such traces and replace them with cross-compatible code.
+
+```bash
+$ pyside2-uic my_ui.ui -o my_ui.py
+$ python -m Qt --convert my_ui.py
+# Creating "my_ui_backup.py"..
+# Successfully converted "my_ui.py"
+```
+
+Now you may use the file as you normally would, with Qt.py
+
+<br>
+
+##### Load Qt Designer files
 
 The `uic.loadUi` function of PyQt4 and PyQt5 as well as the `QtUiTools.QUiLoader().load` function of PySide/PySide2 are mapped to a convenience function `load_ui`.
 

tests.py

@@ -159,6 +159,97 @@ def test_vendoring():
     ) == 0
 
 
+def test_convert_simple():
+    """python -m Qt --convert works in general"""
+    before = """\
+from PySide2 import QtCore, QtGui, QtWidgets
+
+class Ui_uic(object):
+    def setupUi(self, uic):
+        self.retranslateUi(uic)
+
+    def retranslateUi(self, uic):
+        self.pushButton_2.setText(
+            QtWidgets.QApplication.translate("uic", "NOT Ok", None, -1))
+""".split("\n")
+
+    after = """\
+from Qt import QtCore, QtGui, QtWidgets
+
+class Ui_uic(object):
+    def setupUi(self, uic):
+        self.retranslateUi(uic)
+
+    def retranslateUi(self, uic):
+        self.pushButton_2.setText(
+            Qt.translate("uic", "NOT Ok", None, -1))
+""".split("\n")
+
+    import Qt
+    assert Qt.convert(before) == after, after
+
+
+def test_convert_idempotency():
+    """Converting a converted file produces an identical file"""
+    before = """\
+from PySide2 import QtCore, QtGui, QtWidgets
+
+class Ui_uic(object):
+    def setupUi(self, uic):
+        self.retranslateUi(uic)
+
+    def retranslateUi(self, uic):
+        self.pushButton_2.setText(
+            QtWidgets.QApplication.translate("uic", "NOT Ok", None, -1))
+"""
+
+    after = """\
+from Qt import QtCore, QtGui, QtWidgets
+
+class Ui_uic(object):
+    def setupUi(self, uic):
+        self.retranslateUi(uic)
+
+    def retranslateUi(self, uic):
+        self.pushButton_2.setText(
+            Qt.translate("uic", "NOT Ok", None, -1))
+"""
+
+    fname = os.path.join(self.tempdir, "idempotency.py")
+    with open(fname, "w") as f:
+        f.write(before)
+
+    import Qt
+
+    os.chdir(self.tempdir)
+    Qt.__shim__.cli(args=["--convert", "idempotency.py"])
+
+    with open(fname) as f:
+        assert f.read() == after
+
+    Qt.__shim__.cli(args=["--convert", "idempotency.py"])
+
+    with open(fname) as f:
+        assert f.read() == after
+
+
+def test_convert_backup():
+    """Converting produces a backup"""
+
+    fname = os.path.join(self.tempdir, "idempotency.py")
+    with open(fname, "w") as f:
+        f.write("")
+
+    import Qt
+
+    os.chdir(self.tempdir)
+    Qt.__shim__.cli(args=["--convert", "idempotency.py"])
+
+    assert os.path.exists(
+        os.path.join(self.tempdir, "%s_backup%s" % os.path.splitext(fname))
+    )
+
+
 def test_meta_add():
     """Qt.add() appends to __added__"""
     import types