setuptools：パッケージデータフォルダーの場所

Question 1

私はsetuptoolsを使用してpythonパッケージを配布しています。次に、追加のデータファイルを配布する必要があります。

setuptoolsのドキュメントから収集したものから、データファイルをパッケージディレクトリ内に置く必要があります。ただし、ルートディレクトリのサブディレクトリ内にデータファイルを配置したいのですが。

私が避けたいこと：

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

代わりにしたいもの：

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

必須ではないので、私はサブディレクトリをたくさん持つことに抵抗があります。理由を見つけることができません。なぜ/ have /を使って、ファイルをパッケージディレクトリ内に配置しますか。非常に多くのネストされたサブディレクトリ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'])
        ]
    )

更新：Pythonファイルを再帰的にgrepするシェル関数の例：

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

samplebiasの回答で説明されている問題を回避するには、データをpackage_dataとしてインストールする必要がありますが、ファイル構造を維持するには、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（）に与えることができると思います。