使用 Pyinstaller 或 Cython 从 Python 模块创建可执行文件

Posted 2023-04-14

【中文标题】使用 Pyinstaller 或 Cython 从 Python 模块创建可执行文件

【英文标题】：Create Executable from a Python module with Pyinstaller or Cython

【发布时间】：2019-02-09 17:14:34

【问题描述】：

我想转换为具有模块结构的可执行this python 2.7 项目：

(.venv) ip-192-168-22-127:indictrans loretoparisi$ tree -L 1
.
├── __init__.py
├── __init__.pyc
├── __init__.spec
├── _decode
├── _utils
├── base.py
├── build
├── mappings
├── models
├── script_transliterate.py
├── tests
├── transliterator.py
└── trunk

我在第一阶段使用pyinstaller，我只是这样做：

pyinstall --onefile __init__.py

我得到了一个可执行文件：

192 INFO: PyInstaller: 3.3.1
192 INFO: Python: 2.7.10
201 INFO: Platform: Darwin-17.7.0-x86_64-i386-64bit
202 INFO: wrote /Users/loretoparisi/Documents/Projects/AI/indic-trans/indictrans/__init__.spec
208 INFO: UPX is not available.
209 INFO: Extending PYTHONPATH with paths
['/Users/loretoparisi/Documents/Projects/AI/indic-trans',
 '/Users/loretoparisi/Documents/Projects/AI/indic-trans/indictrans']
210 INFO: checking Analysis
218 INFO: checking PYZ
223 INFO: checking PKG
224 INFO: Bootloader /Users/loretoparisi/Documents/Projects/AI/indic-trans/.venv/lib/python2.7/site-packages/PyInstaller/bootloader/Darwin-64bit/run
224 INFO: checking EXE
225 INFO: Rebuilding out00-EXE.toc because __init__ missing
225 INFO: Building EXE from out00-EXE.toc
225 INFO: Appending archive to EXE /Users/loretoparisi/Documents/Projects/AI/indic-trans/indictrans/dist/__init__
230 INFO: Fixing EXE for code signing /Users/loretoparisi/Documents/Projects/AI/indic-trans/indictrans/dist/__init__
234 INFO: Building EXE from out00-EXE.toc completed successfully.

但是当我运行它时，我得到一个导入错误

Traceback (most recent call last):
  File "indictrans/__init__.py", line 9, in <module>
ValueError: Attempted relative import in non-package
[30629] Failed to execute script __init__

此库是通过 cythonize 设置使用 Cython 构建的，因此另一种选择是使用 --embed Cython 选项构建可执行嵌入式模块。

我的setup.py 如下：

#!/usr/bin/env python

import os

from setuptools import setup
from setuptools.extension import Extension
from Cython.Build import cythonize

import numpy


os.environ['PBR_VERSION'] = '1.2.3'
os.environ['SKIP_WRITE_GIT_CHANGELOG'] = '1'
os.environ['SKIP_GENERATE_AUTHORS'] = '1'


extensions = [
    Extension(
        "indictrans._decode.beamsearch",
        [
            "indictrans/_decode/beamsearch.pyx"
        ],
        include_dirs=[numpy.get_include()]
    ),
    Extension(
        "indictrans._decode.viterbi",
        [
            "indictrans/_decode/viterbi.pyx"
        ],
        include_dirs=[numpy.get_include()]
    ),
    Extension(
        "indictrans._utils.ctranxn",
        [
            "indictrans/_utils/ctranxn.pyx"
        ],
        include_dirs=[numpy.get_include()]
    ),
    Extension(
        "indictrans._utils.sparseadd",
        [
            "indictrans/_utils/sparseadd.pyx"
        ],
        include_dirs=[numpy.get_include()]
    )

]

setup(
    setup_requires=['pbr'],
    pbr=True,
    ext_modules=cythonize(extensions)
)

虽然使用--embed option 编译单个python 文件很容易，但请参阅here 了解更多信息，我不知道如何使用setup.py 中的--embed 选项来摆脱项目中的所有依赖项。

【问题讨论】：

你用python启动的主文件是哪个？是transliterator.py

@Stack 我认为这是问题的一部分，因为主要是在处理参数的__init__.py 文件中，并将其传递给从transliterator.py 导入的Transliterator 类。

尝试pyinstaller --onefile transliterator.py 或将主文件移动到另一个新文件并尝试

@Stack 谢谢，我不想改变模块结构，因为这将是一个从源代码自动构建的系统。顺便说一句，我添加了有关setup.py 和Cython 的更多信息，如果您能提供帮助，谢谢！

【参考方案1】：

我将使用 setup.py 文件作为 package 目录引用根包目录，在您的情况下为 indic-trans。我将第一级源目录称为 module 目录，在您的情况下为 indic-trans/indictrans。

---

如果我正确理解了您的设置，您会遇到问题，因为您尝试在 module 目录而不是 package 目录中的脚本上创建 .exe。这使得当前目录成为内部模块目录，并且相对引用将不起作用。

我在类似情况下解决此问题的方法是在 package 主目录（与 setup.py 相同的文件夹）中创建一个 run.py 脚本，该脚本会导入该包，然后运行您需要的任何脚本想要在 module 目录中运行。

您没有发布 __init__.py 文件（顺便说一句，在 __init.py__... 中包含任何真实代码通常是不受欢迎的），所以我假设您想要运行以下内容base.py 脚本中的 main() 函数。在这种情况下，使run.py 类似于：

# This will import everything from the module __init__.py based on it's "all" setup
# You likely want to limit it to just what is needed or just the script you are targeting
# Or you can use the "import indictrans" format and let __init__.py handle it
from indictrans import * 

def main():
    indictrans.base.main()

if __name__ == '__main__':
    main()

现在您可以从命令行只运行run.py 或将其用作调试目标来运行您的包。

请注意，使用 PyInstaller，您可以定位 run.py（或 run.spec）并使用 --name 参数将名称更改为其他名称。

pyinstaller --onefile --name indictrans run.spec

这将在dist 目录中创建indictrans.exe。

---

将包作为模块运行

请注意，在 module 目录中，您还可以创建一个 __main__.py 文件，该文件基本上是 run.py 的副本，并执行相同的操作，但将由本地安装的 Python 可执行文件。

即python -m indictrans 将使用 __main__.py 作为入口点运行您的包。