其实对于setup.py和setup.cfg的关注是从OpenStack的源码包中开始的,OpenStack每个组件的发布时都是一个tar.gz包,同样,我们直接从github上clone代码后也会发现两个文件的存在。当阅读Nova或Ceilometer(其他组件可能也会涉及)的代码时,发现setup.cfg中内容对于代码的理解有很大的影响。那么,到底setup.py和setup.cfg是干什么的?
我们从例子开始。假设你要分发一个叫foo的模块,文件名foo.py,那么setup.py内容如下:
| 12345 | from distutils.core import setupsetup(name=\’foo\’, version=\’1.0\’, py_modules=[\’foo\’], ) |
然后,运行python setup.py sdist为模块创建一个源码包
| 123456789101112131415 | root@network:/kong/setup# python setup.py sdistrunning sdistrunning checkwarning: check: missing required meta–data: url warning: check: missing meta–data: either (author and author_email) or (maintainer and maintainer_email) must be suppliedwarning: sdist: manifest template \’MANIFEST.in\’ does not exist (using default file list)warning: sdist: standard file not found: should have one of README, README.txtwriting manifest file \’MANIFEST\’creating foo–1.0making hard links in foo–1.0…hard linking foo.py -> foo–1.0hard linking setup.py -> foo–1.0creating distCreating tar archiveremoving \’foo-1.0\’ (and everything under it) |
在当前目录下,会创建dist目录,里面有个文件名为foo-1.0.tar.gz,这个就是可以分发的包(如果使用命令python setup.py bdist_egg,那么会在dist目录中生成foo-1.0-py2.7.egg包,setup.py中第一句引入需要改为from setuptools import setup)。使用者拿到这个包后,解压,到foo-1.0目录下执行:python setup.py install,那么,foo.py就会被拷贝到python类路径下,可以被导入使用(如果安装是egg文件,会把egg文件拷贝到dist-packages目录下)。
| 123456789101112131415 | root@network:/kong/setup/dist/foo–1.0# python setup.py installrunning installrunning buildrunning build_pycreating buildcreating build/lib.linux–x86_64–2.7copying foo.py -> build/lib.linux–x86_64–2.7running install_libcopying build/lib.linux–x86_64–2.7/foo.py -> /usr/local/lib/python2.7/dist–packagesbyte–compiling /usr/local/lib/python2.7/dist–packages/foo.py to foo.pycrunning install_egg_infoRemoving /usr/local/lib/python2.7/dist–packages/foo–1.0.egg–infoWriting /usr/local/lib/python2.7/dist–packages/foo–1.0.egg–inforoot@network:/kong/setup/dist/foo–1.0# ll /usr/local/lib/python2.7/dist-packages/foofoo–1.0.egg–info foo.py foo.pyc |
对于Windows,可以执行python setup.py bdist_wininst生成一个exe文件;若要生成RPM包,执行python setup.py bdist_rpm,但系统必须有rpm命令的支持。可以运行下面的命令查看所有格式的支持:
| 12345678910 | root@network:/kong/setup# python setup.py bdist –help-formatsList of available distribution formats: —formats=rpm RPM distribution —formats=gztar gzip\’ed tar file –formats=bztar bzip2\’ed tar file —n-s\”>\’ed tar file –formats=bztar bzip2\’ed tar file —.cfg中内容对于代码的理解有很大的影响。那么,到底setup.py和setup.cfg是干什么的?
setup.py我们从例子开始。假设你要分发一个叫foo的模块,文件名foo.py,那么setup.py内容如下:
然后,运行
在当前目录下,会创建
对于Windows,可以执行
|