经常接触Python的同学可能会注意到,当需要安装第三方python包时,可能会用到easy_install命令。easy_install是由PEAK(Python Enterprise Application Kit)开发的setuptools包里带的一个命令,它用来安装egg包。egg包是目前最流行的python应用打包部署方式。如何制作和安装egg包?下面我就简单的分析了一下。

1.1   安装setuptools

首先要安装setuptools工具。Debian/Ubuntu下可以直接使用apt安装::

  1. $ sudo yum install python-setuptools

1.2   制作自己的egg包

总是安装别人的egg包,是不是也想制作自己的egg包呢?好,接下来我们就自己制作一个简单的egg包。 首先建立工程目录egg-demo,初始化一个setup.py文件:

  1. $ mkdir egg-demo
  2. $ cd egg-demo
  3. $ touch setup.py
  4. $ ls
  5. setup.py

下面主要就是填充setup.py。setup.py其实是python工具包distutils的配置文件,setuptools就是基于distutils来做的。 在setup.py中通过setup函数来配置打包信息。首先要引入setuptools的函数setup。setuptools的setup其实就是distutils的setup函数,填写setup.py为以下内容:

  1. $ vim setup.py
  2. #!/usr/bin/env python
  3. #-*- coding:utf-8 -*-
  4. from setuptools import setup
  5. setup()

在setup.py中,setup函数接收一系列属性作为配置参数。

  • name name是egg包的名称,也是寻找要打包的文件夹的名称,默认是UNKNOWN。
  • version 版本号,默认0.0.0
  • packages 这里要用到setuptools的另一个函数find_packages,顾名思义,find_packages用来将指定目录下的文件打包。
  • zip_safe 默认是False,这样在每次生成egg包时都会检查项目文件的内容,确保无误。

还有一些描述性的属性,如description,long_description,author,author_email,license,keywords,platform,url等。 填充setup.py文件如下::

  1. $ cat setup.py
  2. #! /usr/bin/env python
  3. # -*- coding: utf-8 -*-
  4. from __future__ import with_statement
  5. try:
  6. from setuptools import setup,find_packages
  7. except ImportError:
  8. from distutils.core import setup
  9. #-----ignore begin------
  10. import os
  11. import sys
  12. if sys.version_info <= (2, 5) or sys.version_info >= (2, 8):
  13. error = "ERROR: UpYun SDK requires Python Version 2.6 or 2.7 ... exiting\n"
  14. sys.stderr.write(error)
  15. sys.exit(1)
  16. #-----ignore end--------
  17. setup(
  18. name='uprsync',   #包的名称,也就是你install后,从别的python文件中导入的文件包的名称,即import uprsync;
  19. version= '0.1.0',  #版本号
  20. description='UpYun Storage SDK for Python',   #包的描述
  21. license='License :: OSI Approved :: MIT License', #遵循的协议
  22. platforms='Platform Independent',
  23. author='glcsnz123',   #作者
  24. author_email='[email protected]',   #邮箱
  25. url='',                                   #链接
  26. packages=find_packages('src'),           #此处为你要整合的包的位置,find_packages()是查找给定路径下的文件,在__init__.py中需要依靠他来找到包。
  27. package_dir = {'':'src'},                #和上面的find_packages()一同使用
  28. keywords=['uprsync', 'python', 'sdk'],     #关键字
  29. #以下可忽视
  30. classifiers=[
  31. 'Development Status :: 5 - Production/Stable',
  32. 'Intended Audience :: Developers',
  33. 'License :: OSI Approved :: MIT License',
  34. 'Operating System :: OS Independent',
  35. 'Programming Language :: Python',
  36. 'Programming Language :: Python :: 2',
  37. 'Programming Language :: Python :: 2.6',
  38. 'Programming Language :: Python :: 2.7',
  39. ],
  40. )

在egg-demo目录下建立和上述name名称相同的目录uprsync,将所要打包的py文件放置在改目录下,并在uprsync目录下写__init__.py文件:

  1. $ mkdir uprsync
  2. $ vim __init__.py

__init__.py:

  1. #!/usr/bin/env python
  2. #-*- coding:utf-8 -*-
  3. from UpYunrSync import UpYunUprSync
  4. from UpYunrSync import getLastModifyTime,SetLoggerLevel,InitLogger
  5. from UpYunrSync import LOGGER,LOGFILE
  6. def Printf():
  7. print "Hello World!\n"
  8. if __name__ == '__main__':
  9. pass

在__init__.py中需要对文件进行一个整合,相当于是你在导入uprsync包(此处你要将你制作的东西看成是一个包或者说是一个整体,而不能再按照之前的按文件个数来划分)的时候,就会调用该__init__.py,但并不会执行,也就是说if __name__ == '__main__':中的内容并不会被执行,但是会让导入uprsync包的文件拥有__init__.py相同的环境。下面会举例说明。

然后新建目录src,并将整个uprsync目录放置在src下面,按照上面的修改成find_packages(‘src')和package_dir={'':'src'},这样告诉setuptools在src目录下找包,而不是原来默认的工程根目录。

再执行下面的命令:

  1. python setup.py bdist_egg

然后再进行安装:

  1. $ sudo python setup.py install
  2. running install
  3. install_dir /usr/local/lib/python2.6/dist-packages/                             #行1
  4. ...
  5. creating /usr/local/lib/python2.6/dist-packages/demo-0.1.0-py2.6.egg
  6. Extracting demo-0.1.0-py2.6.egg to /usr/local/lib/python2.6/dist-packages
  7. uprsync 0.1.0 is already the active version in easy-install.pth                  #行2
  8. Installed /usr/local/lib/python2.6/dist-packages/demo-0.1.0-py2.6.egg            #行3
  9. Processing dependencies for uprsync==0.1.0
  10. Finished processing dependencies for uprsync==0.1.0
  11. #行1、2、3很重要,它关系着如果你要卸载安装的egg,就必须通过这3行信息来删除。如果刚开始不小心忘了记住,可以重新安装一遍。
  12. #下面来介绍如何删除

1.3   egg文件卸载

以python2.6版本为例,egg文件一般安装在/usr/local/lib/python2.6/dist-packages/目录下,该目录下还有一个easy-install.pth文件,用于存放安装的egg信息。:

  1. $ cd /usr/local/lib/python2.6/dist-packages
  2. $ cat easy-install.pth|grep uprsync
  3. ./uprsync-0.1.0-py2.6.egg
  4. $ ls -F|grep uprsync
  5. uprsync-0.1.0-py2.6.egg/
  6. $ rm -rf uprsync-0.0.0-py2.6.egg
  7. $ vim easy-install.pth
  8. dd: ./uprsync-0.1.0-py2.6.egg    #删除关于uprsync的信息

如果找不到上面的文件,可以通过重新安装,按照上面1.2最后部分所要求记录的点,对应于1.3的内容进行删除

05-11 19:23