使用setuptools打包Python命令行工具时，如何正确处理依赖文件？

你的问题核心是错误地把所有依赖文件都塞进了scripts字段——这个字段原本是用来定义可直接执行的命令行脚本的，把内部模块和配置文件放进去自然会导致它们被全局暴露。下面是符合Python打包规范的优化方案：

1. 调整项目结构 #

先把代码整理成标准的Python包结构，确保内部文件都被封装在包目录下：

python-app/
├── myapp/
│   ├── __init__.py
│   ├── main.py               # 命令行入口逻辑
│   ├── dependent-python.py   # 依赖的内部模块
│   └── configs/
│       └── dependent-yaml.yml # 配置文件
└── setup.py

2. 用entry_points替代scripts定义命令行入口 #

在setup.py中使用console_scripts来指定命令行工具的入口，setuptools会自动生成一个全局可调用的命令（比如python-app），但只会暴露入口逻辑，不会把内部模块丢到系统PATH里：

from setuptools import setup, find_packages

setup(
    name='python-app',
    version='0.1.0',
    description='Python App',
    python_requires='>=3.9',
    packages=find_packages(),
    # 格式：命令名 = 包名.模块名:入口函数名
    entry_points={
        'console_scripts': [
            'python-app = myapp.main:main',
        ],
    },
)

你只需要把原来python-app.py里的执行逻辑迁移到myapp/main.py的main()函数中即可。

3. 打包非Python依赖文件 #

要将yml这类非代码文件打包到安装包中，需要在setup.py里添加package_data字段，明确指定要包含的非Python文件：

setup(
    # ... 其他原有字段 ...
    package_data={
        'myapp': ['configs/*.yml'],  # 匹配myapp/configs下的所有yml文件
    },
)

4. 在代码中正确读取依赖文件 #

安装后，配置文件会和包一起放在site-packages目录下，你需要通过包的路径来读取，避免相对路径导致的问题。比如在main.py中：

import os
import yaml
from pkgutil import get_data

# 方法1：用pkgutil读取（更稳妥的跨环境方式）
yaml_content = get_data('myapp', 'configs/dependent-yaml.yml')
config = yaml.safe_load(yaml_content)

# 方法2：通过__file__获取包路径
config_path = os.path.join(os.path.dirname(__file__), 'configs', 'dependent-yaml.yml')
with open(config_path, 'r') as f:
    config = yaml.safe_load(f)

这样处理后，只有python-app这个命令是全局可调用的，内部模块和配置文件都被封装在包内，不会被全局暴露，完全符合Python打包的最佳实践。

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