Tạo kiểu phân phối khác nhau với setup.py

Question

Do sau (trình diễn) bố trí dự án:

MyProject/ 
    README 
    LICENSE 
    setup.py 
    myproject/ 
     ... # packages 
    extrastuff/ 
     ... # some extra data 

thế nào (và ở đâu) để tôi khai báo các loại phân phối khác nhau? Đặc biệt tôi cần hai tùy chọn sau đây:

1. Một phân phối chỉ chứa nguồn

2. Một phân phối có chứa nguồn và tất cả các file dữ liệu dưới (extrastuff)

Lý tưởng nhất, làm thế nào tôi khai báo hai cấu hình trên trong khi cấu hình thứ hai phụ thuộc vào cấu hình đầu tiên?

Answer 1

Tôi đã thực hiện một cái gì đó như thế này trước đây ... lệnh sdist có thể được mở rộng để xử lý các đối số dòng lệnh bổ sung và để thao tác các tệp dữ liệu dựa trên các đối số này. Nếu bạn chạy python setup.py sdist --help, nó sẽ bao gồm các đối số dòng lệnh tùy chỉnh của bạn trong trợ giúp, điều này rất hay. Sử dụng công thức sau:

from distutils import log 
from distutils.core import setup 
from distutils.command.sdist import sdist 

class CustomSdist(sdist): 

    user_options = [ 
     ('packaging=', None, "Some option to indicate what should be packaged") 
    ] + sdist.user_options 

    def __init__(self, *args, **kwargs): 
     sdist.__init__(self, *args, **kwargs) 

     self.packaging = "default value for this option" 

    def get_file_list(self): 

     log.info("Chosen packaging option: {self.packaging}".format(self=self)) 

     # Change the data_files list here based on the packaging option 
     self.distribution.data_files = list(
      ('folder', ['file1', 'file2']) 
     ) 
     sdist.get_file_list(self) 

if __name__ == "__main__": 

    setup(
     name = "name", 
     version = "version", 
     author = "author", 
     author_email = "author_email", 
     url = "url", 
     py_modules = [ 
      # ... 
     ], 
     packages = [ 
      # ... 
     ], 
#  data_files = default data files for commands other than sdist if you wish 
     cmdclass={ 
      'sdist': CustomSdist 
     } 
    ) 

Answer 2

Bạn có thể mở rộng setup.py để bổ sung thêm một số phân tích cú pháp dòng lệnh tùy chỉnh. Sau đó, bạn có thể bắt được đối số tùy chỉnh và loại bỏ đối số đó để nó không ảnh hưởng đến setuptools.

Bạn có thể truy cập đối số dòng lệnh trong sys.argv. Đối với thay đổi cuộc gọi đến setuptools.setup(), tôi khuyên bạn nên tạo một từ điển của các đối số để vượt qua, sửa đổi điển dựa trên các đối số dòng lệnh, và sau đó gọi setup() sử dụng **dict ký hiệu, như vậy:

from setuptools import setup 
import sys 

basic = {'name': 'my program'} 
extra = {'bonus': 'content'} 

if '--extras' in sys.argv: 
    basic.update(extra) 
    sys.argv.remove('--extras') 

setup(**basic) 

Đối với kỹ hơn phân tích cú pháp dòng lệnh, bạn cũng có thể sử dụng getopt module hoặc argparse module mới hơn nếu bạn chỉ nhắm mục tiêu Python 2.7 trở lên.

CHỈNH SỬA: Tôi cũng tìm thấy một phần trong tài liệu có tên là Creating a new Distutils command. Đó cũng có thể là một nguồn hữu ích.