vasl-templates/_freeze.py

#!/usr/bin/env python3
""" Compile the application and create a release. """

import sys
import os
import shutil
import tempfile
import time
import datetime
import getopt

from PyInstaller.__main__ import run as run_pyinstaller

BASE_DIR = os.path.split( os.path.abspath(__file__) )[ 0 ]

MAIN_SCRIPT = "vasl_templates/main.py"
APP_ICON = os.path.join( BASE_DIR, "vasl_templates/webapp/static/images/app.ico" )

TARGET_NAMES = {
    "win32": "vasl-templates.exe",
}
DEFAULT_TARGET_NAME = "vasl-templates"

# ---------------------------------------------------------------------

# parse the command-line options
output_fname = None
work_dir = None
cleanup = True
opts,args = getopt.getopt( sys.argv[1:], "o:w:", ["output=","work=","noclean"] )
for opt,val in opts:
    if opt in ["-o","--output"]:
        output_fname = val.strip()
    elif opt in ["-w","--work"]:
        work_dir = val.strip()
    elif opt in ["--noclean"]:
        cleanup = False
    else:
        raise RuntimeError( "Unknown argument: {}".format( opt ) )
if not output_fname:
    raise RuntimeError( "No output file was specified." )

# figure out where to locate our work directories
if work_dir:
    build_dir = os.path.join( work_dir, "build" )
    if os.path.isdir( build_dir ):
        shutil.rmtree( build_dir )
    dist_dir = os.path.join( work_dir, "dist" )
    if os.path.isdir( dist_dir ):
        shutil.rmtree( dist_dir )
else:
    build_dir = tempfile.mkdtemp()
    dist_dir = tempfile.mkdtemp()

# figure out the format of the release archive
formats = { ".zip": "zip", ".tar.gz": "gztar", ".tar.bz": "bztar", ".tar": "tar" }
output_fmt = None
for extn,fmt in formats.items():
    if output_fname.endswith( extn ):
        output_fmt = fmt
        output_fname2 = output_fname[:-len(extn)]
        break
if not output_fmt:
    raise RuntimeError( "Unknown release archive format: {}".format( os.path.split(output_fname)[1] ) )

# configure pyinstaller
# NOTE: Using UPX gave ~25% saving on Windows, but failed to run because of corrupt DLL's :-/
# NOTE: Setting --specpath breaks the build - it's being used as the project root...? (!)
target_name = TARGET_NAMES.get( sys.platform, DEFAULT_TARGET_NAME )
args = [
    "--distpath", dist_dir,
    "--workpath", build_dir,
    "--onefile",
    "--name", target_name,
]
# NOTE: We also need to include the config/ and data/ subdirectories, but we would like to
# make them available to the user, so we include them ourself in the final release archive.
def map_dir( src, dest ): #pylint: disable=missing-docstring
    args.extend( [ "--add-data", src + os.pathsep + dest ] )
map_dir( "vasl_templates/ui", "vasl_templates/ui" )
map_dir( "vasl_templates/resources", "vasl_templates/resources" )
map_dir( "vasl_templates/webapp/static", "static" )
map_dir( "vasl_templates/webapp/templates", "templates" )
if sys.platform == "win32":
    args.append( "--noconsole" )
    args.extend( [ "--icon", APP_ICON ] )
    # NOTE: These files are not always required but it's probably safer to always include them.
    import distutils.sysconfig #pylint: disable=import-error
    dname = os.path.join( distutils.sysconfig.get_python_lib() , "PyQt5/Qt/bin" )
    args.extend( [ "--add-binary", os.path.join(dname,"libEGL.dll") + os.pathsep + "PyQt5/Qt/bin" ] )
    args.extend( [ "--add-binary", os.path.join(dname,"libGLESv2.dll") + os.pathsep + "PyQt5/Qt/bin" ] )
args.append( MAIN_SCRIPT )

# freeze the application
start_time = time.time()
os.chdir( BASE_DIR )
run_pyinstaller( args ) # nb: this doesn't return any indication if it worked or not :-/

# add extra files to the distribution
def ignore_files( dname, fnames ): #pylint: disable=redefined-outer-name
    """Return files to ignore during copytree()."""
    # ignore Python cached files
    ignore = [ "__pycache__" ]
    # ignore dot files
    ignore.extend( f for f in fnames if f.startswith(".") )
    # ignore anything in .gitignore
    fname = os.path.join( dname, ".gitignore" )
    if os.path.isfile( fname ):
        for line_buf in open(fname,"r"):
            line_buf = line_buf.strip()
            if not line_buf or line_buf.startswith("#"):
                continue
            ignore.append( line_buf ) # nb: we assume normal filenames i.e. no globbing
    return ignore
shutil.copy( "LICENSE.txt", dist_dir )
shutil.copytree( "vasl_templates/webapp/data", os.path.join(dist_dir,"data") )
shutil.copytree( "vasl_templates/webapp/config", os.path.join(dist_dir,"config"), ignore=ignore_files )
# copy the examples
dname = os.path.join( dist_dir, "examples" )
os.makedirs( dname )
fnames = [ f for f in os.listdir("examples") if os.path.splitext(f)[1] in (".json",".png") ]
for f in fnames:
    shutil.copy( os.path.join("examples",f), dname )

# create the release archive
os.chdir( dist_dir )
print()
print( "Generating release archive: {}".format( output_fname ) )
shutil.make_archive( output_fname2, output_fmt )
file_size = os.path.getsize( output_fname )
print( "- Done: {0:.1f} MB".format( float(file_size) / 1024 / 1024 ) )

# clean up
if cleanup:
    os.chdir( BASE_DIR ) # so we can delete the build directory :-/
    os.unlink( target_name + ".spec" )
    shutil.rmtree( build_dir )
    shutil.rmtree( dist_dir )

# log the elapsed time
elapsed_time = time.time() - start_time
print()
print( "Elapsed time: {}".format( datetime.timedelta( seconds=int(elapsed_time) ) ) )