Perché "python setup.py sdist" crea indesiderati "PROJECT-egg.info" nella directory principale del progetto?

Question

Quando eseguo

python setup.py sdist 

si crea una sdist nella mia directory ./dist. Questo include un file "PROJECT-egg.info" nello zip all'interno della mia cartella "dist", che non uso, ma non mi fa male, quindi lo ignoro.

mia domanda è perché vuol anche creare una cartella "PROJECT-egg.info" nella mia cartella principale del progetto? Posso farlo smettere di creare questo? In caso contrario, posso cancellarlo immediatamente dopo aver creato il sdist?

Sto usando la funzione 'setup' importata da setuptools. WindowsXP, Python2.7, Setuptools 0.6c11, Distribuisci 0.6.14.

La mia configurazione config assomiglia:

{'author': 'Jonathan Hartley', 
'author_email': 'tartley@tartley.com', 
'classifiers': ['Development Status :: 1 - Planning', 
       'Intended Audience :: Developers', 
       'License :: OSI Approved :: BSD License', 
       'Operating System :: Microsoft :: Windows', 
       'Programming Language :: Python :: 2.7'], 
'console': [{'script': 'demo.py'}], 
'data_files': [('Microsoft.VC90.CRT', 
       ['..\\lib\\Microsoft.VC90.CRT\\Microsoft.VC90.CRT.manifest', 
        '..\\lib\\Microsoft.VC90.CRT\\msvcr90.dll'])], 
'description': 'Utilities for games and OpenGL graphics, built around Pyglet.\n', 
'keywords': '', 
'license': 'BSD', 
'long_description': "blah blah blah", 
'name': 'pygpen', 
'options': {'py2exe': {'ascii': True, 
         'bundle_files': 1, 
         'dist_dir': 'dist/pygpen-0.1-windows', 
         'dll_excludes': [], 
         'excludes': ['_imaging_gif', 
            '_scproxy', 
            'clr', 
            'dummy.Process', 
            'email', 
            'email.base64mime', 
            'email.utils', 
            'email.Utils', 
            'ICCProfile', 
            'Image', 
            'IronPythonConsole', 
            'modes.editingmodes', 
            'startup', 
            'System', 
            'System.Windows.Forms.Clipboard', 
            '_hashlib', 
            '_imaging', 
            '_multiprocessing', 
            '_ssl', 
            '_socket', 
            'bz2', 
            'pyexpat', 
            'pyreadline', 
            'select', 
            'win32api', 
            'win32pipe', 
            'calendar', 
            'cookielib', 
            'difflib', 
            'doctest', 
            'locale', 
            'optparse', 
            'pdb', 
            'pickle', 
            'pyglet.window.xlib', 
            'pyglet.window.carbon', 
            'pyglet.window.carbon.constants', 
            'pyglet.window.carbon.types', 
            'subprocess', 
            'tarfile', 
            'threading', 
            'unittest', 
            'urllib', 
            'urllib2', 
            'win32con', 
            'zipfile'], 
         'optimize': 2}}, 
'packages': ['pygpen'], 
'scripts': ['demo.py'], 
'url': 'http://code.google.com/p/edpath/', 
'version': '0.1', 
'zipfile': None} 

Answer 1

Questa directory viene creata intenzionalmente come parte del processo di generazione per una distribuzione sorgente. Un po 'un'occhiata alla developer guide for setuptools si dà un suggerimento sul perché:

Ma, assicurarsi di ignorare qualsiasi parte della documentazione distutils che si occupa con manifesto o come è generata da MANIFEST.in; setuptools scudi voi da questi problemi e non funziona allo stesso modo in ogni caso. A differenza dei Distutils, setuptools rigenera il file manifesto distribuzione sorgente ogni volta che si genera una fonte di distribuzione, e si costruisce dentro directory .egg-info del progetto, fuori del modo della directory principale del progetto . Pertanto non è necessario che lo sia aggiornato o meno .

È possibile eliminare la directory in modo sicuro al completamento della compilazione.

Bonus edit:

personalizzo il comando clean nel mio setup.py su molti dei miei progetti Python per eliminare *.egg-info, dist, build, e *.pyc e altri file. Ecco un esempio di come si fa in setup.py:

import os 
from setuptools import setup, Command 

class CleanCommand(Command): 
    """Custom clean command to tidy up the project root.""" 
    user_options = [] 
    def initialize_options(self): 
     pass 
    def finalize_options(self): 
     pass 
    def run(self): 
     os.system('rm -vrf ./build ./dist ./*.pyc ./*.tgz ./*.egg-info') 

# Further down when you call setup() 
setup(
    # ... Other setup options 
    cmdclass={ 
     'clean': CleanCommand, 
    } 
) 

Per illustrare, dopo l'esecuzione python setup.py build su un progetto fittizio denominato "cacca" (Sì, sono molto maturo), questo accade:

$ python setup.py build 
running build 
running build_py 
creating build 
creating build/lib 
creating build/lib/poop 
copying poop/__init__.py -> build/lib/poop 

E ora se corriamo python setup.py clean:

$ python setup.py clean 
running clean 
removed `./build/lib/poop/__init__.py' 
removed directory: `./build/lib/poop' 
removed directory: `./build/lib' 
removed directory: `./build' 

Tada!

Answer 2

Nota che è possibile far scomparire completamente gli artefatti PROJECT.egg-info dal proprio sdist.

Il comando setup.py egg_info utilizzerà la radice di origine come base uovo per impostazione predefinita, facendo in modo che la directory PROJECT.egg-info sia impacchettata nel sdist.

È possibile configurare la base dell'uovo passando l'opzione --egg-base. Ciò creerà la directory PROJECT.egg-info da qualche altra parte, lasciandola completamente fuori dalla vostra distribuzione di origine. Potresti anche usare un setup.cfg per impostare quella proprietà.

il seguente comando per creare uno sdist senza un PROJECT.egg-info opere per me:

python setup.py egg_info --egg-base /tmp sdist 

O in un setup.cfg:

[egg_info] 
egg_base = /tmp 

Answer 3

La cartella -egg.info non è sempre un manufatto provvisorio è possibile eliminare .

Per esempio, se si utilizza pip install -e YOURPACKAGE per un "modificabile" installazione (opere tramite collegamento simbolico come python setup.py develop quindi non c'è bisogno di re-installare un pacchetto ogni volta che si modifica a livello locale), la cartella -egg.info è necessaria in fase di esecuzione quando il tuo pacchetto è importato in un'altra fonte. Se non esiste, si otterrà un errore DistributionNotFound.