使用setup.py++pip跨平台支持“数据文件”`

如注释中所建议的,为了捆绑资源文件,我宁愿使用package_data并将文件放在某个package dir下例子:

project
├── pkg1
│   ├── __init__.py
│   └── icons
│       └── image.png
└── pkg2
    └── __init__.py

包装在 setup.py 脚本:

from setuptools import setup


setup(
    ...
    package_data={'pkg1': ['icons/image.png']},
)

更新以访问代码中的资源文件:

引入Python3.7 importlib.resources 它取代了旧的 pkg_resources 功能性,并提供一个利用 pathlib :

filepath = importlib_resources.path('pkg1', 'icons/image.png')

对于Python3.6及更高版本,有一个名为 importlib_resources . 因此,版本不可知的例子是:

import sys

if sys.version >= (3, 7):
    from importlib import resources as importlib_resources
else:
    import importlib_resources

filepath = importlib_resources.path('pkg1', 'icons/image.png')

使用 重要资源 而不是 包装资源 如果可能的话。

原来的答案,只为历史

要在代码中引用资源文件,请使用 包装资源 :

import pkg_resources

filepath = pkg_resources.resource_filename('pkg1', 'icons/image.png')

因此,跨平台支撑由 包装资源 . 参考 ResourceManager API 以获取可用的资源访问功能。

更新 查看 solution 从@ hoefling

这个 data_files 选项指定要为包上载的文件。

从 docs :

不使用文件中的目录信息来确定已安装文件的最终位置;只使用文件名。

如果要构建跨平台目录路径,请使用 os 模块

import os

path = os.path.join('root', 'directory')

如果您想确定平台何时有人试图构建您的包,请使用 sys 模块

import sys

current_platform = sys.platform.lower()
is_windows = current_platform.startswith('win')
is_ubuntu =  'ubuntu' in current_platform
is_mac = 'darwin' in current_platform


if is_windows:
     ... # windows specific dayta

elif is_ubuntu:
     ....

else:
    raise Exception('Platform not supported')