如何将完整Python项目打包为可执行文件？

Got it, let's break down how to package your multi-file Python project (including scripts, SQLite databases, and other assets) into a single executable—PyInstaller is absolutely the right tool here, you just need to tweak a few parameters to include all your extra files.

First off: You can't just package the Python scripts alone. Your SQLite database and other required files are critical dependencies; if they're not included or properly referenced, the executable will throw "file not found" errors when it runs.

Step 1: Understand Your Project Structure #

Let's assume your project looks something like this (adjust based on your actual setup):

my_project/
├── main.py          # Your entry point script
├── utils.py         # Other custom modules
├── core/
│   └── processor.py
├── data/
│   └── app_db.sqlite # SQLite database
└── config/
    └── settings.ini

Step 2: Use PyInstaller with --add-data to Include Extra Files #

To create a single executable, use the -F (or --onefile) flag. The --add-data flag tells PyInstaller to bundle your non-Python files. The syntax differs slightly by OS:

Windows Command #

pyinstaller -F --add-data "data/app_db.sqlite;data/" --add-data "config/*;config/" main.py

• The ; separates the source file/path from the destination path inside the executable.

macOS/Linux Command #

pyinstaller -F --add-data "data/app_db.sqlite:data/" --add-data "config/*:config/" main.py

• Use : instead of ; for Unix-based systems.

Step 3: Fix Runtime File Paths #

When you package as a single executable, PyInstaller extracts all files to a temporary directory (sys._MEIPASS) when the app runs. You can't use hardcoded paths—instead, add a helper function to dynamically get the correct path:

import os
import sys

def get_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:
        # If not packaged, use the current working directory
        base_path = os.path.abspath(".")
    return os.path.join(base_path, relative_path)

# Example: Use this to connect to your SQLite database
db_path = get_resource_path("data/app_db.sqlite")
# Then use db_path in your sqlite3 connection:
# import sqlite3
# conn = sqlite3.connect(db_path)

Step 4: Handle Edge Cases #

• Writable Database: If your app writes to the SQLite database, the bundled file in the temp directory will be deleted when the app closes. To fix this, copy the initial database to a persistent location (like the user's Documents folder) on first run:

  import shutil
  
  def init_database():
      bundled_db = get_resource_path("data/app_db.sqlite")
      user_db = os.path.join(os.path.expanduser("~"), "Documents", "app_db.sqlite")
      if not os.path.exists(user_db):
          shutil.copy(bundled_db, user_db)
      return user_db
  

• Hidden Imports: Some Python modules (especially those with dynamic imports) might not be detected by PyInstaller. Use --hidden-import=module_name to explicitly include them, e.g.:

  pyinstaller -F --add-data "data/app_db.sqlite;data/" --hidden-import=sqlite3 main.py
  

• Slow Startup: Single executables can take longer to launch because they need to extract files. If speed is an issue, use -D (or --onedir) instead of -F to package into a folder with the executable and all dependencies—you can then zip the folder for distribution.

Final Notes #

Always test the executable by moving it to a different directory (away from your project files) to ensure it doesn't rely on the original project structure. This will catch any missing files or path issues early.

内容的提问来源于stack exchange，提问作者GreenCoder90