Setuptools 中嵌套数据目录安装问题的深度解析

问题背景

在 Python 打包工具 setuptools 的使用过程中，开发者经常会遇到数据文件安装的问题。近期有用户反馈了一个特殊场景：当使用 setuptools 打包包含嵌套子目录的数据文件时，某些情况下子目录无法正确安装到目标位置。

现象描述

具体表现为：在项目结构中存在类似 some_package/data/subdir/ 的嵌套目录结构，并在 package_data 配置中使用 glob 模式匹配（如 "data/**"）时，在某些环境下（特别是旧版 pip 22.2 及以下版本）subdir 目录及其内容不会被安装到目标位置。

技术原理分析

Python 包与命名空间

在 Python 中，任何包含 __init__.py 文件的目录都被视为常规包，而没有 __init__.py 的目录则被视为命名空间包（namespace package）。setuptools 对这两种包的处理方式有所不同：

1. 常规包：通过 find_packages() 自动发现
2. 命名空间包：需要通过 find_namespace_packages() 显式声明

数据文件安装机制

setuptools 安装数据文件时遵循以下逻辑：

1. 首先确保目标包目录存在（无论是常规包还是命名空间包）
2. 然后根据 package_data 配置将匹配的文件复制到对应位置
3. 对于嵌套目录结构，需要保证每一级目录都被正确处理

解决方案

方法一：添加 init.py

最简单的解决方案是在每个子目录中添加 __init__.py 文件，将其转换为常规 Python 包：

some_package/
    data/
        __init__.py
        subdir/
            __init__.py
            file2.txt

方法二：使用命名空间包

如果不想添加 __init__.py 文件，可以改用命名空间包：

from setuptools import setup, find_namespace_packages

setup(
    packages=find_namespace_packages(),
    package_data={
        "some_package.data": ["*", "*/*"]  # 匹配当前目录和一级子目录
    }
)

方法三：通用匹配模式

对于复杂项目，可以使用更通用的匹配模式：

package_data = {pkg: ["*"] for pkg in find_namespace_packages()}

或者在 pyproject.toml 中配置：

[tool.setuptools]
package-data = {"*" = ["*"]}

环境差异说明

值得注意的是，这个问题在不同环境下表现可能不同：

1. 本地虚拟环境 vs Docker 容器环境
2. 不同 pip 版本（特别是 pip 22.x 与 23.x+ 之间的行为变化）
3. 直接安装 vs 通过 wheel/sdist 安装

建议开发者：

1. 始终使用较新的 pip 版本（23.0.0+）
2. 优先通过 wheel 分发包
3. 在 CI 中测试多种安装场景

最佳实践建议

1. 明确声明包结构：清晰定义哪些是 Python 包，哪些是纯数据目录
2. 优先使用 pyproject.toml：新的配置方式更简洁明确
3. 测试多种安装方式：包括直接安装、wheel 安装和 sdist 安装
4. 保持工具更新：使用较新版本的 setuptools 和 pip
5. 文档记录：在项目文档中明确说明数据文件的处理方式

总结

setuptools 中数据文件的处理涉及 Python 包机制、glob 模式匹配和工具链协作等多个方面。理解这些底层原理有助于开发者正确配置项目打包方式，避免出现数据文件丢失的问题。对于嵌套目录结构，建议要么明确声明为包（添加 __init__.py），要么使用命名空间包并配置适当的 glob 模式。同时，保持工具链更新可以避免许多兼容性问题。