Python包打包静态文件遇阻：如何配置与访问静态文件？

一、setup配置错误修正 #

你的setup.py存在两处关键问题：

1. package_data路径配置错误：package_data的路径是相对于对应包的根目录，而非项目根目录。你写的'foo/templates/*'是从项目根开始的路径，正确写法应为'templates/*'（因为templates直接在foo包内部）。
2. 子包识别问题：foo/templates目录缺少__init__.py（空文件即可），否则setuptools无法将其识别为合法子包，导致静态文件无法被打包。

修正后的setup.py：

import setuptools 

with open("README.md", "r") as fh: 
    description = fh.read() 

setuptools.setup( 
    name="foo", 
    version="0.0.1",
    packages=setuptools.find_packages(),  # 自动发现所有包，比手动声明更可靠
    include_package_data=True,
    install_requires=[],
    package_data={
        "foo": ["templates/*"]  # 路径相对于foo包根目录
    },
)

额外建议：配合include_package_data=True，在项目根目录添加MANIFEST.in文件，确保打包时不会遗漏静态文件：

include foo/templates/*.md

二、运行时访问静态文件的方法 #

方法1：使用importlib.resources（Python 3.9+ 推荐） #

在包内代码中（如foo/__init__.py或其他模块）：

from importlib.resources import read_text, files

# 直接读取文件内容
content = read_text("foo.templates", "data.md")

# 若需要文件路径而非内容
file_path = files("foo.templates").joinpath("data.md")
with open(file_path, "r") as f:
    content = f.read()

方法2：使用pkg_resources（兼容旧版本Python） #

import pkg_resources

# 读取文件内容（需转码为字符串）
content = pkg_resources.resource_string("foo.templates", "data.md").decode("utf-8")

# 获取文件路径
file_path = pkg_resources.resource_filename("foo.templates", "data.md")
with open(file_path, "r") as f:
    content = f.read()

注意事项 #

• 确保foo/templates目录下存在__init__.py，使其成为合法子包。
• 安装包时，使用pip install -e .（开发模式）或pip install .，确保静态文件被正确安装到site-packages目录。

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