4.3.1. 自动打包模式

假设有一个这样的项目，其目录结构如下:

project/
    ├── foo.py
    ├── foo.spec
    ├── util.py
    └── joker/
        ├── __init__.py
        ├── card.py
        ├── queens.py
        └── config.json

我们使用下面的命令进行打包:

$ cd project
$ pyarmor gen --pack onefile foo.py

那么，Pyarmor 是如何生成一个包含加密脚本的可执行文件呢？

1. Pyarmor 首先调用 PyInstaller ，让它分析没有加密脚本的 foo.py 依赖关系，并检查所有发现的依赖项目
2. Pyarmor 发现依赖模块 util 和包 joker 和脚本 foo.py 在相同的目录。然后 Pyarmor 使用命令行提供的加密选项自动加密 foo.py 以及 util.py 和包 joker ，并保存加密脚本到一个临时目录 .pyarmor/pack/dist
3. 对于没有和 foo.py 在相同目录下面的其他依赖模块和包，则添加到隐藏导入列表，这些一般都是 Python 的系统模块和包，不会自动加密
4. 最后 Pyarmor 再次调用 PyInstaller ，把临时目录 .pyarmor/pack/dist 下面的加密脚本，以及隐藏导入列表中的所有模块和包统统打包到一个可执行文件里面

现在，让我们运行一下最终输出的可执行文件 dist/foo 或者 dist/foo.exe:

$ ls dist/foo
$ dist/foo

如果需要生成单个目录的包，只需要传递 onedir 给 --pack 即可:

$ pyarmor gen --pack onedir foo.py
$ ls dist/foo
$ dist/foo/foo

$ pyinstaller foo.spec
$ dist/foo

$ pyarmor gen --pack foo.spec -r foo.py util.py joker/

print('this is __pyarmor__', __pyarmor__)

$ pyarmor cfg pack:pyi_options = " -w"

$ pyarmor cfg pack:pyi_options + " -i favion.ico"

$ pyarmor cfg pack:pyi_options + "--add-data joker/config.json:joker"

C:/User/test> pyarmor cfg pack:pyi_options + "--add-data joker/config.json;joker"

$ pyarmor cfg pack:pyi_options = " -w  -i favion.ico --add-data joker/config.json:joker"

$ pyarmor gen --pack onefile --private foo.py

$ pyarmor cfg pack:pyi_options = "--target-architecture universal2"
$ pyarmor gen --pack onefile --platform darwin.x86_64,darwin.arm64 foo.py

4.3.2. 自己动手打包加密脚本

如果使用上面的方式出现问题，或者打包好的可执行文件出现执行错误，那么请使用下面的方式自己打包加密脚本。

这需要你了解 如何使用 PyInstaller 和 如何使用 spec file ，如果还不知道如何使用，请点击链接学习相关知识。

下面我们使用上面的例子来说明如何手动打包加密脚本

• 首先使用 Pyarmor 加密这个脚本，把需要加密的脚本和目录全部在主脚本后面列出来，也可以使用其他加密选项，但是不要使用 -i 或者 --prefix 1:

  $ cd project
  $ pyarmor gen -O obfdist -r foo.py util.py joker/
  

  检查加密脚本执行是否正常:

  $ python obfdist/foo.py
  

• 然后使用下面的命令生成生成 foo.spec 2:

  $ pyi-makespec --onefile foo.py
  

  检查是否可以正确打包:

  $ pyinstaller foo.spec
  $ dist/foo
  

• 接着修改 foo.spec ，插入下面的补丁代码到 pyz = PYZ 所在的行之前，这一步是重点

# Pyarmor patch start:

srcpath = ''
obfpath = 'obfdist'

def apply_pyarmor_patch(srcpath, obfpath):

    from PyInstaller.compat import is_win, is_cygwin
    extname = 'pyarmor_runtime' + ('.pyd' if is_win or is_cygwin else '.so')

    from glob import glob
    rtpkg = glob(os.path.join(obfpath, '*', extname))
    if len(rtpkg) != 1:
        raise RuntimeError('No runtime package found')
    rtpkg = os.path.basename(os.path.dirname(rtpkg[0]))

    extpath = os.path.join(rtpkg, extname)

    if hasattr(a.pure, '_code_cache'):
        code_cache = a.pure._code_cache
    else:
        from PyInstaller.config import CONF
        code_cache = CONF['code_cache'].get(id(a.pure))

    # Make sure both of them are absolute paths
    src = os.path.normcase(os.path.abspath(srcpath))
    obf = os.path.abspath(obfpath)
    n = len(src) + 1

    count = 0
    for i in range(len(a.scripts)):
        if os.path.normcase(a.scripts[i][1]).startswith(src):
            x = os.path.join(obf, a.scripts[i][1][n:])
            if os.path.exists(x):
                a.scripts[i] = a.scripts[i][0], x, a.scripts[i][2]
                count += 1
    if count == 0:
        raise RuntimeError('No obfuscated script found')

    for i in range(len(a.pure)):
        if os.path.normcase(a.pure[i][1]).startswith(src):
            x = os.path.join(obf, a.pure[i][1][n:])
            if os.path.exists(x):
                code_cache.pop(a.pure[i][0], None)
                a.pure[i] = a.pure[i][0], x, a.pure[i][2]

    a.pure.append((rtpkg, os.path.join(obf, rtpkg, '__init__.py'), 'PYMODULE'))
    a.binaries.append((extpath, os.path.join(obf, extpath), 'EXTENSION'))

apply_pyarmor_patch(srcpath, obfpath)

# Pyarmor patch end.

# Before this line
# pyz = PYZ(...)

• 最后直接使用打过补丁的 foo.spec 来打包，使用选项 --clean 避免补丁因为缓存的文件而失效:

  $ pyinstaller --clean foo.spec
  

请根据你的具体情况，做如下修改

• 使用实际目录设置 srcpath ，相对路径即可，在这个例子，是当前路径，直接设置为空字符串
• 使用实际目录设置 obfpath ，相对路径即可，在这个例子中，加密目录是 obfdist

如何验证打包进去的是加密脚本

在主脚本以及导入的其他包和模块增加一些调试语句进行判断，例如

print('this is __pyarmor__', __pyarmor__)

如果不是加密脚本，这个语句会报错，只有在加密脚本中才能正常打印。

备注1选项 -i 或者 --prefix 会导致运行辅助包无法找到 2其他 PyInstaller 的选项也可以在这里使用

4.3.3. 替换打包模式

首先调用 PyInstaller 将脚本打包成为单独的可执行文件或者打包到一个目录，然后把打包生成的可执行文件通过选项 --pack 传递给 pyarmor gen 来实现:

$ pyinstaller foo.py
$ pyarmor gen --pack dist/foo/foo foo.py

Pyarmor 首先加密脚本，并把它们被存放到 .pyarmor/pack/dist ，然后进行下面的额外处理:

• 提取可执行文件中内容到一个临时目录 .pyarmor/pack/
• 使用加密脚本替换临时目录中同名的未加密脚本
• 把加密脚本的 运行辅助文件 增加到临时目录中
• 根据把临时目录中所有内容重新生成可执行文件，并替换原来的可执行文件

需要注意的是，在这种方式下面，使用 PyInstaller 6.0+ 打包生成的可执行文件无法被正确处理，只能使用低版本 PyInstaller 进行打包。

$ pyarmor gen --pack dist/foo/foo -r *.py dir1 dir2 ...

4.3.4. Apple M1 的 segment fault

在 Apple M1 上打包，如果生产的加密脚本运行时候发生崩溃，请首先检查运行辅助包的签名:

$ codesign -v dist/foo/pyarmor_runtime_000000/pyarmor_runtime.so

如果签名非法，请重新进行签名:

$ codesign -f -s dist/foo/pyarmor_runtime_000000/pyarmor_runtime.so

如果使用了 --enable-bcc 或者 --enable-jit 进行加密，那么还需要启用 Allow Execution of JIT-compiled Code Entitlement

2.6. 解决加密过程中编码错误

默认的脚本编码为 utf-8 ，当加密脚本的时候出现编码错误，可以使用配置项指定正确的文件编码。例如下面的命令可以设置加密脚本使用的编码为 gbk:

$ pyarmor cfg encoding=gbk

同样也可以为定制的错误消息文件 messages.cfg 指定编码。例如，使用下面的命令可以设置定制的错误消息文件使用的编码为 gbk:

$ pyarmor cfg messages=messages.cfg:gbk

2.7. 删除脚本中 Docstring

使用下面的配置可以删除加密脚本中 DocString:

$ pyarmor cfg optimize 2

配置项 optimize 可用值和作用请参考 compile