使用 PyInstaller 捆绑数据文件 (--onefile)

Question

我正在尝试使用 PyInstaller 构建一个单文件 EXE，其中包含一个图像和一个图标。我一生都无法让它与 --onefile 一起工作。

如果我这样做 --onedir 它工作一切都很好。 当我使用 --onefile 时，它找不到引用的附加文件（运行编译的 EXE 时）。它发现 DLL 和其他一切都很好，只是找不到两个映像。

我查看了运行 EXE 时生成的临时目录（例如 \Temp\_MEI95642\），文件确实在那里。当我将 EXE 放入该临时目录时，它会找到它们。非常令人困惑。

这是我添加到 .spec 文件中的内容，

a.datas += [('images/icon.ico', 'D:\\[workspace]\\App\\src\\images\\icon.ico',  'DATA'),
('images/loaderani.gif','D:\\[workspace]\\App\\src\\images\\loaderani.gif','DATA')]     

我应该补充一点，我也尝试过不将它们放入子文件夹中，但没有什么区别。

编辑： 由于 PyInstaller 更新，将新答案标记为正确。

Answer 1

较新版本的 PyInstaller 不再设置 env 变量，因此 Shish 的出色答案将不起作用。现在路径被设置为 sys._MEIPASS ：

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    try:
        # PyInstaller creates a temp folder and stores path in _MEIPASS
        base_path = sys._MEIPASS
    except Exception:
        base_path = os.path.abspath(".")

    return os.path.join(base_path, relative_path)

Answer 2

pyinstaller 将您的数据解压到临时文件夹中，并将该目录路径存储在 _MEIPASS2 环境变量中。要在打包模式下获取 _MEIPASS2 目录并在解包（开发）模式下使用本地目录，我使用以下命令：

def resource_path(relative):
    return os.path.join(
        os.environ.get(
            "_MEIPASS2",
            os.path.abspath(".")
        ),
        relative
    )

输出：

# in development
>>> resource_path("app_icon.ico")
"/home/shish/src/my_app/app_icon.ico"

# in production
>>> resource_path("app_icon.ico")
"/tmp/_MEI34121/app_icon.ico"

Answer 3

在应用程序未安装 PyInstalled 的情况下（即未设置 sys._MEIPASS ），所有其他答案都使用当前工作目录。这是错误的，因为它会阻止您从脚本所在目录以外的目录运行应用程序。

更好的解决方案：

import sys
import os

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    base_path = getattr(sys, '_MEIPASS', os.path.dirname(os.path.abspath(__file__)))
    return os.path.join(base_path, relative_path)

Answer 4

我已经处理这个问题很长一段时间了（嗯，非常）。我搜索了几乎所有的资料来源，但事情并没有在我的脑海中形成一种模式。

最后，我想我已经弄清楚了要遵循的确切步骤，我想分享。

请注意，我的答案使用了其他人对此问题的答案的信息。

如何创建 python 项目的独立可执行文件。

假设我们有一个project_folder，文件树如下：

<前><代码>项目文件夹/
主要.py
xxx.py # 另一个模块
yyy.py # 另一个模块
sound/ # 包含声音文件的目录
img/ # 包含图像文件的目录
venv/ # 如果使用 venv

首先，假设您已将 sound/ 和 img/ 文件夹的路径定义为变量 sound_dir 和 img_dir > 如下：

img_dir = os.path.join(os.path.dirname(__file__), "img")
sound_dir = os.path.join(os.path.dirname(__file__), "sound")

您必须更改它们，如下所示：

img_dir = resource_path("img")
sound_dir = resource_path("sound")

其中，resource_path() 在脚本顶部定义为：

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    base_path = getattr(sys, '_MEIPASS', os.path.dirname(os.path.abspath(__file__)))
    return os.path.join(base_path, relative_path)

如果使用 venv，请激活虚拟环境，

如果没有，请安装 pyinstaller然而，通过：pip3 install pyinstaller。

运行：pyi-makespec --onefile main.py 为编译和构建过程创建规范文件。

这会将文件层次结构更改为：

<前><代码>项目文件夹/
主要.py
xxx.py # 模块
xxx.py # 模块
sound/ # 包含声音文件的目录
img/ # 包含图像文件的目录
venv/ # 如果使用 venv
main.spec #<<<注意这个新文件！

打开（使用编辑器）main.spec：

在其顶部插入：

added_files = [

("sound", "sound"),
("img", "img")

]

然后，将datas=[],行更改为datas=added_files，

有关 main.spec 上完成的操作的详细信息，请参阅 使用 PyInstaller 文档中的规范文件部分

运行 pyinstaller --onefile main.spec

就这样，您可以在 中运行 main任何地方的project_folder/dist，其文件夹中没有任何其他内容。您只能分发该 main 文件。现在，它是一个真正的独立。

Answer 5

也许我错过了一个步骤或做错了什么，但上面的方法没有将数据文件与 PyInstaller 捆绑到一个 exe 文件中。让我分享一下我所做的步骤。

1. 步骤：将上述方法之一写入您的 py 文件中，并导入 sys 和 os 模块。我都尝试过。最后一个是：

   def 资源路径（相对路径）：
   """ 获取资源的绝对路径，适用于 dev 和 PyInstaller """
       base_path = getattr(sys, '_MEIPASS', os.path.dirname(os.path.abspath(__file__)))
       返回 os.path.join(base_path,relative_path)
   

2. step: Write, pyi-makespec file.py, to the console, to create a file.spec file.

3. 步骤：使用 Notepad++ 打开 file.spec 添加数据文件，如下所示：

   a = Analysis(['C:\\Users\\TCK\\Desktop\\Projeler\\Converter-GUI.py'],
                pathex=['C:\\Users\\TCK\\Desktop\\Projeler'],
                二进制文件=[],
                数据=[],
                隐藏导入=[],
                钩子路径=[],
                运行时钩子=[],
                排除=[],
                win_no_prefer_redirects=假,
                win_private_assemblies=假,
                密码=块密码）
   #添加文件，如下例所示
   a.datas += [('Converter-GUI.ico', 'C:\\Users\\TCK\\Desktop\\Projeler\\Converter-GUI.ico', 'DATA')]
   pyz = PYZ(a.pure, a.zipped_data,
        密码=块密码）
   exe = EXE(pyz,
             a. 脚本，
             except_binaries=真，
             name='Converter-GUI',
             调试=假，
             条=假，
             upx=真，
             #如果您不想在执行程序时看到控制台，请将控制台选项设置为False。
             控制台=假，
             #给程序添加一个图标。
             图标='C:\\Users\\TCK\\Desktop\\Projeler\\Converter-GUI.ico')
   
   科尔 = 收集(exe,
                  a. 二进制文件，
                  a.zip 文件，
                  a. 数据，
                  条=假，
                  upx=真，
                  name='Converter-GUI')
   

4. 步骤：我按照上述步骤操作，然后保存了spec 文件。最后打开控制台并写入，pyinstaller file.spec（在我的例子中，file=Converter-GUI）。

结论：dist文件夹中仍然存在多个文件。

注意：我使用的是Python 3.5。

编辑：最后它适用于 Jonathan Reinhart 的方法。

1. 步骤：将以下代码添加到您的 python 文件中，并导入 sys 和 os。

   def 资源路径（相对路径）：
   """ 获取资源的绝对路径，适用于 dev 和 PyInstaller """
       base_path = getattr(sys, '_MEIPASS', os.path.dirname(os.path.abspath(__file__)))
       返回 os.path.join(base_path,relative_path)
   

2. 步骤：调用上述函数并添加文件路径：

   image_path = resources_path("Converter-GUI.ico")
   

3. 步骤：将调用函数的上述变量写入代码需要路径的位置。就我而言，它是：

    self.window.iconbitmap(image_path)
   

4. 步骤：在 python 文件的同一目录中打开控制台，编写如下代码：

    pyinstaller --onefile your_file.py
   

5. 步骤：打开 python 文件的 .spec 文件并附加 a.datas 数组并添加图标到上面在第三步编辑之前给出的 exe 类。

6. 步骤：保存并退出路径文件。转到包含规范和 py 文件的文件夹。再次打开控制台窗口并键入以下命令：

    pyinstaller your_file.spec
   

第 6 步之后，您的文件就可以使用了。

Answer 6

使用 Max 和 This 的出色答案发布关于添加额外数据文件（例如图像或声音）的文章根据我自己的研究/测试，我已经找到了我认为添加此类文件的最简单方法。

如果您想查看实际示例，我的存储库位于 GitHub 上的此处。

注意：这是使用 --onefile 或 -F 命令与 pyinstaller 进行编译。

我的环境是接下来。

• Python 3.3.7
• Tkinter 8.6 (检查版本)
• Pyinstaller 3.6

---

分两步解决问题

要解决这个问题，我们需要专门告诉 Pyinstaller 我们有额外的文件需要与应用程序“捆绑”。

我们还需要使用“相对”路径，以便应用程序在作为 Python 脚本或 Frozen EXE 运行时可以正常运行。

话虽如此，我们需要一个允许我们拥有相对路径的函数。使用Max Posted函数我们可以轻松解决相对路径问题。

def img_resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    try:
        # PyInstaller creates a temp folder and stores path in _MEIPASS
        base_path = sys._MEIPASS
    except Exception:
        base_path = os.path.abspath(".")

    return os.path.join(base_path, relative_path)

我们将像这样使用上面的函数，以便当应用程序作为脚本或 Frozen EXE 运行时应用程序图标会显示。

icon_path = img_resource_path("app/img/app_icon.ico")
root.wm_iconbitmap(icon_path)

下一步是我们需要指示 Pyinstaller 在编译时在哪里找到额外的文件，以便当应用程序运行时，它们会在临时目录中创建。

我们可以通过两种方式解决此问题，如 文档< /a>，但我个人更喜欢管理我自己的 .spec 文件，因此我们将这样做。

首先，您必须已经有一个 .spec 文件。就我而言，我能够通过运行带有额外参数的 pyinstaller 来创建我需要的内容，您可以找到额外的参数 此处。因此，我的规范文件可能与您的略有不同，但在解释重要部分后，我将发布所有内容以供参考。

added_files 本质上是一个包含元组的列表，在我的例子中，我只想添加单个图像，但您可以使用 添加多个 ico、png 或 jpg ('app/img/*.ico', 'app/img') 您还可以创建另一个元组，例如added_files = [ (), (), ()] 进行多个导入

元组的第一部分定义您要添加的文件或文件类型以及查找位置他们。将此视为 CTRL+C

元组的第二部分告诉 Pyinstaller 创建路径“app/img/”并将文件放置在该目录中，该目录与运行 .exe 时创建的任何临时目录相关。将此视为 CTRL+V

在 a = Analysis([main... 下，我设置了 datas=added_files< /code>，最初它曾经是 datas=[] 但我们希望导入导入列表，因此我们传入自定义导入，

您不需要这样做 。除非您想要 EXE 的特定图标，位于规范的底部文件我告诉 Pyinstaller 使用选项 icon='app\\img\\app_icon.ico'

added_files = [
    ('app/img/app_icon.ico','app/img/')
]
a = Analysis(['main.py'],
             pathex=['D:\\Github Repos\\Processes-Killer\\Process Killer'],
             binaries=[],
             datas=added_files,
             hiddenimports=[],
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=block_cipher,
             noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          [],
          name='Process Killer',
          debug=False,
          bootloader_ignore_signals=False,
          strip=False,
          upx=True,
          upx_exclude=[],
          runtime_tmpdir=None,
          console=True , uac_admin=True, icon='app\\img\\app_icon.ico')

---

编译为 EXE

我很懒；我不喜欢输入更多内容，我已经创建了一个只需单击即可的文件，您不必这样做，

因为没有 . spec 文件包含我们所有的编译设置& args （又名选项）我们只需将该 .spec 文件提供给 Pyinstaller 即可。

pyinstaller.exe "Process Killer.spec"

Answer 7

我没有按照建议重写所有路径代码，而是更改了工作目录：

if getattr(sys, 'frozen', False):
    os.chdir(sys._MEIPASS)

只需在代码开头添加这两行即可，其余部分保持原样。

Answer 8

对已接受的答案稍作修改。

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    if hasattr(sys, '_MEIPASS'):
        return os.path.join(sys._MEIPASS, relative_path)

    return os.path.join(os.path.abspath("."), relative_path)

Answer 9

另一个解决方案是创建一个运行时挂钩，它将复制（或移动）您的数据（文件/文件夹）到存储可执行文件的目录。该钩子是一个简单的 python 文件，它几乎可以在执行应用程序之前执行任何操作。为了设置它，您应该使用 pyinstaller 的 --runtime-hook=my_hook.py 选项。因此，如果您的数据是 images 文件夹，则应运行以下命令：

pyinstaller.py --onefile -F --add-data=images;images --runtime-hook=cp_images_hook.py main.py

cp_images_hook.py 可能如下所示：

import sys
import os
import shutil

path = getattr(sys, '_MEIPASS', os.getcwd())

full_path = path+"\\images"
try:
    shutil.move(full_path, ".\\images")
except:
    print("Cannot create 'images' folder. Already exists.")

在每次执行之前，images 文件夹都会移动到当前目录（来自 _MEIPASS 文件夹），因此可执行文件始终可以访问它。
这样就不需要修改项目的代码。

第二种解决方案

您可以利用运行时挂钩机制并更改当前目录，根据一些开发人员的说法，这不是一个好的做法，但它工作得很好。

钩子代码可以在下面找到：

import sys
import os

path = getattr(sys, '_MEIPASS', os.getcwd())   
os.chdir(path)

Answer 10

我在 PyInstaller 上看到的最常见的抱怨/问题是“我的代码找不到我明确包含在捆绑包中的数据文件，它在哪里？”，并且很难看出您的代码是什么/在哪里正在搜索，因为提取的代码位于临时位置，并在退出时被删除。使用 @Jonathon Reinhart 的 resource_path() 添加这段代码来查看您的 onefile 中包含的内容及其位置

for root, dirs, files in os.walk(resource_path("")):
    print(root)
    for file in files:
        print( "  ",file)

Answer 11

如果您仍然尝试将与可执行文件相关的文件而不是放在临时目录中，则需要自己复制它。这就是我最终完成它的方式。

https://stackoverflow.com/a/59415662/999943

您在规范文件中添加一个步骤来执行文件系统复制到 DISTPATH 变量。

希望有帮助。

Answer 12

我使用这个基于最大解决方案

def getPath(filename):
    import os
    import sys
    from os import chdir
    from os.path import join
    from os.path import dirname
    from os import environ
    
    if hasattr(sys, '_MEIPASS'):
        # PyInstaller >= 1.6
        chdir(sys._MEIPASS)
        filename = join(sys._MEIPASS, filename)
    elif '_MEIPASS2' in environ:
        # PyInstaller < 1.6 (tested on 1.5 only)
        chdir(environ['_MEIPASS2'])
        filename = join(environ['_MEIPASS2'], filename)
    else:
        chdir(dirname(sys.argv[0]))
        filename = join(dirname(sys.argv[0]), filename)
        
    return filename

Answer 13

对于那些仍在寻找更新答案的人，请看这里：

在文档，有一个 有关访问添加的数据文件的部分。
这是它的简短而甜蜜的。

---

您需要导入 pkgutil 并找到将数据文件添加到的文件夹；即元组中添加到规范文件中的第二个字符串：

datas = [("path/to/mypackage/data_file.txt", "path/to/mypackage")]

了解添加数据文件的位置，然后可以将其作为二进制数据读取，并根据需要对其进行解码。举个例子：

文件结构：

mypackage
      __init__.py  # This is a MUST in order for the package to be registered
      data_file.txt  # The data file you've added

data_file.txt

Hello world!

main.py

import pkgutil

file = pkgutil.get_data("mypackage", "data_file.txt")
contents = file.decode("utf-8")
print(contents)  # Hello world!

---

参考资料：

• pkgutil< /code> - 内置库
• __init__.py 和包

Answer 14

最后 ！基于 Luca 的解决方案，

我最终能够在 --onefile pyinstaller 中包含的目录中执行文件。

只需使用他发布的方法，您甚至可以在文件中输入整个目录名称，它仍然有效。

您需要的第二件事实际上是在 pyinstaller 中添加您想要的目录/文件。只需使用如下参数：

--add-data "yourDir/And/OrFile;yourDir"

Answer 15

快刀斩乱麻：os.getcwd() 与 __file__

@JonathonReinhart 强烈反对使用 os.getcwd()< /code> 在脚本中，尤其是反对更改它。这是有充分理由的。但是，正如@Guimoute 所指出的，如果您想将resource_path() 函数放入main.py 之外的某个模块中，你可能会遇到问题。这是解决这个问题的一种方法。

解决方案

我的解决方案遵循@DisappointedByUnaccountableMod的建议，但没有在main.c中定义新函数。这是实现的关键：

• ./main.py：

我将以下变量定义添加到主脚本文件中。

import os

# Import the resource_path helper function from wherever it is
from src.helpers import resource_path

# Store the location of the directory where the script is running
# i.e. NOT where it is being run from
__main_script_dir__ = os.path.dirname(__file__)

• ./src/helpers.py：

import os
import sys

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    
    # Load dynamically to avoid circular import
    from main import __main_script_dir__

    base_path = getattr(sys, '_MEIPASS', os.path.abspath(__main_script_dir__))
    # print(f"BASE_PATH: {base_path}")

    return os.path.abspath(os.path.join(base_path, relative_path))

然后，无论您在何处使用资源，只要您想将其捆绑到 .exe 文件中，您都可以调用 resource_path (relative_path_to_your_resource)，它将始终返回程序所需的路径，具体取决于程序是作为可执行文件运行还是仅作为脚本运行。

Answer 16

我发现现有的答案令人困惑，并花了很长时间才找出问题所在。这是我找到的所有内容的汇编。

当我运行应用程序时，出现错误无法执行脚本 foo（如果 foo.py 是主文件）。要解决此问题，请不要使用 --noconsole 运行 PyInstaller（或编辑 main.spec 更改 console=False => console=True）。这样，从命令行运行可执行文件，您就会看到失败。

首先要检查的是它是否正确打包了您的额外文件。如果您希望包含文件夹 x，您应该添加像 ('x', 'x') 这样的元组。

崩溃后，不要单击“确定”。如果您使用的是 Windows，则可以使用 搜索一切。查找您的文件之一（例如sword.png）。您应该找到解压文件的临时路径（例如C:\Users\ashes999\AppData\Local\Temp\_MEI157682\images\sword.png）。您可以浏览此目录并确保它包含所有内容。如果您无法通过这种方式找到它，请查找诸如 main.exe.manifest (Windows) 或 python35.dll（如果您使用的是 Python 3.5）之类的内容。

如果安装程序包含所有内容，则下一个可能的问题是文件 I/O：您的 Python 代码正在可执行文件的目录（而不是临时目录）中查找文件。

为了解决这个问题，这个问题的任何答案都有效。就我个人而言，我发现它们都可以工作：在主入口点文件中首先有条件地更改目录，其他一切都按原样工作：


如果 hasattr(sys, '_MEIPASS'):
os.chdir(sys._MEIPASS)


Answer 17

以上都不适合我。它不允许我使用规范文件和一个文件开关运行 pyinstaller。我是在windows下编译的。我的应用程序组织如下：

main.py

带有 .png 文件的子文件夹图像

带有 csv 文件的子文件夹数据

这是对我有用的命令：
pyinstaller -F --add-data images\*.png;images --add-data data\*.csv;data main.py

可执行文件位于 dist 文件夹中。

我希望它能帮助别人！

Answer 18

这将为您提供当前目录路径。

import sys, os

def get_current_dir_path():
    if getattr(sys, 'frozen', False):
        # If the application is run as a bundle (e.g., PyInstaller, cx_Freeze)
        current_dir_path = os.path.dirname(sys.executable)
    else:
        # If the application is run as a script
        current_dir_path = os.path.dirname(os.path.abspath(__file__))
    return current_dir_path

current_dir_path = get_current_dir_path()

# Now you can use 'current_dir_path'
# Whether you run your script or executable, this will provide you with the current directory path.
print(current_dir_path)