updated the pyinstaller spec

git-svn-id: https://pycam.svn.sourceforge.net/svnroot/pycam/trunk@978 bbaffbd6-741e-11dd-a85d-61de82d9cad9

pyinstaller/hooks/hook-pycam.py

 # keysyms does not seem to be recognized by pyinstaller
 # There will be exceptions after any keypress without this line.
 hiddenimports = ["gtk.keysyms"]
+

pyinstaller/pycam.spec

 # -*- mode: python -*-
+
 BASE_DIR = os.path.realpath(os.path.join(os.path.dirname(locals()["spec"]),
         os.path.pardir))
+
+# add the project's source directory to PYTHONPATH
+sys.path.insert(0, os.path.join(BASE_DIR, "src"))
+from pycam.Utils import get_platform, PLATFORM_LINUX, PLATFORM_WINDOWS, PLATFORM_MACOS
+from pycam import VERSION
+
+
 UI_DATA_RELATIVE = os.path.join("share", "ui")
 UI_DATA_DIR = os.path.join(BASE_DIR, UI_DATA_RELATIVE)
-# We need to use a startup file ending with ".py" to allow forking in multiprocessing mode.
-# Copy "pycam" to this file and remove it after building.
-STARTUP_SCRIPT = os.path.join(BASE_DIR, "pycamGUI.py")
 ORIGINAL_STARTUP_SCRIPT = os.path.join(BASE_DIR, "pycam")
 
+# renaming the STARTUP_SCRIPTS seems to be necessary only for Windows
+rename_startup_script = (get_platform() == PLATFORM_WINDOWS)
+
+if rename_startup_script:
+    # We need to use a startup file ending with ".py" to allow forking in
+    # multiprocessing mode. Copy "pycam" to this file and remove it at the end.
+    STARTUP_SCRIPT = os.path.join(BASE_DIR, "pycamGUI.py")
+else:
+    STARTUP_SCRIPT = ORIGINAL_STARTUP_SCRIPT
+
 data = [(os.path.join(UI_DATA_RELATIVE, "pycam-project.ui"), os.path.join(UI_DATA_DIR, "pycam-project.ui"), "DATA"),
         (os.path.join(UI_DATA_RELATIVE, "menubar.xml"), os.path.join(UI_DATA_DIR, "menubar.xml"), "DATA"),
         (os.path.join(UI_DATA_RELATIVE, "logo_gui.png"), os.path.join(UI_DATA_DIR, "logo_gui.png"), "DATA"),
 ]
 
-# look for the location of "libpixbufloader-png.dll" (for Windows standalone executable)
-start_dirs = (os.path.join(os.environ["PROGRAMFILES"], "Common files", "Gtk"),
+# sample models
+data.extend(Tree(os.path.join(BASE_DIR, "samples"), prefix="samples"))
+# single-line fonts
+data.extend(Tree(os.path.join(BASE_DIR, "share", "fonts"), prefix=os.path.join("share", "fonts")))
+# icon file
+icon_file = os.path.join(BASE_DIR, "share", "pycam.ico")
+
+
+if get_platform() == PLATFORM_WINDOWS:
+    # look for the location of "libpixbufloader-png.dll" (for Windows standalone executable)
+    start_dirs = (os.path.join(os.environ["PROGRAMFILES"], "Common files", "Gtk"),
             os.path.join(os.environ["COMMONPROGRAMFILES"], "Gtk"),
-        "C:\\")
-def find_gtk_pixbuf_dir(dirs):
+            r"C:\\")
+    def find_gtk_pixbuf_dir(dirs):
         for start_dir in dirs:
             for root, dirs, files in os.walk(start_dir):
                 if "libpixbufloader-png.dll" in files:
                     return root
         return None
-gtk_loaders_dir = find_gtk_pixbuf_dir(start_dirs)
-if gtk_loaders_dir is None:
+    gtk_loaders_dir = find_gtk_pixbuf_dir(start_dirs)
+    if gtk_loaders_dir is None:
         print >>sys.stderr, "Failed to locate Gtk installation (looking for libpixbufloader-png.dll)"
         #sys.exit(1)
         gtk_loaders_dir = start_dirs[0]
 
-# configure the pixbufloader (for the Windows standalone executable)
-config_dir = gtk_loaders_dir
-config_relative = os.path.join("etc", "gtk-2.0", "gdk-pixbuf.loaders")
-while not os.path.isfile(os.path.join(config_dir, config_relative)):
+    # configure the pixbufloader (for the Windows standalone executable)
+    config_dir = gtk_loaders_dir
+    config_relative = os.path.join("etc", "gtk-2.0", "gdk-pixbuf.loaders")
+    while not os.path.isfile(os.path.join(config_dir, config_relative)):
         new_config_dir = os.path.dirname(config_dir)
         if (not new_config_dir) or (new_config_dir == config_dir):
             print >>sys.stderr, "Failed to locate '%s' around '%s'" \
@@ -41,23 +65,21 @@ while not os.path.isfile(os.path.join(config_dir, config_relative)):
             break
         config_dir = new_config_dir
 
-if config_dir:
+    if config_dir:
         gtk_pixbuf_config_file = os.path.join(config_dir, config_relative)
         data.append((config_relative, os.path.join(config_dir, config_relative), "DATA"))
 
-# somehow we need to add glut32.dll manually
-more_libs = []
-
-def find_glut32(start_dir, filename="glut32.dll"):
+    # somehow we need to add glut32.dll manually
+    def find_glut32(start_dir, filename="glut32.dll"):
         for root, dirs, files in os.walk(start_dir):
             if filename in files:
                 return os.path.join(root, filename)
         return None
-glut32_dll = find_glut32(sys.prefix)
-if glut32_dll:
-    more_libs.append((os.path.basename(glut32_dll), glut32_dll, "BINARY"))
+    glut32_dll = find_glut32(sys.prefix)
+    if glut32_dll:
+        data.append((os.path.basename(glut32_dll), glut32_dll, "BINARY"))
 
-def get_pixbuf_loaders_prefix(gtk_loaders_dir):
+    def get_pixbuf_loaders_prefix(gtk_loaders_dir):
         prefix = []
         path_splits = gtk_loaders_dir.split(os.path.sep)
         while path_splits and (not prefix or (prefix[-1].lower() != "lib")):
@@ -69,35 +91,51 @@ def get_pixbuf_loaders_prefix(gtk_loaders_dir):
         else:
             return None
 
-gtk_pixbuf_loaders_prefix = get_pixbuf_loaders_prefix(gtk_loaders_dir)
-if gtk_pixbuf_loaders_prefix is None:
+    gtk_pixbuf_loaders_prefix = get_pixbuf_loaders_prefix(gtk_loaders_dir)
+    if gtk_pixbuf_loaders_prefix is None:
         print >>sys.stderr, "Failed to extract the prefix from '%s'" % gtk_loaders_dir
-    gtk_pixbuf_loaders = []
-else:
-    gtk_pixbuf_loaders = Tree(gtk_loaders_dir, prefix=gtk_pixbuf_loaders_prefix)
-
-# import VERSION for the output filename
-sys.path.insert(0, os.path.join(BASE_DIR, "src"))
-from pycam import VERSION
-
-samples = Tree(os.path.join(BASE_DIR, "samples"), prefix="samples")
-fonts = Tree(os.path.join(BASE_DIR, "share", "fonts"), prefix=os.path.join("share", "fonts"))
+        # no additional files
+    else:
+        data.extend(Tree(gtk_loaders_dir, prefix=gtk_pixbuf_loaders_prefix))
+elif get_platform() == PLATFORM_LINUX:
+    pass
+elif get_platform() == PLATFORM_MACOS:
+    pass
 
-icon_file = os.path.join(BASE_DIR, "share", "pycam.ico")
 
-if os.path.exists(STARTUP_SCRIPT):
+# do the STARTUP_SCRIPT/ORIGINAL_STARTUP_SCRIPT renaming before build
+if rename_startup_script:
+    if os.path.exists(STARTUP_SCRIPT):
         print "New startup script already exists: %s" % STARTUP_SCRIPT
-else:
+    else:
         os.rename(ORIGINAL_STARTUP_SCRIPT, STARTUP_SCRIPT)
 
-a = Analysis([os.path.join(HOMEPATH,'support\\_mountzlib.py'), os.path.join(HOMEPATH,'support\\useUnicode.py'), STARTUP_SCRIPT],
-    pathex=[os.path.join(BASE_DIR, "src")],
+
+analyze_scripts = [STARTUP_SCRIPT]
+if get_platform() == PLATFORM_WINDOWS:
+    analyze_scripts.insert(0, os.path.join(HOMEPATH,'support\\_mountzlib.py'))
+    analyze_scripts.insert(1, os.path.join(HOMEPATH,'support\\useUnicode.py'))
+    output_name = os.path.join(BASE_DIR, "pycam-%s_standalone.exe" % VERSION)
+elif get_platform() == PLATFORM_LINUX:
+    analyze_scripts.insert(0, os.path.join(HOMEPATH,'support/_mountzlib.py'))
+    analyze_scripts.insert(1, os.path.join(HOMEPATH,'support/useUnicode.py'))
+    #output_name=os.path.join('build/pyi.linux2/pycam', 'pycam')
+    output_name = os.path.join(BASE_DIR, "pycam-%s_standalone.bin" % VERSION)
+elif get_platform() == PLATFORM_MACOS:
+    output_name = os.path.join(BASE_DIR, "pycam-%s_standalone.dmg" % VERSION)
+
+
+a = Analysis(analyze_scripts,
+    #pathex=[os.path.join(BASE_DIR, "src")],
+    pathex=[BASE_DIR],
     hookspath=[os.path.join(BASE_DIR, "pyinstaller", "hooks")])
 
+
 pyz = PYZ(a.pure)
 
-# remove all ".svn" files
-for file_list in (data, samples, gtk_pixbuf_loaders, fonts, a.datas):
+
+# remove all ".svn" (subversion) files
+for file_list in (data, a.datas):
     flist_copy = list(file_list)
     # clear the original list
     while file_list:
@@ -107,21 +145,27 @@ for file_list in (data, samples, gtk_pixbuf_loaders, fonts, a.datas):
         if not ".svn" in fentry[0].split(os.path.sep):
             file_list.append(fentry)
 
-exe = EXE(pyz, data, samples, gtk_pixbuf_loaders, fonts,
+
+exe = EXE(pyz, data,
           a.scripts,
-          a.binaries + more_libs,
+          a.binaries,
           a.zipfiles,
           a.datas,
-          name=os.path.join(BASE_DIR, "pycam-%s_standalone.exe" % VERSION),
+          exclude_binaries=False,
+          name=output_name,
           icon=icon_file,
-          debug=False,
+          debug=True,
           strip=False,
-          upx=True,
+          upx=False,
           console=True,
       )
 
-if not os.path.exists(ORIGINAL_STARTUP_SCRIPT):
+
+# We need to rename the startup script due to name clashes on Windows.
+# Otherwise multiprocessing (multiple parallel local processes) fails.
+if rename_startup_script:
+    if not os.path.exists(ORIGINAL_STARTUP_SCRIPT):
         os.rename(STARTUP_SCRIPT, ORIGINAL_STARTUP_SCRIPT)
-else:
+    else:
         print "Keeping original startup script: %s" % ORIGINAL_STARTUP_SCRIPT
 

pyinstaller/pyinstaller_info.txt

 PyInstaller (http://pyinstaller.org) can be used to create standalone binaries for Windows.
 
 How to build a standalone exe file (on Windows only):
-1) download pyinstaller
-2) patch pyinstaller (use pyinstaller_fix_module_exception.patch)
+1) install UPX (compression)
+ * Debian/Ubuntu: apt-get install upx-ucl
+ * Windows: http://upx.sourceforge.net
+2) download pyinstaller (v1.4 was used)
+3) patch pyinstaller (use pyinstaller_fix_module_exception.patch)
    see http://www.pyinstaller.org/ticket/205 for details
-3) run "cmd.exe"
-4) "cd PATH_TO_PYCAM"
-5) "python PYINSTALLER_PATH\Build.py pyinstaller\pycam.spec"
-6) test and upload the binary file "pycam-VERSION_standalone.exe"
+4) run "cmd.exe" (or open a terminal)
+5) "cd PATH_TO_PYCAM"
+6) "python PYINSTALLER_PATH/utils/Configure.py"
+7) "python PYINSTALLER_PATH/utils/Build.py pyinstaller/pycam.spec"
+8) test and upload the binary file "pycam-VERSION_standalone.?"
 
 Known issues:
-* multiprocessing does not work with standalone executable
+* multiprocessing on Windows: no server/client capabilities
+* python-setproctitle v1.0.1 causes a segfault - remove it from the build system
+* Linux: pre-built executable don't seem to work across different versions of libc 
+* Linux/MacOS?: you need to remove the reference to "windll" at the top of the "pycam" script (line 32-36)