PyInstaller打包.exe时如何包含数据文件夹？.spec配置遇阻

Hey there! Let’s tackle this PyInstaller packaging headache you’re dealing with. Getting those text files to stick with your bundled program is totally doable—you just need to tweak two key things: your .spec file and how your code reads the file paths.

Step 1: Update Your .spec File to Include the Data Directory #

First, if you haven’t already, generate a .spec file for your script by running:

pyi-makespec your_script_name.py

Open the generated .spec file, and look for the datas parameter in the Analysis section. This is where you tell PyInstaller to include your text file directory.

The datas list takes tuples in the format (source_path, destination_path):

• source_path: The path to your data directory on your development machine (relative to where the .spec file lives, or an absolute path).
• destination_path: The folder name where PyInstaller will place these files inside the bundled app’s temporary runtime directory.

For example, if your data directory is named text_docs and lives in the same folder as your script, update the datas line like this:

datas=[('text_docs', 'text_docs')],

• If you only want to include .txt files (not other file types), use a wildcard:

  datas=[('text_docs/*.txt', 'text_docs')],
  

• If your text_docs has subdirectories with more text files, use a recursive wildcard to grab everything:

  datas=[('text_docs/**/*.txt', 'text_docs')],
  

Here’s how the full Analysis section might look:

a = Analysis(
    ['your_script_name.py'],
    pathex=[],
    binaries=[],
    datas=[('text_docs', 'text_docs')],  # Your updated line
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)

Step 2: Fix Your Code to Read Files Correctly Post-Packaging #

The big mistake many people make is using hardcoded relative paths in their code—when PyInstaller bundles your app, it extracts files to a temporary directory (not your original development folder). You need to detect if you’re running the bundled app or the raw script, then adjust the file path accordingly.

Add this helper function to your Python script:

import sys
import os

def get_text_file_path(filename):
    # Check if we're running from a bundled PyInstaller app
    if hasattr(sys, '_MEIPASS'):
        # Use the temporary runtime directory path
        return os.path.join(sys._MEIPASS, 'text_docs', filename)
    else:
        # Use the development relative path
        return os.path.join('text_docs', filename)

Now, whenever you need to read a text file, use this function instead of a direct path:

with open(get_text_file_path('sample.txt'), 'r') as f:
    content = f.read()
    # Do your processing here

Step 3: Re-Package Your App #

Once you’ve updated both the .spec file and your code, run PyInstaller using the .spec file (not just the script) to ensure your changes are applied:

pyinstaller your_script_name.spec

Quick Troubleshooting Tips #

• Double-check that your source_path in the .spec file matches the actual location of your text_docs directory relative to the .spec file.
• Add a debug print statement to verify the path: print(get_text_file_path('sample.txt'))—run the bundled app and check if the path points to a valid file in the temporary directory.
• If you’re still having issues, try using an absolute path for source_path in the .spec file (e.g., C:/Projects/my_app/text_docs on Windows or /home/user/projects/my_app/text_docs on Linux/macOS) to rule out relative path confusion.

内容的提问来源于stack exchange，提问作者A.Piquer