### 使用 PyInstaller 和 Setuptools 进行 Python 多文件项目打包 #### 1. **PyInstaller 工具** PyInstaller 是一种强大的工具，能够将整个 Python 项目及其依赖项打包成独立的可执行文件。对于多文件和多模块引用的项目，它可以自动解析所有的导入关系并将其包含到最终的可执行文件中。 以下是使用 PyInstaller 打包一个多文件项目的具体方法： - 首先确保已安装 PyInstaller[^2]： ```bash pip install pyinstaller==4.0.dev0+3e6f7dc709 ``` - 假设有一个主入口脚本 `main.py`，可以通过以下命令进行打包： ```bash pyinstaller --onefile main.py ``` 此命令会生成一个单文件的可执行程序，并将所有依赖项嵌入其中[^1]。 如果项目中有额外的数据文件（如配置文件、图片等），可以使用 `--add-data` 参数指定这些资源的位置。例如： ```bash pyinstaller --onefile --add-data "data/config.json;." main.py ``` 此处 `"data/config.json;. "` 表示将 `config.json` 文件复制到目标路径下的根目录[^1]。 --- #### 2. **Setuptools 工具** Setuptools 提供了一种更灵活的方式来管理复杂的 Python 项目结构。它允许开发者定义项目的元数据以及其依赖关系，并支持构建源码分发包或二进制轮子 (wheel)。 要使用 Setuptools 对多文件项目进行打包，请按照以下步骤操作： - 创建 `setup.py` 文件来描述项目的信息和依赖项。例如： ```python from setuptools import setup, find_packages setup( name='your_project_name', version='0.1', packages=find_packages(), include_package_data=True, install_requires=[ 'requests>=2.25.1', 'numpy>=1.18.5' ], entry_points={ 'console_scripts': [ 'run_my_app=your_module.main:entry_point_function', ] }, author='Your Name', description='Description of the project.', url='https://github.com/username/projectname' ) ``` 在此例子中，`find_packages()` 自动发现当前目录中的所有 Python 包；而 `include_package_data=True` 可以让非代码文件也被包含进来[^3]。 - 构建发行版之前，需确认 MANIFEST.in 存在且正确设置。该文件用于显式声明哪些附加文件应被纳入分发包内。比如： ``` recursive-include data * graft templates prune tests ``` 之后运行下面的指令完成打包过程： ```bash python setup.py sdist bdist_wheel ``` 这会产生 `.tar.gz` 形式的源码压缩包以及 `.whl` 的 wheel 格式文件。 --- #### 3. **两种工具对比** | 特性 | PyInstaller | Setuptools | |---------------------|--------------------------------------|------------------------------------| | 输出形式 | 单一可执行文件 | 源码分发包 / Wheel | | 是否需要 Python 解释器 | 不需要 | 需要 | | 数据文件处理 | 支持通过参数添加 | 配合 MANIFEST.in 或 package_data 完成 | 尽管两者都能满足基本需求，但在某些场景下各有优劣。例如当希望简化部署流程时可以选择 PyInstaller；而对于长期维护开源软件，则推荐采用 Setuptools 方案以便于社区协作开发[^1]。 ---