Standalone exe version 1.1, compatibility with PyInstaller 3.2.1

Fixed: Ensure API version 2 for PyQT4 in PyInstaller (non functional setting dialogs)

Author: jcwinkler

HowTo-Windows-Exe.txt

@@ -1,33 +1,38 @@
-Instructions for building the Windows executable using PyInstaller 2.1:
+Instructions for building the Windows executable using PyInstaller 3.2.1 on Python 2.7.10
 
-Note: As of April 2016 PyInstaller 3.0 does not work properly
-
-1. Make sure PyInstaller 2.1 is installed in your Python environment!
+1. Make sure PyInstaller 3.2.1 is installed in your Python environment!
 
 2. Open the file build_exe.py and adjust the directories if required.
 
-3. Extremely important: Make sure that in main.py the line 
-   sip.setapi('QVariant', 2)
-   is commented out:
-   #sip.setapi('QVariant', 2)
-
-4. In your python installation locate the directory in which the
+3. In your python installation locate the directory in which the
    mpl_toolkits reside. Put an empty file named __init__.py into it
    (e.g. c:\Progs32\WinPython-32bit-2.7.10.3\python-2.7.10\Lib\site-packages\mpl_toolkits\__init__.py)
 
+
+4. In your python installation locate file build_main.py in the PyInstaller\building directory
+   (e.g. C:\Progs32\WinPython-32bit-2.7.10.3\python-2.7.10\Lib\site-packages\PyInstaller\building\build_main.py)
+   Open this file and go to the function "build(spec, distpath, workpath, clean_build)". Insert the line
+		
+		sys.setrecursionlimit(2147483647)
+	
+	just below the imports. Save the file. (This is to fix a bug on PyInstaller / modulegraph, see
+	comment in PyInstaller\lib\modulegraph\modulegraph.py:
+	#FIXME: To decrease the likelihood of ModuleGraph exceeding the recursion limit
+	#and hence unpredictably raising fatal exceptions, increase the recursion
+	#limit at PyInstaller startup (i.e., in the
+	#PyInstaller.building.build_main.build() function). For details, see:
+	#    https://github.com/pyinstaller/pyinstaller/issues/1919#issuecomment-216016176	)
+	
 5. Make sure that build_dir is not opened in any application or console, i.e.,
    it can be deleted by the script.
 
 6. Run build_exe.py
 
-7. The resulting exe should be found in build_dir.
+7. The resulting exe should be found in build_dir\PyPlane.
 
 8. If some modules are not found after launching the exe you have to manually 
    import them using the --hidden-import option in build_exe. This can be
    a time-consuming trial and error procedure.
 
-9. Change the line 
-   #sip.setapi('QVariant', 2)
-   in main.py to
-   sip.setapi('QVariant', 2)
-   to ensure that the application runs properly under native Python.
+9. Open the file InstallerPyPlane.nsi, adjust the version information if required, and run the
+   file through NullSoft Installable System. Setup.exe will be placed into build_dir.

InstallerPyPlane.nsi

@@ -2,7 +2,7 @@
 
 ; HM NIS Edit Wizard helper defines
 !define PRODUCT_NAME "PyPlane"
-!define PRODUCT_VERSION "1.0"
+!define PRODUCT_VERSION "1.1"
 !define PRODUCT_PUBLISHER "Institut fuer Regelungs- und Steuerungstheorie"
 !define PRODUCT_WEB_SITE "https://github.com/TUD-RST/pyplane.git"
 

PyPlane.spec

@@ -1,22 +1,33 @@
 # -*- mode: python -*-
+
+block_cipher = None
+
+
 a = Analysis(['main.py'],
-             pathex=['core', 'D:\\Users\\winkler\\Uni\\Projekte\\Allgemein\\pyplane'],
+             pathex=['core', 'D:\\winkler\\Uni\\Projekte\\Allgemein\\pyplane\\pyplane'],
+             binaries=[],
+             datas=[],
              hiddenimports=['scipy.special._ufuncs_cxx', 'mpl_toolkits', 'scipy.linalg.cython_blas', 'scipy.linalg.cython_lapack'],
-             hookspath=None,
-             runtime_hooks=None)
-pyz = PYZ(a.pure)
+             hookspath=[],
+             runtime_hooks=['runtime_hook_pyqt4.py'],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
 exe = EXE(pyz,
           a.scripts,
           exclude_binaries=True,
-          name='PyPlane.exe',
+          name='PyPlane',
           debug=False,
-          strip=None,
+          strip=False,
           upx=True,
           console=True , icon='resources\\pyplane_icon_32px.ico')
 coll = COLLECT(exe,
                a.binaries,
                a.zipfiles,
                a.datas,
-               strip=None,
+               strip=False,
                upx=True,
                name='PyPlane')

README.md

@@ -37,7 +37,7 @@ https://github.com/TUD-RST/pyplane
 Please don't hesitate to report bugs, comments, or suggestions on
 GitHub!
 
-[1] http://www.et.tu-dresden.de/rst/
+[1] https://tu-dresden.de/ing/elektrotechnik/rst
 
 
 
@@ -55,11 +55,11 @@ Prerequisites for running natively under Python
 PyPlane runs under Python version 2.7 with the following packages
 installed:
 
-* NumPy (tested under version 1.9)
-* SciPy (tested under version 0.15)
-* Matplotlib (tested under verison 1.4.3)
-* SymPy (tested under verison 0.7.6)
-* PyQt4 (tested under version 4.11.3)
+* NumPy (tested under version 1.9.3)
+* SciPy (tested under version 0.16.1)
+* Matplotlib (tested under verison 1.5.0)
+* SymPy (tested under verison 0.7.6.1)
+* PyQt4 (tested under version 4.11.4)
 
 An optionally installed and accessible LaTeX/dvipng environment
 produces much prettier results in the linearization tabs. If no LaTeX
@@ -85,9 +85,12 @@ functional.
 Double-click on the PyPlane icon on the desktop in order to launch the
 application. Start-up may take some time.
 
-Open issues in version 1.0
+Open issues in version 1.1
 ==========================
 
+* When creating the phase plane plot for a linearized system the creation of the plot title
+  via LaTeX fails. Workaround: Just plot the streamlines or an arbitrary trajectory in the plot and 
+  the title will appear.
 * PyPlane will not launch if it detects a fully functional
   LaTeX-environment in which the package type1cm.sty is
   missing. Please place this style package in your LaTeX-installation.

build_exe.py

@@ -6,15 +6,15 @@
 
 Please note in order to build a properly working exe:
 -> Include the statement "import FileDialog" in main.py (an error in matplotlib)
+-> Ensure that runtime_hook_pyqt4.py is called when building the target
+   (option --runtime-hook in call of pyinstaller)
+-> Set recursion limit in build_main.py of your PyInstaller installation
+   (see HowTo-Windows-Exe.txt for more information)
 
 Created on Fri Mar 27 16:16:28 2015
 
 @author: winkler
 """
-
-
-
-
 import subprocess
 import os.path
 import shutil
@@ -33,11 +33,13 @@
 paths      = 'core'
 
 
+# Some packages have to be imported manually (--hidden-import)
 cmd = 'pyinstaller --clean --distpath=%s --workpath=%s --paths=%s \
     --hidden-import=scipy.special._ufuncs_cxx\
     --hidden-import=mpl_toolkits\
     --hidden-import=scipy.linalg.cython_blas\
     --hidden-import=scipy.linalg.cython_lapack\
+    --runtime-hook runtime_hook_pyqt4.py\
     --icon=resources\pyplane_icon_32px.ico --name=%s %s' % (build_dir, temp_dir, paths, exename, infile)
 print 'Calling:', cmd
 
@@ -53,7 +55,6 @@
 
 
 # Copy the config directory to the build directory
-
 shutil.copytree(config_dir, exe_dir+config_dir)
 shutil.copytree(lib_dir, exe_dir+lib_dir)
 os.mkdir(os.path.dirname(exe_dir+descrfile))

main.py

@@ -1,28 +1,28 @@
 # -*- coding: utf-8 -*-
-
-#    Copyright (C) 2013
-#    by Klemens Fritzsche, pyplane@leckstrom.de
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
-#
-#    You should have received a copy of the GNU General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
+"""
+    Copyright (C) 2013
+    by Klemens Fritzsche, pyplane@leckstrom.de
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
 __author__ = 'Klemens Fritzsche'
 
 import sys
 #import ast
 
-# Needed since apparently different default variant types are used under Windows and Linux
-# The line sip.setapi(...) has to be commented out if an MS windows exe is built using PyInstaller!
+# Ensure that the proper PyQT4 API version is used (otherwise dialogs using
+# QVariant do not work)
 import sip
 sip.setapi('QVariant', 2)
 
@@ -50,7 +50,7 @@ class MainApp(PyplaneMainWindow):
     """
 
     __PYPLANE_VERSION = "1.1"
-    __PYPLANE_DATE = "2016-04-08"
+    __PYPLANE_DATE = "2017-06-17"
 
     def __init__(self):
         # superclass constructor

runtime_hook_pyqt4.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+"""
+This stuff is needed for building the stand-alone executable. It is called by
+the pyinstaller script (via the --runtime-hook flag) and ensures that the
+proper API version for PyQT4 is loaded. PyPlane uses the API version 2, but
+by default PyInstaller enables API version 1 resulting in non functional
+setting dialogs where the datatype QVariant plays an important role.
+
+Created on Wed Jun 14 15:49:26 2017
+
+@author: winkler
+"""
+
+import sip
+
+sip.setapi(u'QDate', 2)
+sip.setapi(u'QDateTime', 2)
+sip.setapi(u'QString', 2)
+sip.setapi(u'QTextStream', 2)
+sip.setapi(u'QTime', 2)
+sip.setapi(u'QUrl', 2)
+sip.setapi(u'QVariant', 2)