是否有*任何*解决方案来打包使用cppyy的python应用程序？

Question

创建 python 桌面应用程序的跨平台运行时，我不是新手。我主要使用 pyinstaller、cxfreeze、有时是 fbs、有时是公文包为我的本科生创建了各种工具。任何定期执行此操作的人都知道，在使用任意 Python 模块集合时，针对 Linux、windows 和 macos 需要进行很多怪癖和调整，但到目前为止，我已经设法弄清楚了一切。

我有一个 python GUI 应用程序，它使用一个巨大且不断变化的 c++ 库，所以我不能只是用 python 重写它。我已经成功地编写了使用 c++ 库的 python 代码，使用了名为 cppyy 的惊人（并且可能是神奇的）库，它允许您毫不费力地从 python 运行 c++ 代码。一切都在 Linux、Mac 和 Windows 上运行良好，但我无法将其打包到运行时中，而且我已经尝试了上述所有系统。所有这些都没有问题产生运行时（即，没有错误），但是当您运行它们时它们会失败。本质上，它们都给出了关于无法找到 cppyy-backend 的某种错误（例如，使用 pyinstaller 的 pyinstaller 和 fbs 在您运行二进制文件时会给出此消息）：

/home/nogard/Desktop/cppyytest/target/MyApp/cppyy_backend/loader.py:113: UserWarning: No precompiled header available ([Errno 2] No such file or directory: '/home/nogard/Desktop/cppyytest/target/MyApp/cppyy_backend'); this may impact performance.
Traceback (most recent call last):
  File "main.py", line 5, in <module>
  File "<frozen importlib._bootstrap>", line 971, in _find_and_load
  File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
  File "/home/nogard/Desktop/cppyytest/venv/lib/python3.6/site-packages/PyInstaller/loader/pyimod03_importers.py", line 628, in exec_module
    exec(bytecode, module.__dict__)
  File "cppyy/__init__.py", line 74, in <module>
  File "<frozen importlib._bootstrap>", line 971, in _find_and_load
  File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
  File "/home/nogard/Desktop/cppyytest/venv/lib/python3.6/site-packages/PyInstaller/loader/pyimod03_importers.py", line 628, in exec_module
    exec(bytecode, module.__dict__)
  File "cppyy/_cpython_cppyy.py", line 20, in <module>
  File "cppyy_backend/loader.py", line 74, in load_cpp_backend
RuntimeError: could not load cppyy_backend library
[11195] Failed to execute script main

我真的很难过。通常，您使用 pip 安装 cppyy，它会安装 cppyy-backend 和其他软件包。我什至使用 cppyy docs 方法来编译每个依赖项以及 cppyy，但结果是一样的。

我会使用任何有效的构建系统……有没有人成功过？我知道我可以使用 docker，但我之前尝试过这个，我的许多学生对 docker 感到害怕，要求他们更改他们的 bios 设置以支持虚拟化所以我想使用一个普通的打包系统来生成某种可运行的二进制文件。

如果您知道如何让 pyinstaller、cxfreeze、fbs 或公文包与 cppyy 一起工作（例如，如果您知道如何处理上述错误），请告诉我。但是，如果您已将 cppyy 应用程序与其他系统打包在一起，请告诉我，我将使用该应用程序。

如果您正在寻找一些代码来运行，我一直在使用这个最少的代码测试打包方法：

import cppyy

print('hello world from python\n')

cppyy.cppexec('''
#include <string>
using namespace std;
string mystring("hello world from c++");
std::cout << mystring << std::endl;
''')

Answer 1

编辑：找出 pyinstaller 挂钩；一旦发布，这一切都应该是全自动的

需要注意的是，我对打包运行时没有任何经验，所以我可能会遗漏一些明显的东西，但我刚刚尝试过pyinstaller，并且以下内容似乎有效。

首先，将上面的脚本保存为example.py，然后创建一个规范文件：

$ pyi-makespec example.py

cppyy_backend然后，添加as中的头文件和库datas（跳过默认添加的 python 文件）。最简单的似乎是从后端获取所有目录，因此example.spec通过在顶部添加来更改生成的目录：

def backend_files():
    import cppyy_backend, glob, os

    all_files = glob.glob(os.path.join(
        os.path.dirname(cppyy_backend.__file__), '*'))

    def datafile(path):
        return path, os.path.join('cppyy_backend', os.path.basename(path))

    return [datafile(filename) for filename in all_files if os.path.isdir(filename)]

datas并将对象中的空替换Analysis为：

             datas=backend_files(),

如果您还需要来自 的 API 标头CPyCppyy，那么可以找到这些标头，例如：

def api_files():
    import cppyy, os

    paths = str(cppyy.gbl.gInterpreter.GetIncludePath()).split('-I')
    for p in paths:
        if not p: continue
       
        apipath = os.path.join(p.strip()[1:-1], 'CPyCppyy')
        if os.path.exists(apipath):
            return [(apipath, os.path.join('include', 'CPyCppyy'))]

    return []

并添加到 Analysis 对象中：

             datas=backend_files()+api_files(),

但请注意，Python.h然后还需要存在于将部署包的系统上。如果需要，可以通过下面讨论的文件中提供的模块及其路径Python.h找到。sysconfigcppyy.add_include_pathbootstrap.py

接下来，考虑预编译头（文件cppyy_backend/etc/allDict.cxx.pch）：它包含 LLVM 中间表示形式的 C++ 标准头。如果添加的话，它将优先于部署包的系统编译器的需要。但是，如果有系统编译器，那么理想情况下，应在部署后首次使用时重新创建 PCH。

然而，使用loader.py中的脚本因冻结而被破坏（意味着它是顶级脚本，而不是，导致无限递归）。即使 PCH 可用，也会将其时间戳与目录的时间戳进行比较，如果较旧则重建。由于 PCH 和包含目录都根据复制顺序而不是构建顺序获取新时间戳，因此这是不可靠的，并且可能会导致虚假重建。因此，要么禁用 PCH，要么禁用时间戳检查。cppyy_backendsys.executablepythoninclude

为此，请选择这两个选项之一，并bootstrap.py通过取消注释所需的行为将其写入名为 的文件中：

### option 1: disable the PCH altogether

# import os
# os.environ['CLING_STANDARD_PCH'] = 'none'

### option 2: force the loader to declare the PCH up-to-date

# import cppyy_backend.loader
#
# def _is_uptodate(*args):
#    return True
#
# cppyy_backend.loader._is_uptodate = _is_uptodate

然后将引导程序作为钩子添加到对象中的规范文件中Analysis：

             runtime_hooks=['bootstrap.py'],

如上所述，这bootstrap.py也是根据需要添加更多包含路径的好地方，例如Python.h.

最后，照常运行：

$ pyinstaller example.spec