PyInstaller使用指南与详细文档

需积分: 0 196 浏览量更新于2024-06-17 收藏 962KB PDF 举报

"PyInstaller手册是关于PyInstaller工具的详细文档，涵盖了从快速入门到高级主题的所有内容，包括安装、工作原理、使用方法、特定功能的注意事项、问题解决、钩子机制等。PyInstaller主要用于将Python应用程序及其依赖项打包成独立的可执行文件，适用于多个平台。" PyInstaller是一个开源的Python工具，它允许开发者将Python程序及其所有依赖项打包成独立的可执行文件，这些文件可以在没有Python解释器的环境中运行。这使得Python应用程序能够更方便地分发给用户，而无需安装完整的Python环境。 1. **快速启动**：这部分通常会指导用户如何通过简单的命令行选项快速创建一个基本的捆绑包，以便他们可以立即开始打包自己的应用程序。 2. **需求**：PyInstaller可能需要特定版本的Python和其他依赖库，这部分会列出这些要求，以确保用户在开始之前具备正确的环境。 3. **许可证**：PyInstaller遵循的开源许可证，通常为用户提供了自由使用、修改和分发软件的权利。 4. **如何贡献**：对于希望参与项目开发或提交改进的用户，这部分将介绍如何向PyInstaller项目贡献代码或报告问题。 5. **安装PyInstaller**：详细步骤说明如何在不同的操作系统上安装PyInstaller，包括使用pip或其他安装方法。 6. **PyInstaller的工作原理**：解释了PyInstaller如何分析Python源代码，找出所有依赖，并将其打包进可执行文件。 7. **使用PyInstaller**：包含如何运行PyInstaller，设置选项，以及自定义打包过程的详细说明。 8. **运行时信息**：讨论了捆绑应用程序在运行时的行为，如日志记录、环境变量等。 9. **使用spec文件**：spec文件是PyInstaller的配置文件，用于定制打包过程。这部分将介绍如何创建和编辑spec文件以满足特定需求。 10. **特定功能的笔记**：涵盖了一些特殊功能或问题，比如处理非标准的Python模块、打包数据文件等。 11. **问题解决**：当打包过程中出现问题时，这部分提供了解决常见问题的策略和提示。 12. **高级主题**：深入探讨PyInstaller的高级特性，如自定义钩子(hooks)和更复杂的打包配置。 13. **理解PyInstaller钩子**：钩子是PyInstaller用来处理特定库或模块的关键部分，它们允许自定义打包过程以正确处理特定的Python扩展或第三方库。 14. **钩子配置选项**：详细介绍了如何配置和编写钩子脚本来控制捆绑过程。 15. **构建引导加载器**：对于需要自定义引导加载器或者从源代码构建PyInstaller的用户，这部分提供了指南。 16. **更新日志**：记录了PyInstaller每个版本的更改和改进。 17. **致谢**：感谢对PyInstaller项目做出贡献的人员。 18. **手册和开发指南**：包含了PyInstaller的手册页和开发指南，帮助开发者更好地理解和改进工具。 19. **索引和表格**：提供文档的完整索引，方便查找特定信息。通过这个手册，无论是初学者还是有经验的开发者，都能获得打包Python应用所需的所有信息。

PyInstaller Documentation, Release 6.3.0

As noted in the CPython tutorial Appendix, for Windows a ﬁle extension of .pyw suppresses the console window

that normally appears. Likewise, a console window will not be provided when using a myscript.pyw script with

PyInstaller.

2.5.7 Hiding the Source Code

The bundled app does not include any source code. However, PyInstaller bundles compiled Python scripts (.pyc ﬁles).

These could in principle be decompiled to reveal the logic of your code.

If you want to hide your source code more thoroughly, one possible option is to compile some of your modules with

Cython. Using Cython you can convert Python modules into C and compile the C to machine language. PyInstaller

can follow import statements that refer to Cython C object modules and bundle them.

2.6 Using PyInstaller

The syntax of the pyinstaller command is:

pyinstaller [options] script [script . ..] | specﬁle

In the most simple case, set the current directory to the location of your program myscript.py and execute:

pyinstaller myscript.py

PyInstaller analyzes myscript.py and:

• Writes myscript.spec in the same folder as the script.

• Creates a folder build in the same folder as the script if it does not exist.

• Writes some log ﬁles and working ﬁles in the build folder.

• Creates a folder dist in the same folder as the script if it does not exist.

• Writes the myscript executable folder in the dist folder.

In the dist folder you ﬁnd the bundled app you distribute to your users.

Normally you name one script on the command line. If you name more, all are analyzed and included in the output.

However, the ﬁrst script named supplies the name for the spec ﬁle and for the executable folder or ﬁle. Its code is the

ﬁrst to execute at run-time.

For certain uses you may edit the contents of myscript.spec (described under Using Spec Files). After you do this,

you name the spec ﬁle to PyInstaller instead of the script:

pyinstaller myscript.spec

The myscript.spec ﬁle contains most of the information provided by the options that were speciﬁed when

pyinstaller (or pyi-makespec) was run with the script ﬁle as the argument. You typically do not need to specify

any options when running pyinstaller with the spec ﬁle. Only a few command-line options have an eﬀect when

building from a spec ﬁle.

You may give a path to the script or spec ﬁle, for example

pyinstaller options.. . ~/myproject/source/myscript.py

or, on Windows,

pyinstaller "C:\Documents and Settings\project\myscript.spec"

12 Chapter 2. Contents:

PyInstaller Documentation, Release 6.3.0

What To Bundle, Where To Search

--add-data SOURCE:DEST

Additional data ﬁles or directories containing data ﬁles to be added to the application. The argument value

should be in form of “source:dest_dir”, where source is the path to ﬁle (or directory) to be collected, dest_dir is

the destination directory relative to the top-level application directory, and both paths are separated by a colon

(:). To put a ﬁle in the top-level application directory, use . as a dest_dir. This option can be used multiple times.

--add-binary SOURCE:DEST

Additional binary ﬁles to be added to the executable. See the --add-data option for the format. 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. Equivalent to supplying the pathex argument in the spec ﬁle.

--hidden-import MODULENAME, --hiddenimport MODULENAME

Name an import not visible in the code of the script(s). This option can be used multiple times.

--collect-submodules MODULENAME

Collect all submodules from the speciﬁed package or module. This option can be used multiple times.

--collect-data MODULENAME, --collect-datas MODULENAME

Collect all data from the speciﬁed package or module. This option can be used multiple times.

--collect-binaries MODULENAME

Collect all binaries from the speciﬁed package or module. This option can be used multiple times.

--collect-all MODULENAME

Collect all submodules, data ﬁles, and binaries from the speciﬁed package or module. This option can be used

multiple times.

--copy-metadata PACKAGENAME

Copy metadata for the speciﬁed package. This option can be used multiple times.

--recursive-copy-metadata PACKAGENAME

Copy metadata for the speciﬁed package and all its dependencies. 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 ﬁle. 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.

--splash IMAGE_FILE

(EXPERIMENTAL) Add an splash screen with the image IMAGE_FILE to the application. The splash screen

can display progress updates while unpacking.

14 Chapter 2. Contents:

PyInstaller Documentation, Release 6.3.0

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

(ﬁlename 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 ﬁles as an

archive inside the resulting executable, store them as ﬁles in the resulting output directory.

--python-option PYTHON_OPTION

Specify a command-line option to pass to the Python interpreter at runtime. Currently supports “v” (equivalent

to “–debug imports”), “u”, “W <warning control>”, “X <xoption>”, and “hash_seed=<value>”. For details, see

the section “Specifying Python Interpreter Options” in PyInstaller manual.

-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 diﬀerently 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 ﬁlename of the binary without path. This option can be used multiple times.

Windows And Mac Os X Speciﬁc Options

-c, --console, --nowindowed

Open a console window for standard i/o (default). On Windows this option has no eﬀect if the ﬁrst script is a

‘.pyw’ ﬁle.

-w, --windowed, --noconsole

Windows and Mac OS X: do not provide a console window for standard i/o. On Mac OS this also triggers

building a Mac OS .app bundle. On Windows this option is automatically set if the ﬁrst script is a ‘.pyw’ ﬁle.

This option is ignored on *NIX systems.

--hide-console {minimize-late,hide-early,minimize-early,hide-late}

Windows only: in console-enabled executable, have bootloader automatically hide or minimize the console win-

dow if the program owns the console window (i.e., was not launched from an existing console window).

-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">, --icon <FILE.ico or FILE.

exe,ID or FILE.icns or Image or "NONE">

FILE.ico: apply the 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. If an image ﬁle is entered that isn’t in the platform format (ico

on Windows, icns on Mac), PyInstaller tries to use Pillow to translate the icon into the correct format (if Pillow

is installed). Use “NONE” to not apply any icon, thereby making the OS show some default (default: apply

PyInstaller’s icon). This option can be used multiple times.

--disable-windowed-traceback

Disable traceback dump of unhandled exception in windowed (noconsole) mode (Windows and macOS only),

and instead display a message that this feature is disabled.

2.6. Using PyInstaller 15

PyInstaller Documentation, Release 6.3.0

Windows Speciﬁc 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 ﬁle or an exe/dll. For data ﬁles, at least TYPE and

NAME must be speciﬁed. LANGUAGE defaults to 0 or may be speciﬁed as wildcard * to update all resources

of the given TYPE and NAME. For exe/dll ﬁles, all resources from FILE will be added/updated to the ﬁnal

executable if TYPE, NAME and LANGUAGE are omitted or speciﬁed as wildcard *. This option can be used

multiple times.

--uac-admin

Using this option creates a Manifest that will request elevation upon application start.

--uac-uiaccess

Using this option allows an elevated application to work with Remote Desktop.

Mac Os Speciﬁc Options

--argv-emulation

Enable argv emulation for macOS app bundles. If enabled, the initial open document/URL event is processed

by the bootloader and the passed ﬁle paths or URLs are appended to sys.argv.

--osx-bundle-identifier BUNDLE_IDENTIFIER

Mac OS .app bundle identiﬁer 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: ﬁrst script’s basename)

--target-architecture ARCH, --target-arch ARCH

Target architecture (macOS only; valid values: x86_64, arm64, universal2). Enables switching between univer-

sal2 and single-arch version of frozen application (provided python installation supports the target architecture).

If not target architecture is not speciﬁed, the current running architecture is targeted.

--codesign-identity IDENTITY

Code signing identity (macOS only). Use the provided identity to sign collected binaries and generated exe-

cutable. If signing identity is not provided, ad- hoc signing is performed instead.

--osx-entitlements-file FILENAME

Entitlements ﬁle to use when code-signing the collected binaries (macOS only).

Rarely Used Special Options

--runtime-tmpdir PATH

Where to extract libraries and support ﬁles in oneﬁle-mode. If this option is given, the bootloader will ignore

any temp-folder location deﬁned 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

for example a supervisor process signals both the bootloader and the child (e.g., via a process group) to avoid

signalling the child twice.

16 Chapter 2. Contents:

剩余227页未读，继续阅读

努力躺平的程序员

粉丝: 155
资源: 4

PyInstaller使用指南与详细文档

iconic获取 pyinstaller

pyinstaller.zip

python pyinstaller库使用指南

PyInstaller使用手册

PyInstaller使用手册：从入门到精通

PyInstaller使用手册：从安装到创建执行文件

PyInstaller Manual

PyInstaller打包

pyinstaller-1.5.1

python pyinstaller库打包辅助upx，可以减少打包完的体积

最新资源