在使用 PyInstaller 创建的单文件 exe 中导入外部模块
Importing external module in single-file exe created with PyInstaller
我正在使用 PyInstaller 创建单文件可执行文件。我的脚本是否可以执行导入,以便 i) 导入的模块是从与 exe 相同的目录导入的(即它没有打包到 exe 中)和 ii) 导入的模块可以导入其他模块 被打包成exe了吗?
这里的背景是导入的模块包含用户应该能够修改的配置。这可能包括创建自定义派生 类 和使用打包模块中的枚举。
我还没有找到任何关于此的建议,尽管这很难搜索,因为有很多相似的主题使用基本相同的关键字。
输入 Pyinstaller -h
。它将为您提供有关 pyinstaller 的信息并告诉您有关 --runtime-hook
的信息。我认为将其添加到可执行文件中应该可行。这实际上有一整页documentation。很惊讶你找不到那个。
无论如何,
文档说放入:
pyinstaller --additional-hooks-dir=. myscript.py
。
我想 pyinstaller --additional-hooks-dir=C:\pathtofolder myscript.py
这样的东西在理论上应该可行。还是要测试一下。告诉我们它是怎么回事,是什么让它对你有用。
最后,如果您想成为时髦人士,请尝试集成 cython 以提高速度和混淆。公平警告,cython 不像 pyinstaller 那样用户友好。我还没有成功使用它。
以下步骤允许导入由 PyInstaller 创建的可执行文件之外的 Python 模块(此处名为 external_module
),并允许该模块导入捆绑到可执行文件中的模块。
- 将
excludes=['external_module']
添加到 PyInstaller 规范中使用的 Analysis 对象。这可以防止 external_module.py
被捆绑到可执行文件中。
- 添加
sys.path.append(os.path.dirname(sys.executable))
,其中 external_module
已导入到您的应用程序中。这允许它从可执行文件所在的目录导入,该目录不同于应用程序 运行 所在的目录(由于被解压缩到临时文件夹)。请参阅下面我推荐的实现此方法的方法。
- 确保
external_module.py
执行的任何导入也由捆绑模块之一执行 before external_module.py
被导入。解释器不会解析外部模块对捆绑模块的导入,但会使用sys.modules
.[=51中已经存在的模块=]
为了正确设置路径,您可以使用以下内容:
if getattr(sys, 'frozen', False):
app_path = os.path.dirname(sys.executable)
sys.path.append(app_path)
else:
app_path = os.path.dirname(os.path.abspath(__file__))
frozen
仅在生成的可执行文件中可用,当 运行ning 直接作为脚本时不可用。如果需要,此代码段会将可执行文件的位置添加到 sys.path
,并让您轻松访问可执行文件或脚本的位置以在代码中使用。
作为最后要点的示例,请考虑以下内容。
# bundled_module1.py
import external_module
# bundled_module2.py
# module content
# external_module.py
import bundled_module2
这将在 external_module.py
中失败,因为找不到 bundled_module2
。但是,以下将起作用:
# bundled_module1.py
import bundled_module2
import external_module
# bundled_module2.py
# module content
# external_module.py
import bundled_module2
如果外部模块应该能够导入一组有限的捆绑模块,这会很好。对于较大的集合,它可能会变得笨拙。
鉴于文档指出解释器 将 解析针对捆绑到可执行文件中的模块的导入,这感觉像是一个可能的错误。不过,与可执行文件之外的模块进行互操作并未明确提出。
我正在使用 PyInstaller 创建单文件可执行文件。我的脚本是否可以执行导入,以便 i) 导入的模块是从与 exe 相同的目录导入的(即它没有打包到 exe 中)和 ii) 导入的模块可以导入其他模块 被打包成exe了吗?
这里的背景是导入的模块包含用户应该能够修改的配置。这可能包括创建自定义派生 类 和使用打包模块中的枚举。
我还没有找到任何关于此的建议,尽管这很难搜索,因为有很多相似的主题使用基本相同的关键字。
输入 Pyinstaller -h
。它将为您提供有关 pyinstaller 的信息并告诉您有关 --runtime-hook
的信息。我认为将其添加到可执行文件中应该可行。这实际上有一整页documentation。很惊讶你找不到那个。
无论如何,
文档说放入:
pyinstaller --additional-hooks-dir=. myscript.py
。
我想 pyinstaller --additional-hooks-dir=C:\pathtofolder myscript.py
这样的东西在理论上应该可行。还是要测试一下。告诉我们它是怎么回事,是什么让它对你有用。
最后,如果您想成为时髦人士,请尝试集成 cython 以提高速度和混淆。公平警告,cython 不像 pyinstaller 那样用户友好。我还没有成功使用它。
以下步骤允许导入由 PyInstaller 创建的可执行文件之外的 Python 模块(此处名为 external_module
),并允许该模块导入捆绑到可执行文件中的模块。
- 将
excludes=['external_module']
添加到 PyInstaller 规范中使用的 Analysis 对象。这可以防止external_module.py
被捆绑到可执行文件中。 - 添加
sys.path.append(os.path.dirname(sys.executable))
,其中external_module
已导入到您的应用程序中。这允许它从可执行文件所在的目录导入,该目录不同于应用程序 运行 所在的目录(由于被解压缩到临时文件夹)。请参阅下面我推荐的实现此方法的方法。 - 确保
external_module.py
执行的任何导入也由捆绑模块之一执行 beforeexternal_module.py
被导入。解释器不会解析外部模块对捆绑模块的导入,但会使用sys.modules
.[=51中已经存在的模块=]
为了正确设置路径,您可以使用以下内容:
if getattr(sys, 'frozen', False):
app_path = os.path.dirname(sys.executable)
sys.path.append(app_path)
else:
app_path = os.path.dirname(os.path.abspath(__file__))
frozen
仅在生成的可执行文件中可用,当 运行ning 直接作为脚本时不可用。如果需要,此代码段会将可执行文件的位置添加到 sys.path
,并让您轻松访问可执行文件或脚本的位置以在代码中使用。
作为最后要点的示例,请考虑以下内容。
# bundled_module1.py
import external_module
# bundled_module2.py
# module content
# external_module.py
import bundled_module2
这将在 external_module.py
中失败,因为找不到 bundled_module2
。但是,以下将起作用:
# bundled_module1.py
import bundled_module2
import external_module
# bundled_module2.py
# module content
# external_module.py
import bundled_module2
如果外部模块应该能够导入一组有限的捆绑模块,这会很好。对于较大的集合,它可能会变得笨拙。
鉴于文档指出解释器 将 解析针对捆绑到可执行文件中的模块的导入,这感觉像是一个可能的错误。不过,与可执行文件之外的模块进行互操作并未明确提出。