pyinstaller 工具 生成Python可执行文件

概述

pyinstaller可以用来打包python应用程序，打包完的程序就可以在没有安装Python解释器的机器上运行了。pyinstaller支持Python 2.7和Python 3.3+版本。可以在Windows、Mac OS X和Linux上使用，但是并不是跨平台的，就是说你打包成了.exe文件，就只能在Windows系统上运行；打包成mac app，就只能在Mac OS上使用。

优点：

• 多平台：Windows、Linux、Mac OS X、FreeBSD、Solaris和AIX，在windows下生成EXE可行
• 多版本：Python 2.7和3.3 - 3.5
• 使用简单，目前最简单的了，其他工具更复杂
• 用的人多，决定了可以找到的参考资料的多少
• 支持UPX压缩，可以有效的减小文件体积

缺点：

• 文件体积大，要把Python的库、DLL(动态库)等都打包进去，所以软件体积大，压缩后还是大
• 启动慢，估计要先逐步调用运行库，所以启动的时间慢

pyinstaller相关参数

-F, –onefile	打包一个单个文件，如果你的代码都写在一个.py文件的话，可以用这个，如果是多个.py文件就别用
-D, –onedir	打包多个文件，在dist中生成很多依赖文件，适合以框架形式编写工具代码，我个人比较推荐这样，代码易于维护
-K, –tk	在部署时包含 TCL/TK
-a, –ascii	不包含编码.在支持Unicode的python版本上默认包含所有的编码.
-d, –debug	产生debug版本的可执行文件
-w,–windowed,–noconsole	使用Windows子系统执行.当程序启动的时候不会打开命令行(只对Windows有效)
-c,–nowindowed,–console	使用控制台子系统执行(默认)(只对Windows有效)
pyinstaller -c xxxx.py
pyinstaller xxxx.py --console
-s,–strip	可执行文件和共享库将run through strip.注意Cygwin的strip往往使普通的win32 Dll无法使用.
-X, –upx	如果有UPX安装(执行Configure.py时检测),会压缩执行文件(Windows系统中的DLL也会)(参见note)
-o DIR, –out=DIR	指定spec文件的生成目录,如果没有指定,而且当前目录是PyInstaller的根目录,会自动创建一个用于输出(spec和生成的可执行文件)的目录.如果没有指定,而当前目录不是PyInstaller的根目录,则会输出到当前的目录下.
-p DIR, –path=DIR	设置导入路径(和使用PYTHONPATH效果相似).可以用路径分割符(Windows使用分号,Linux使用冒号)分割,指定多个目录.也可以使用多个-p参数来设置多个导入路径，让pyinstaller自己去找程序需要的资源
–icon=<FILE.ICO>	将file.ico添加为可执行文件的资源(只对Windows系统有效)，改变程序的图标 pyinstaller -i ico路径 xxxxx.py
–icon=<FILE.EXE,N>	将file.exe的第n个图标添加为可执行文件的资源(只对Windows系统有效)
-v FILE, –version=FILE	将verfile作为可执行文件的版本资源(只对Windows系统有效)
-n NAME, –name=NAME	可选的项目(产生的spec的)名字.如果省略,第一个脚本的主文件名将作为spec的名字

打包例子

在linux上执行pyinstaller -F my-test.py

/root/test/# pyinstaller -F my-test.py
64 INFO: PyInstaller: 3.4
65 INFO: Python: 2.7.12
65 INFO: Platform: Linux-4.10.0-28-generic-x86_64-with-Ubuntu-16.04-xenial
65 INFO: wrote /root/test/my-test.spec
72 INFO: UPX is not available.
73 INFO: Extending PYTHONPATH with paths
['/root/test', '/root/test']
73 INFO: checking Analysis
73 INFO: Building Analysis because Analysis-00.toc is non existent
73 INFO: Initializing module dependency graph...
75 INFO: Initializing module graph hooks...
147 INFO: running Analysis Analysis-00.toc
175 INFO: Caching module hooks...
180 INFO: Analyzing /root/test/my-test.py
2382 INFO: Loading module hooks...
2383 INFO: Loading module hook "hook-httplib.py"...
2384 INFO: Loading module hook "hook-encodings.py"...
3168 INFO: Looking for ctypes DLLs
3168 INFO: Analyzing run-time hooks ...
3175 INFO: Looking for dynamic libraries
3418 INFO: Looking for eggs
3418 INFO: Python library not in binary dependencies. Doing additional searching...
3469 INFO: Using Python library /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0
3472 INFO: Warnings written to /root/test/build/my-test/warn-my-test.txt
3500 INFO: Graph cross-reference written to /root/test/build/my-test/xref-my-test.html
3558 INFO: checking PYZ
3558 INFO: Building PYZ because PYZ-00.toc is non existent
3558 INFO: Building PYZ (ZlibArchive) /root/test/build/my-test/PYZ-00.pyz
3844 INFO: Building PYZ (ZlibArchive) /root/test/build/my-test/PYZ-00.pyz completed successfully.
3894 INFO: checking PKG
3894 INFO: Building PKG because PKG-00.toc is non existent
3894 INFO: Building PKG (CArchive) PKG-00.pkg
6470 INFO: Building PKG (CArchive) PKG-00.pkg completed successfully.
6480 INFO: Bootloader /usr/local/lib/python2.7/dist-packages/PyInstaller/bootloader/Linux-64bit/run
6481 INFO: checking EXE
6481 INFO: Building EXE because EXE-00.toc is non existent
6481 INFO: Building EXE from EXE-00.toc
6481 INFO: Appending archive to ELF section in EXE /root/test/dist/my-test
6503 INFO: Building EXE from EXE-00.toc completed successfully.

在同级目录下生成dist和build目录，dist目录下有最终文件

-F 与-D区别

-F, --onefile：表示将程序打包成一个可执行文件。在这个可执行文件里面，包含了程序运行的所有依赖，包括：python解释器、依赖包等。对外发布时，只需要发布这一个可执行文件即可。用户拿到这个文件就可以在对应的平台上运行。需要注意的时，pyinstaller不管是打包成文件还是目录，虽然用户看不到源码了，但pyinstaller并没有进行编译工作，只是简单的把依赖包、python解释器以及源文件进行了打包处理。当用户在运行这个可执行文件时，会自动对这个可执行文件进行解压，在/tmp目录下生成一个以_MEI******的临时文件，当程序正常运行结束，这个临时文件会被自动删除。注意是正常退出才会自动删除，如果是异常退出那么这个临时文件时不会被删除的。我们的CI有模拟程序异常退出的用例，这就导致/tmp目录下有太多临时目录，久而久之，根磁盘空间就不足了。

-D, --onedir：这个选项表示将程序打包成一个目录，对外发布时就可以只发布这个目录了，在这个目录里面包含了程序运行的所有依赖。在上面的-F参数提到，打包成文件当运行时会产生一个临时目录，打包成目录时就不会有这种情况，因为本身就是以目录形式存在。所以打包成目录的程序启动时要比打包成文件的的程序启动快，因为少了一步解压生成临时目录的过程。

打包成文件夹和单一可执行文件的优缺点：

• 启动时间
  单一可执行文件比文件夹的启动时间要长
  因为当程序运行时，单一的可执行文件需要解压程序的第三方依赖文件到临时文件夹中。

• 文件结构
  单一可执行文件的文件结构和工程目录是一样的，但是生成文件夹就不一样了，若程序中包含相对路径，这个相对路径自然基于的是文件夹目录，这点需要注意。