Python标准库zipapp——管理可执行的Pythonzip打包文件

命令行界面¶

若要从命令行调用，则采用以下形式：

$ python -m zipapp source[options]

如果 source 是个目录，将根据 source 的内容创建一个打包文件。如果 source 是个文件，则应为一个打包文件，将会复制到目标打包文件中（如果指定了 -info 选项，将会显示 shebang 行的内容）。

可以接受以下参数：

-o <output>, --output=<output>¶

将程序的输出写入名为 output 的文件中。若未指定此参数，输出的文件名将与输入的 source 相同，并添加扩展名 .pyz。如果显式给出了文件名，将会原样使用（因此必要时应包含扩展名 .pyz）。

如果 source 是个打包文件，必须指定一个输出文件名（这时 output 必须与 source 不同）。

-p <interpreter>, --python=<interpreter>¶

给打包文件加入 #! 行，以便指定 解释器 作为运行的命令行。另外，还让打包文件在 POSIX 平台上可执行。默认不会写入 #! 行，也不让文件可执行。

-m <mainfn>, --main=<mainfn>¶

在打包文件中写入一个 __main__.py 文件，用于执行 mainfn。mainfn 参数的形式应为 “pkg.mod:fn”，其中 “pkg.mod”是打包文件中的某个包/模块，“fn”是该模块中的一个可调用对象。__main__.py 文件将会执行该可调用对象。

在复制打包文件时，不能设置 --main 参数。

-c, --compress¶

利用 deflate 方法压缩文件，减少输出文件的大小。默认情况下，打包文件中的文件是不压缩的。

在复制打包文件时，--compress 无效。

3.7 新版功能.

--info¶

显示嵌入在打包文件中的解释器程序，以便诊断问题。这时会忽略其他所有参数，SOURCE 必须是个打包文件，而不是目录。

-h, --help¶

打印简短的用法信息并退出。

Python API¶

该模块定义了两个快捷函数：

zipapp.create_archive(source, target=None, interpreter=None, main=None, filter=None, compressed=False)¶

由 source 创建一个应用程序打包文件。source 可以是以下形式之一：

• 一个目录名，或指向目录的 path-like object ，这时将根据目录内容新建一个应用程序打包文件。

• 一个已存在的应用程序打包文件名，或指向这类文件的 path-like object，这时会将该文件复制为目标文件（会稍作修改以反映出 interpreter 参数的值）。必要时文件名中应包括 .pyz 扩展名。

• 一个以字节串模式打开的文件对象。该文件的内容应为应用程序打包文件，且假定文件对象定位于打包文件的初始位置。

target 参数定义了打包文件的写入位置：

• 若是个文件名，或是 path-like object，打包文件将写入该文件中。

• 若是个打开的文件对象，打包文件将写入该对象，该文件对象必须在字节串写入模式下打开。

• 如果省略了 target （或为 None），则 source 必须为一个目录，target 将是与 source 同名的文件，并加上 .pyz 扩展名。

参数 interpreter 指定了 Python 解释器程序名，用于执行打包文件。这将以 “释伴（shebang）”行的形式写入打包文件的头部。在 POSIX 平台上，操作系统会进行解释，而在 Windows 平台则会由 Python 启动器进行处理。省略 interpreter 参数则不会写入释伴行。如果指定了解释器，且目标为文件名，则会设置目标文件的可执行属性位。

参数 main 指定某个可调用程序的名称，用作打包文件的主程序。仅当 source 为目录且不含 __main__.py 文件时，才能指定该参数。main 参数应采用 “pkg.module:callable”的形式，通过导入“pkg.module”并不带参数地执行给出的可调用对象，即可执行打包文件。如果 source 是目录且不含``__main__.py`` 文件，省略 main 将会出错，生成的打包文件将无法执行。

可选参数 filter 指定了回调函数，将传给代表被添加文件路径的 Path 对象（相对于源目录）。在文件添加完成后，应返回 True。

可选参数 compressed 指定是否要压缩打包文件。若设为 True，则打包中的文件将用 deflate 方法进行压缩；否则就不会压缩。本参数在复制现有打包文件时无效。

若 source 或 target 指定的是文件对象，则调用者有责任在调用 create_archive 之后关闭文件。

当复制已有的打包文件时，提供的文件对象只需 read 和 readline 方法，或 write 方法。当由目录创建打包文件时，若目标为文件对象，将会将其传给 类，且必须提供 zipfile.ZipFile 类所需的方法。

3.7 新版功能: 加入了 filter 和 compressed 参数。

zipapp.get_interpreter(archive)¶

返回打包文件开头的 行指定的解释器程序。如果没有 #! 行，则返回 None。参数 archive 可为文件名或在字节串模式下打开以供读取的文件类对象。#! 行假定是在打包文件的开头。

例子¶

将目录打包成一个文件并运行它。

$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>

同样还可用 create_archive() 函数完成：

>>> importzipapp
>>> zipapp.create_archive('myapp','myapp.pyz')

要让应用程序能在 POSIX 平台上直接执行，需要指定所用的解释器。

$ python -m zipapp myapp -p "/usr/bin/env python"
$ ./myapp.pyz
<output from myapp>

若要替换已有打包文件中的释伴行，请用 create_archive() 函数另建一个修改好的打包文件：

>>> importzipapp
>>> zipapp.create_archive('old_archive.pyz','new_archive.pyz','/usr/bin/python3')

若要原地更新打包文件，可用 BytesIO 对象在内存中进行替换，然后再覆盖源文件。注意，原地覆盖文件会有风险，出错时会丢失原文件。这里没有考虑出错情况，但生产代码则应进行处理。另外，这种方案仅当内存足以容纳打包文件时才有意义：

>>> importzipapp
>>> importio
>>> temp=io.BytesIO()
>>> zipapp.create_archive('myapp.pyz',temp,'/usr/bin/python2')
>>> withopen('myapp.pyz','wb')asf:
>>> f.write(temp.getvalue())

#define Py_LIMITED_API 1
#include "Python.h"
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#ifdef WINDOWS
intWINAPIwWinMain(
HINSTANCEhInstance,/*handletocurrentinstance*/
HINSTANCEhPrevInstance,/*handletopreviousinstance*/
LPWSTRlpCmdLine,/*pointertocommandline*/
intnCmdShow/*showstateofwindow*/
)
#else
intwmain()
#endif
{
wchar_t**myargv=_alloca((__argc+1)*sizeof(wchar_t*));
myargv[0]=__wargv[0];
memcpy(myargv+1,__wargv,__argc*sizeof(wchar_t*));
returnPy_Main(__argc+1,myargv);
}

>>> fromdistutils.ccompilerimportnew_compiler
>>> importdistutils.sysconfig
>>> importsys
>>> importos
>>> frompathlibimportPath
>>> defcompile(src):
>>> src=Path(src)
>>> cc=new_compiler()
>>> exe=src.stem
>>> cc.add_include_dir(distutils.sysconfig.get_python_inc())
>>> cc.add_library_dir(os.path.join(sys.base_exec_prefix,'libs'))
>>> # First the CLI executable
>>> objs=cc.compile([str(src)])
>>> cc.link_executable(objs,exe)
>>> # Now the GUI executable
>>> cc.define_macro('WINDOWS')
>>> objs=cc.compile([str(src)])
>>> cc.link_executable(objs,exe+'w')
>>> if__name__=="__main__":
>>> compile("zastub.c")