setuptools: розташування папки даних пакета

Question 1

Я використовую setuptools для розповсюдження мого пакету python. Тепер мені потрібно розподілити додаткові файли даних.

З того, що я зібрав із документації setuptools, мені потрібно мати файли даних всередині каталогу пакунків. Однак я б віддав перевагу своїм файлам даних всередині підкаталогу в кореневому каталозі.

Чого б я хотів уникати:

/ #root
|- src/
|  |- mypackage/
|  |  |- data/
|  |  |  |- resource1
|  |  |  |- [...]
|  |  |- __init__.py
|  |  |- [...]
|- setup.py

Що я хотів би мати замість цього:

/ #root
|- data/
|  |- resource1
|  |- [...]
|- src/
|  |- mypackage/
|  |  |- __init__.py
|  |  |- [...]
|- setup.py

Мені просто неприємно мати таку кількість підкаталогів, якщо це не важливо. Я не можу знайти причину, чому я / маю / розміщувати файли всередині каталогу пакунків. Також громіздко працювати з такою кількістю вкладених підкаталогів IMHO. Або є якась вагома причина, яка б виправдовувала це обмеження?

Question 2

Варіант 1: Встановити як дані пакета

Основною перевагою розміщення файлів даних всередині кореневого пакета Python є те, що він дозволяє вам не турбуватися про те, де будуть знаходитись файли в системі користувача, якою може бути Windows, Mac, Linux, якась мобільна платформа або всередині Egg. Ви завжди можете знайти каталог dataщодо кореня пакета Python, незалежно від того, де і як він встановлений.

Наприклад, якщо я маю макет проекту приблизно так:

project/
    foo/
        __init__.py
        data/
            resource1/
                foo.txt

Ви можете додати функцію, щоб __init__.pyзнайти абсолютний шлях до файлу даних:

import os

_ROOT = os.path.abspath(os.path.dirname(__file__))
def get_data(path):
    return os.path.join(_ROOT, 'data', path)

print get_data('resource1/foo.txt')

Виходи:

/Users/pat/project/foo/data/resource1/foo.txt

Після встановлення проекту як яйце шлях до data зміниться, але код не потрібно змінювати:

/Users/pat/virtenv/foo/lib/python2.6/site-packages/foo-0.0.0-py2.6.egg/foo/data/resource1/foo.txt

Варіант 2: Встановіть у фіксованому місці

Альтернативою може бути розміщення даних поза пакетом Python, а потім:

Майте місце розташування data передане через файл конфігурації, аргументи командного рядка або
Вбудуйте розташування у свій код Python.

Це набагато менш бажано, якщо ви плануєте поширювати свій проект. Якщо ви дійсно хочете зробити це, ви можете встановити свій dataде завгодно на цільовій системі, вказавши призначення для кожної групи файлів, передавши список кортежів:

from setuptools import setup
setup(
    ...
    data_files=[
        ('/var/data1', ['data/foo.txt']),
        ('/var/data2', ['data/bar.txt'])
        ]
    )

Оновлено : Приклад функції оболонки для рекурсивного grep-файлів Python:

atlas% function grep_py { find . -name '*.py' -exec grep -Hn $* {} \; }
atlas% grep_py ": \["
./setup.py:9:    package_data={'foo': ['data/resource1/foo.txt']}

Question 3

Я думаю, що знайшов хороший компроміс, який дозволить вам зберегти таку структуру:

/ #root
|- data/
|  |- resource1
|  |- [...]
|- src/
|  |- mypackage/
|  |  |- __init__.py
|  |  |- [...]
|- setup.py

Вам слід встановити дані як package_data, щоб уникнути проблем, описаних у відповіді samplebias, але для того, щоб зберегти структуру файлу, слід додати до вашого setup.py:

try:
    os.symlink('../../data', 'src/mypackage/data')
    setup(
        ...
        package_data = {'mypackage': ['data/*']}
        ...
    )
finally:
    os.unlink('src/mypackage/data')

Таким чином ми створюємо відповідну структуру "точно вчасно" та організовуємо наше дерево джерел.

Щоб отримати доступ до таких файлів даних у коді, ви просто "використовуєте":

data = resource_filename(Requirement.parse("main_package"), 'mypackage/data')

Мені все ще не подобається вказувати в коді "mypackage", оскільки дані не можуть мати нічого спільного з цим модулем, але я думаю, це хороший компроміс.

Question 4

Я думаю, що ви можете навести що завгодно як аргумент * data_files * для setup () .