孤独求学人

python pytinstaller 打包项目为可执行的exe文件

2015-1-10 杜世伟 Python

Python不是每个人的计算机里面都有安装（尤其是windows系统下），当您写了一个好用的工具，需要一个standalone exectuable环境的需求。并且用python写些脚本什么的，有时候脚本写完以后，每次运行都得在IDE打开在运行，很麻烦，所以经常将python编译成exe。
可以直接在windows下运行而不担心python环境和引用类库的问题，因为在打包exe文件的时候已打包进去所需要的文件。

如果要公开发布程序，最常见的方式就是打包成exe程序了。打包的好处是使用者不需要考虑Python的运行环境，且也容易被接受。但不好的是一般打包出来的程序都比较大，而且由于是依靠模块打包，有可能出现兼容性等问题。

本文介绍如何将一个python项目（或者简单一点一个python脚本文件）转化为windows下的可执行文件。
转化要使用python转换为exe可执行文件的库，一个是py2exe，另外一个就是PyInstaller。

py2exe：
打包好的exe只能在相同的系统下运行，比如你在XP系统用py2exe打包好的exe只能在XP上运行，在win7上肯定有问题，而且也是存在在别的XP机子上也可能不能运行，因为一些别的机子可能会缺少dll文件；
打包的文件也需要打包同exe下的dll，和一些库的压缩包，不然exe根本跑不起来
还需要另外的其他库文件配置。

PyInstaller：
可以只是生成单独的可执行程序
且支持的版本也多：2.3到2.7都支持。以及x64也支持
也可以自定义图标

笔者常用的打包模块是pyinstaller,pyinstaller支持python2和python3

安装pyinstaller
1）通过python的包工具pip命令安装：
pip install pyinstaller

推荐使用pip安装
pip install pyinstaller -i https://pypi.douban.com/simple
后面加的-i https://pypi.douban.com/simple是使用豆瓣的源镜像，在天朝速度会快很多；如果你担心安全问题或者网速够快，可以不加，使用官方的源。

2) 通过下载安装：
#http://www.pyinstaller.org 或

#http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/

pyinstaller使用方法：

PyInstaller -F test01.py
参数-F 可将单个代码打包成单个exe程序。

另外如果是GUI程序不需要控制台窗口的还可以加上-w参数：
PyInstaller.exe -F -w test01.py

如果在windos下打包exe不需要控制台可以添加--windowed参数:
PyInstaller.exe -F -windowed test01.py

参数说明：

pyinstaller.exe --help
usage: pyinstaller [-h] [-v] [-D] [-F] [--specpath DIR] [-n NAME]
                   [--add-data <SRC;DEST or SRC:DEST>]
                   [--add-binary <SRC;DEST or SRC:DEST>] [-p DIR]
                   [--hidden-import MODULENAME]
                   [--additional-hooks-dir HOOKSPATH]
                   [--runtime-hook RUNTIME_HOOKS] [--exclude-module EXCLUDES]
                   [--key KEY] [-d] [-s] [--noupx] [-c] [-w]
                   [-i <FILE.ico or FILE.exe,ID or FILE.icns>]
                   [--version-file FILE] [-m <FILE or XML>] [-r RESOURCE]
                   [--uac-admin] [--uac-uiaccess] [--win-private-assemblies]
                   [--win-no-prefer-redirects]
                   [--osx-bundle-identifier BUNDLE_IDENTIFIER]
                   [--distpath DIR] [--workpath WORKPATH] [-y]
                   [--upx-dir UPX_DIR] [-a] [--clean] [--log-level LEVEL]
                   [--upx UPX]
                   scriptname [scriptname ...]

positional arguments:
  scriptname            name of scriptfiles to be processed or exactly one
                        .spec-file

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Show program version info and exit.
  --distpath DIR        Where to put the bundled app (default: .\dist)
  --workpath WORKPATH   Where to put all the temporary work files, .log, .pyz
                        and etc. (default: .\build)
  -y, --noconfirm       Replace output directory (default:
                        SPECPATH\dist\SPECNAME) without asking for
                        confirmation
  --upx-dir UPX_DIR     Path to UPX utility (default: search the execution
                        path)
  -a, --ascii           Do not include unicode encoding support (default:
                        included if available)
  --clean               Clean PyInstaller cache and remove temporary files
                        before building.
  --log-level LEVEL     Amount of detail in build-time console messages. LEVEL
                        may be one of DEBUG, INFO, WARN, ERROR, CRITICAL
                        (default: INFO).

What to generate:
  -D, --onedir          Create a one-folder bundle containing an executable
                        (default)
  -F, --onefile         Create a one-file bundled executable.
  --specpath DIR        Folder to store the generated spec file (default:
                        current directory)
  -n NAME, --name NAME  Name to assign to the bundled app and spec file
                        (default: first script's basename)

What to bundle, where to search:
  --add-data <SRC;DEST or SRC:DEST>
                        Additional non-binary files or folders to be added to
                        the executable. The path separator is platform
                        specific, ``os.pathsep`` (which is ``;`` on Windows
                        and ``:`` on most unix systems) is used. This option
                        can be used multiple times.
  --add-binary <SRC;DEST or SRC:DEST>
                        Additional binary files to be added to the executable.
                        See the ``--add-data`` option for more details. This
                        option can be used multiple times.
  -p DIR, --paths DIR   A path to search for imports (like using PYTHONPATH).
                        Multiple paths are allowed, separated by ';', or use
                        this option multiple times
  --hidden-import MODULENAME, --hiddenimport MODULENAME
                        Name an import not visible in the code of the
                        script(s). This option can be used multiple times.
  --additional-hooks-dir HOOKSPATH
                        An additional path to search for hooks. This option
                        can be used multiple times.
  --runtime-hook RUNTIME_HOOKS
                        Path to a custom runtime hook file. A runtime hook is
                        code that is bundled with the executable and is
                        executed before any other code or module to set up
                        special features of the runtime environment. This
                        option can be used multiple times.
  --exclude-module EXCLUDES
                        Optional module or package (the Python name, not the
                        path name) that will be ignored (as though it was not
                        found). This option can be used multiple times.
  --key KEY             The key used to encrypt Python bytecode.

How to generate:
  -d, --debug           Tell the bootloader to issue progress messages while
                        initializing and starting the bundled app. Used to
                        diagnose problems with missing imports.
  -s, --strip           Apply a symbol-table strip to the executable and
                        shared libs (not recommended for Windows)
  --noupx               Do not use UPX even if it is available (works
                        differently between Windows and *nix)

Windows and Mac OS X specific options:
  -c, --console, --nowindowed
                        Open a console window for standard i/o (default)
  -w, --windowed, --noconsole
                        Windows and Mac OS X: do not provide a console window
                        for standard i/o. On Mac OS X this also triggers
                        building an OS X .app bundle. This option is ignored
                        in *NIX systems.
  -i <FILE.ico or FILE.exe,ID or FILE.icns>, --icon <FILE.ico or FILE.exe,ID or FILE.icns>
                        FILE.ico: apply that icon to a Windows executable.
                        FILE.exe,ID, extract the icon with ID from an exe.
                        FILE.icns: apply the icon to the .app bundle on Mac OS
                        X

Windows specific options:
  --version-file FILE   add a version resource from FILE to the exe
  -m <FILE or XML>, --manifest <FILE or XML>
                        add manifest FILE or XML to the exe
  -r RESOURCE, --resource RESOURCE
                        Add or update a resource to a Windows executable. The
                        RESOURCE is one to four items,
                        FILE[,TYPE[,NAME[,LANGUAGE]]]. FILE can be a data file
                        or an exe/dll. For data files, at least TYPE and NAME
                        must be specified. LANGUAGE defaults to 0 or may be
                        specified as wildcard * to update all resources of the
                        given TYPE and NAME. For exe/dll files, all resources
                        from FILE will be added/updated to the final
                        executable if TYPE, NAME and LANGUAGE are omitted or
                        specified as wildcard *.This option can be used
                        multiple times.
  --uac-admin           Using this option creates a Manifest which will
                        request elevation upon application restart.
  --uac-uiaccess        Using this option allows an elevated application to
                        work with Remote Desktop.

Windows Side-by-side Assembly searching options (advanced):
  --win-private-assemblies
                        Any Shared Assemblies bundled into the application
                        will be changed into Private Assemblies. This means
                        the exact versions of these assemblies will always be
                        used, and any newer versions installed on user
                        machines at the system level will be ignored.
  --win-no-prefer-redirects
                        While searching for Shared or Private Assemblies to
                        bundle into the application, PyInstaller will prefer
                        not to follow policies that redirect to newer
                        versions, and will try to bundle the exact versions of
                        the assembly.

Mac OS X specific options:
  --osx-bundle-identifier BUNDLE_IDENTIFIER
                        Mac OS X .app bundle identifier is used as the default
                        unique program name for code signing purposes. The
                        usual form is a hierarchical name in reverse DNS
                        notation. For example:
                        com.mycompany.department.appname (default: first
                        script's basename)

Obsolete options (not used anymore):
  --upx UPX, -X UPX, -K UPX, --tk UPX, -C UPX, --configfile UPX, --skip-configure UPX, -o UPX, --out UPX, --buildpath UPX
                        These options do not exist anymore.

Note:--onefile前面是两个-
-F　　　　制作独立的可执行程序
-D　　　　制作出的档案存放在同一个文件夹下（默认值）
-K　　　　包含TCL/TK（对于使用了TK的，最好加上这个选项，否则在未安装TK的电脑上无法运行）
-w　　　  制作窗口程序
-c　　　　制作命令行程序（默认）
-X　　　　制作使用UPX压缩过的可执行程序（推荐使用这个选项，需要下载UPX包，解压后upx.exe放在Python(非PyInstaller)安装目录下，下载upx308w.zip）
-o DIR　　指定输出SPEC文件路径（这也决定了最后输出的exe文件路径）
--icon=[ICO文件路径] 指定程序图标
-v [指定文件] 指定程序版本信息
-n [指定程序名] 指定程序名称

标签: python pyinstaller pyexe