Python程序打包工具PyInstaller

Python程序执行

• py文件：直接提供源码，需要使用者自行安装Python并且安装依赖的各种库
• pyc文件：pyc文件是Python解释器可以识别的二进制码，是跨平台的，需要使用者安装相应版本的Python和依赖库
• 可执行文件：对于非码农用户或者一些小白用户，你让他装个Python同时还要折腾一堆依赖库，那简直是个灾难。对于此类用户，最简单的方式就是提供一个可执行文件，只需要把用法告诉Ta即可。比较麻烦的是需要针对不同平台需要打包不同的可执行文件（Windows,Linux,Mac,…）

各种打包工具对比参考文章:Freezing Your Code

pyInstaller 官方地址

PyInstaller freezes (packages) Python applications into stand-alone executables, under Windows, GNU/Linux, Mac OS X, FreeBSD, Solaris and AIX.
可以执行pip命令进行安装

pip install pyinstaller

打包python脚本

例如我想将send_msg.py打包成单一文件，执行pyinstaller -F send_msg.py即可

E:\Programs\Python\Tools>pyinstaller -F send_msg.py
79 INFO: PyInstaller: 3.4
79 INFO: Python: 3.7.2
80 INFO: Platform: Windows-10-10.0.10240-SP0
80 INFO: wrote E:\Programs\Python\Tools\send_msg.spec
82 INFO: UPX is not available.
83 INFO: Extending PYTHONPATH with paths
['E:\\Programs\\Python\\Tools', 'E:\\Programs\\Python\\Tools']
83 INFO: checking Analysis
83 INFO: Building Analysis because Analysis-00.toc is non existent
83 INFO: Initializing module dependency graph...
85 INFO: Initializing module graph hooks...
86 INFO: Analyzing base_library.zip ...
4458 INFO: running Analysis Analysis-00.toc
4523 INFO: Adding Microsoft.Windows.Common-Controls to dependent assemblies of final executable
  required by c:\python37\python.exe
5295 INFO: Caching module hooks...
5299 INFO: Analyzing E:\Programs\Python\Tools\send_msg.py
5854 INFO: Processing pre-safe import module hook   urllib3.packages.six.moves
7045 INFO: Loading module hooks...
7045 INFO: Loading module hook "hook-encodings.py"...
7108 INFO: Loading module hook "hook-pydoc.py"...
7109 INFO: Loading module hook "hook-selenium.py"...
7114 INFO: Loading module hook "hook-xml.dom.domreg.py"...
7114 INFO: Loading module hook "hook-xml.py"...
7126 INFO: Looking for ctypes DLLs
7132 INFO: Analyzing run-time hooks ...
7139 INFO: Looking for dynamic libraries
8099 INFO: Looking for eggs
8100 INFO: Using Python library c:\python37\python37.dll
8101 INFO: Found binding redirects:
[]
8105 INFO: Warnings written to E:\Programs\Python\Tools\build\send_msg\warn-send_msg.txt
8150 INFO: Graph cross-reference written to E:\Programs\Python\Tools\build\send_msg\xref-send_msg.html
8167 INFO: checking PYZ
8167 INFO: Building PYZ because PYZ-00.toc is non existent
8167 INFO: Building PYZ (ZlibArchive) E:\Programs\Python\Tools\build\send_msg\PYZ-00.pyz
8727 INFO: Building PYZ (ZlibArchive) E:\Programs\Python\Tools\build\send_msg\PYZ-00.pyz completed successfully.
8734 INFO: checking PKG
8734 INFO: Building PKG because PKG-00.toc is non existent
8734 INFO: Building PKG (CArchive) PKG-00.pkg
10524 INFO: Building PKG (CArchive) PKG-00.pkg completed successfully.
10527 INFO: Bootloader c:\python37\lib\site-packages\PyInstaller\bootloader\Windows-64bit\run.exe
10527 INFO: checking EXE
10528 INFO: Building EXE because EXE-00.toc is non existent
10528 INFO: Building EXE from EXE-00.toc
10528 INFO: Appending archive to EXE E:\Programs\Python\Tools\dist\send_msg.exe
10536 INFO: Building EXE from EXE-00.toc completed successfully.

执行完，目录中内容如图所示：

打开dist文件就可找到可执行文件了

pyinstaller --help

E:\Programs\Python\Tools>pyinstaller --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 [{all,imports,bootloader,noarchive}]] [-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]
                   [--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, by specifying one or more of the
                        following choices.

                        - all: All three of the below options; this is the
                          default choice, unless one of the choices below is
                          specified.

                        - 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)

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)

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.

然后将如下文件夹整包放到其他机器上即可运行 注意：一定要将所需的第三方库或模块或者应用程序一起，例如如下程序用到了chromedriver.exe 在打完包后我又将chromedriver.exe放到了dist文件夹下，一起发送到了要运行该程序的机器中