Làm cách nào để bao gồm dữ liệu gói với setuptools / phân phối?

Khi sử dụng setuptools / phân phối, tôi không thể cài đặt trình cài đặt trong bất kỳ package_datatệp nào . Tất cả mọi thứ tôi đã đọc nói rằng sau đây là cách chính xác để làm điều đó. Ai đó có thể vui lòng tư vấn?

setup(
   name='myapp',
   packages=find_packages(),
   package_data={
      'myapp': ['data/*.txt'],
   },
   include_package_data=True,
   zip_safe=False,
   install_requires=['distribute'],
)

nơi myapp/data/là vị trí của các tập tin dữ liệu.

Tôi nhận ra rằng đây là một câu hỏi cũ, nhưng đối với những người tìm đường đến đây thông qua Google: package_datalà một lời nói dối bẩn thỉu , thấp hèn . Nó chỉ được sử dụng khi xây dựng các gói nhị phân ( python setup.py bdist ...) chứ không phải khi xây dựng các gói nguồn ( python setup.py sdist ...). Tất nhiên, điều này là vô lý - người ta sẽ mong đợi rằng việc xây dựng một phân phối nguồn sẽ dẫn đến một tập hợp các tệp có thể được gửi cho người khác để xây dựng phân phối nhị phân.

Trong mọi trường hợp, việc sử dụng MANIFEST.insẽ hoạt động cả cho phân phối nhị phân và nguồn.

Tôi chỉ có vấn đề tương tự. Các giải pháp, chỉ đơn giản là để loại bỏ include_package_data=True.

Sau khi đọc ở đây , tôi nhận ra rằng include_package_datamục đích bao gồm các tệp từ kiểm soát phiên bản , trái ngược với chỉ "bao gồm dữ liệu gói" như tên ngụ ý. Từ các tài liệu:

Các tệp dữ liệu [của include_package_data] phải nằm trong điều khiển CVS hoặc Subversion

...

Nếu bạn muốn kiểm soát chi tiết hơn đối với những tập tin nào được đưa vào (ví dụ: nếu bạn có tệp tài liệu trong thư mục gói của mình và muốn loại trừ chúng khỏi cài đặt), thì bạn cũng có thể sử dụng package_datatừ khóa.

Lấy lý lẽ đó ra đã sửa nó, điều trùng hợp là tại sao nó cũng hoạt động khi bạn chuyển sang distutils, vì nó không lấy lý lẽ đó.

Theo khuyến nghị của @Joe để xóa include_package_data=Truedòng cũng có hiệu quả với tôi.

Để giải thích thêm một chút, tôi không có MANIFEST.in tập tin. Tôi sử dụng Git chứ không phải CVS.

Kho lưu trữ có hình dạng này:

/myrepo
    - .git/
    - setup.py
    - myproject
        - __init__.py
        - some_mod
            - __init__.py
            - animals.py
            - rocks.py
        - config
            - __init__.py
            - settings.py
            - other_settings.special
            - cool.huh
            - other_settings.xml
        - words
            - __init__.py
            word_set.txt

setup.py:

from setuptools import setup, find_packages
import os.path

setup (
    name='myproject',
    version = "4.19",
    packages = find_packages(),  
    # package_dir={'mypkg': 'src/mypkg'},  # didnt use this.
    package_data = {
        # If any package contains *.txt or *.rst files, include them:
        '': ['*.txt', '*.xml', '*.special', '*.huh'],
    },

#
    # Oddly enough, include_package_data=True prevented package_data from working.
    # include_package_data=True, # Commented out.
    data_files=[
#               ('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
        ('/opt/local/myproject/etc', ['myproject/config/settings.py', 'myproject/config/other_settings.special']),
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'cool.huh')]),
#
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'other_settings.xml')]),
        ('/opt/local/myproject/data', [os.path.join('myproject/words', 'word_set.txt')]),
    ],

    install_requires=[ 'jsonschema',
        'logging', ],

     entry_points = {
        'console_scripts': [
            # Blah...
        ], },
)

Tôi chạy python setup.py sdistcho một nguồn phân phối (chưa thử nhị phân).

Và khi ở trong một môi trường ảo hoàn toàn mới, tôi có một myproject-4.19.tar.gztập tin và tôi sử dụng

(venv) pip install ~/myproject-4.19.tar.gz
...

Và ngoài mọi thứ được cài đặt vào môi trường ảo của tôi site-packages, các tệp dữ liệu đặc biệt đó được cài đặt vào /opt/local/myproject/datavà /opt/local/myproject/etc.

include_package_data=True đã làm cho tôi.

Nếu bạn sử dụng git, hãy nhớ đưa setuptools-gitvào install_requires. Ít nhàm chán hơn nhiều so với việc có Manifesthoặc bao gồm tất cả đường dẫn trong package_data(trong trường hợp của tôi là ứng dụng django với tất cả các loại thống kê)

(đã dán nhận xét tôi đã đưa ra, vì k3-rnc đã đề cập đến nó thực sự hữu ích như vậy)

Cập nhật : Câu trả lời này đã cũ và thông tin không còn giá trị. Tất cả các cấu hình setup.py nên sử dụng import setuptools. Tôi đã thêm một câu trả lời đầy đủ hơn tại https://stackoverflow.com/a/49501350/64313

Tôi đã giải quyết điều này bằng cách chuyển sang distutils. Có vẻ như phân phối bị phản đối và / hoặc bị hỏng.

from distutils.core import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_data={
      'myapp': ['data/*.txt'],
   },
)

Câu hỏi cổ xưa và ... quản lý gói của trăn thực sự để lại rất nhiều mong muốn. Vì vậy, tôi đã có trường hợp sử dụng cài đặt sử dụng pip cục bộ vào một thư mục được chỉ định và rất ngạc nhiên khi cả hai đường dẫn pack_data và data_files đều không hoạt động. Tôi không quan tâm đến việc thêm một tệp khác vào repo vì vậy cuối cùng tôi đã tận dụng tùy chọn data_files và setup.py --install-data; một cái gì đó như thế này

pip install . --install-option="--install-data=$PWD/package" -t package  

Di chuyển thư mục chứa dữ liệu gói vào thư mục mô-đun đã giải quyết vấn đề cho tôi.

Xem câu hỏi này: MANIFEST.in bị bỏ qua trên "python setup.py install" - không có tệp dữ liệu nào được cài đặt?

Tôi đã có cùng một vấn đề trong một vài ngày nhưng ngay cả chủ đề này cũng không thể giúp tôi vì mọi thứ đều khó hiểu. Vì vậy, tôi đã nghiên cứu và tìm thấy giải pháp sau đây:

Về cơ bản trong trường hợp này, bạn nên làm:

from setuptools import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_dir={'myapp':'myapp'}, # the one line where all the magic happens
   package_data={
      'myapp': ['data/*.txt'],
   },
)

Câu trả lời stackoverflow đầy đủ khác ở đây

Chỉ cần xóa dòng:

include_package_data=True,

từ tập lệnh thiết lập của bạn, và nó sẽ hoạt động tốt. (Đã thử nghiệm ngay bây giờ với setuptools mới nhất.)

Sử dụng setup.cfg (setuptools 30.3.0)

Bắt đầu với setuptools 30.3.0 (phát hành 2016-12-08), bạn có thể giữ cho mình setup.pyrất nhỏ và chuyển cấu hình sang một setup.cfgtệp. Với phương pháp này, bạn có thể đặt dữ liệu gói của mình vào một [options.package_data]phần:

[options.package_data]
* = *.txt, *.rst
hello = *.msg

Trong trường hợp này, bạn setup.pycó thể ngắn như:

from setuptools import setup
setup()

Để biết thêm thông tin, hãy xem cấu hình thiết lập bằng các tệp setup.cfg .

Có một số thảo luận về việc phản đốisetup.cfg ủng hộ pyproject.tomlnhư được đề xuất trong PEP 518 , nhưng điều này vẫn chỉ là tạm thời vào năm 2020-2-21.