2 techniki dołączania plików w dystrybucji Pythona: co jest lepsze?

Question

pracuję na opakowaniach mały projekt Pythona jako plik zip lub jajka tak, że może być rozpowszechniany. Znalazłem 2 sposoby na dołączenie plików konfiguracyjnych projektu, z których oba wydają się dawać identyczne wyniki.

Metoda 1:

Dołącz ten kod w setup.py:

from distutils.core import setup 

setup(name='ProjectName', 
     version='1.0', 
     packages=['somePackage'], 
     data_files = [('config', ['config\propFiles1.ini', 
           'config\propFiles2.ini', 
           'config\propFiles3.ini'])] 
    ) 

Metoda 2:

Dołącz ten kod w setup.py:

from distutils.core import setup 

setup(name='ProjectName', 
     version='1.0', 
     packages=['somePackage'] 
    ) 

Następnie, utwórz plik MANIFEST.in z tym wierszem:

include config\* 

Czy jest jakaś różnica między tymi metodami? Który z nich jest preferowany? Zwykle skłaniam się ku pierwszemu, ponieważ wtedy wcale nie jest potrzebny plik MANIFEST.in. Jednak w pierwszej metodzie musisz określić każdy plik indywidualnie, podczas gdy w drugim możesz po prostu dołączyć cały folder. Czy jest coś jeszcze, co powinienem wziąć pod uwagę? Jaka jest standardowa praktyka?

Answer 1

MANIFEST.in kontroluje jakie pliki są umieszczane w pliku zip dystrybucyjnej podczas rozmowy python setup.py sdist. Kontroluje to, co jest zainstalowane, nie ma wartości . data_files (lub lepiej package_data) kontroluje co są zainstalowane pliki (i myślę, że również sprawia, że ​​pliki są zawarte w pliku zip). Użyj MANIFEST.in plików nie zainstaluje, jak dokumentacja i package_data dla plików, które nie korzystają z kodu Pythona (jak obraz lub szablonu).