setuptools: vị trí thư mục dữ liệu gói

Question 1

Tôi sử dụng setuptools để phân phối gói python của mình. Bây giờ tôi cần phân phối các tệp dữ liệu bổ sung.

Từ những gì tôi thu thập được từ tài liệu setuptools, tôi cần có các tệp dữ liệu của mình bên trong thư mục gói. Tuy nhiên, tôi muốn có các tệp dữ liệu của mình bên trong một thư mục con trong thư mục gốc.

Những gì tôi muốn tránh:

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

Những gì tôi muốn có thay thế:

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

Tôi chỉ không cảm thấy thoải mái khi có quá nhiều thư mục con, nếu nó không cần thiết. Tôi không tìm thấy lý do, tại sao tôi / có / để đặt các tệp bên trong thư mục gói. Nó cũng cồng kềnh khi làm việc với quá nhiều thư mục con lồng nhau IMHO. Hoặc có lý do chính đáng nào biện minh cho hạn chế này không?

Question 2

Tùy chọn 1: Cài đặt dưới dạng dữ liệu gói

Ưu điểm chính của việc đặt các tệp dữ liệu bên trong thư mục gốc của gói Python là nó cho phép bạn tránh lo lắng về vị trí các tệp sẽ sống trên hệ thống của người dùng, có thể là Windows, Mac, Linux, một số nền tảng di động hoặc bên trong Egg. Bạn luôn có thể tìm thấy thư mục dataliên quan đến thư mục gốc của gói Python, bất kể nó được cài đặt ở đâu hoặc như thế nào.

Ví dụ: nếu tôi có bố cục dự án như vậy:

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

Bạn có thể thêm một hàm để __init__.pyđịnh vị đường dẫn tuyệt đối đến tệp dữ liệu:

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')

Kết quả đầu ra:

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

Sau khi dự án được cài đặt dưới dạng Egg, đường dẫn đến datasẽ thay đổi, nhưng mã không cần thay đổi:

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

Tùy chọn 2: Cài đặt đến vị trí cố định

Giải pháp thay thế sẽ là đặt dữ liệu của bạn bên ngoài gói Python và sau đó:

Có vị trí datađược chuyển vào qua tệp cấu hình, đối số dòng lệnh hoặc
Nhúng vị trí vào mã Python của bạn.

Điều này ít được mong đợi hơn nếu bạn định phân phối dự án của mình. Nếu bạn thực sự muốn làm điều này, bạn có thể cài đặt databất cứ nơi nào bạn muốn trên hệ thống đích bằng cách chỉ định đích cho từng nhóm tệp bằng cách chuyển vào danh sách các bộ giá trị:

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

Đã cập nhật : Ví dụ về hàm shell để ghi tệp Python một cách đệ quy:

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

Tôi nghĩ rằng tôi đã tìm thấy một thỏa hiệp tốt sẽ cho phép bạn nắm được cấu trúc sau:

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

Bạn nên cài đặt dữ liệu dưới dạng package_data, để tránh các vấn đề được mô tả trong câu trả lời samplebias, nhưng để duy trì cấu trúc tệp, bạn nên thêm vào setup.py:

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

Bằng cách này, chúng tôi tạo ra cấu trúc thích hợp "đúng lúc" và đảm bảo cây nguồn của chúng tôi có tổ chức.

Để truy cập các tệp dữ liệu như vậy trong mã của bạn, bạn 'chỉ cần' sử dụng:

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

Tôi vẫn không thích phải chỉ định 'mypackage' trong mã, vì dữ liệu có thể không liên quan gì đến mô-đun này một cách cần thiết, nhưng tôi đoán đó là một thỏa hiệp tốt.

Question 4

Tôi nghĩ rằng về cơ bản bạn có thể cung cấp bất kỳ thứ gì dưới dạng đối số * data_files * cho setup () .