【解决方案】Pyinstaller打包exe文件详细教程

Dear 丶 2023-02-13 08:08 24阅读 0赞

> 在业务场景中， 经常需要Python开发一些小程序/脚本/GUI界面，交付给一些小白或未安装Python 的小伙伴们使用。  
> 噔噔蹬蹬  
> pyinstaller 闪亮登场

### 场景说明 ###

*  使用Pyinstaller将Python脚本或者项目打包，生成可执行的.exe文件。
 *  Pyinstaller是一个很不错的免费打包工具，支持Windows，Linux和MacOS，完美支持32位和64位系统。
 *  除了Pyinstaller， 还可以使用py2exe进行打包

### pyinstaller安装 ###

pip install pyinstaller

### 打包参数 ###

# 常用打包参数
    # -F -D互斥参数
    -F  打包成一个exe文件，小项目可以采用，打开比较慢，多个.py打包时不能使用
    -D  默认参数，打包结果放入到创建的文件夹中，可以看到里面有很多的依赖文件
    
    # -w -c互斥参数
    -w  使用项目的GUI界面，无cmd控制台
    -c  默认参数，使用cmd控制台 如果打包文件执行报错，可尝试用-c 显示控制台
    
    -n  执行项目的名称，默认.py的文件名
    -i  将ico图标打包到exe文件中
    
    --hidden-import 打包时导包信息
    # 打包PyQt项目强烈建议 带上以下参数
    --hidden-import PyQt5.sip
    
    # 打包命令示例
    # 在项目的根目录下执行打包命令
    pyinstaller -w xxx.py --hidden-import PyQt5.sip
     
    # 打包结果输出在项目根目录下的 dist文件夹中
    # 不建议使用 -F打包成一个exe文件 所谓：打包一时爽，打开5秒钟
    # 非-F命令下， 静态资源、建好的Sqlite数据库可以直接放入dist中 生成的文件夹中

### 说明 ###

1.  Pyinstaller只是将Python解释器和脚本打包成一个可执行文件， 不同于编译成真正的机器码。所以代码的运行效率是降低的，只是解决了小白用户的操作难度。
2.  打包时会分析项目的依赖，并将相关的依赖打包进来，并进行加密处理
3.  不同的操作系统， 需要在不同的操作系统进行打包。

### 打包问题解决方法汇总 ###

#### debug ####

*  控制台debug  
    在本地运行成功， 建议在第一次打包exe时使用 `-c`命令，这样可以在控制台中显示可能的报错信息。  
    如果打包时没有用`-c`不会出现控制台或者控制台一闪而过，看不到报错信息， 可以在cmd命令行窗口执行exe文件
 *  fatal error faild to execute script file  
    Pyinstaller打包时有些库没有打包进去，可以将报错信息中的库通过 `--hidden-import 报错的包` 的进行打包

[pyinstaller 打包python3.6+PyQt5中各种错误的解决方案][pyinstaller _python3.6_PyQt5]

*  依赖报错
 *  打包结果文件过大

### 帮助中的参数 ###

>>> pyinstaller -h
    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 { all,imports,bootloader,noarchive}] [-s]
                       [--noupx] [--upx-exclude FILE] [-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]
                       [--runtime-tmpdir PATH] [--bootloader-ignore-signals]
                       [--distpath DIR] [--workpath WORKPATH] [-y]
                       [--upx-dir UPX_DIR] [-a] [--clean] [--log-level LEVEL]
                       scriptname [scriptname ...]
    
    positional arguments:
      scriptname            name of scriptfiles to be processed or exactly one
                            .spec-file. If a .spec-file is specified, most options
                            are unnecessary and are ignored.
    
    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 TRACE, 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 {all,imports,bootloader,noarchive}, --debug {all,imports,bootloader,noarchive} Provide assistance with debugging a frozen application. This argument may be provided multiple times to select several of the following options. - all: All three of the following options. - imports: specify the -v option to the underlying Python interpreter, causing it to print a message each time a module is initialized, showing the place (filename or built-in module) from which it is loaded. See https://docs.python.org/3/using/cmdline.html#id4. - bootloader: tell the bootloader to issue progress messages while initializing and starting the bundled app. Used to diagnose problems with missing imports. - noarchive: instead of storing all frozen Python source files as an archive inside the resulting executable, store them as files in the resulting output directory. -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) --upx-exclude FILE Prevent a binary from being compressed when using upx. This is typically used if upx corrupts certain binaries during compression. FILE is the filename of the binary without path. This option can be used multiple times. Windows and Mac OS X specific options: -c, --console, --nowindowed Open a console window for standard i/o (default). On Windows this option will have no effect if the first script is a '.pyw' file. -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. On Windows this option will be set if the first script is a '.pyw' file. 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)
    
    Rarely used special options:
      --runtime-tmpdir PATH
                            Where to extract libraries and support files in
                            `onefile`-mode. If this option is given, the
                            bootloader will ignore any temp-folder location
                            defined by the run-time OS. The ``_MEIxxxxxx``-folder
                            will be created here. Please use this option only if
                            you know what you are doing.
      --bootloader-ignore-signals
                            Tell the bootloader to ignore signals rather than
                            forwarding them to the child process. Useful in
                            situations where e.g. a supervisor process signals
                            both the bootloader and child (e.g. via a process
                            group) to avoid signalling the child twice.

[pyinstaller _python3.6_PyQt5]: https://www.jianshu.com/p/809b4ca6bff5