Python包管理⼯具setuptools
平常我们习惯了使⽤pip来安装⼀些第三⽅模块，这个安装过程之所以简单，是因为模块开发者为我们默默地为我们做了所有繁杂的⼯作，⽽这个过程就是打包。 打包，就是将你的源代码进⼀步封装，并且将所有的项⽬部署⼯作都事先安排好，这样使⽤者拿到后即装即⽤，不⽤再操⼼如何部署的问题。
包分发的始祖：distutils
distutils 是 Python 的⼀个标准库，从命名上很容易看出它是⼀个分发（distribute）⼯具（utlis），它是 Python 官⽅开发的⼀个分发打包⼯具，所有后续的打包⼯具，全部都是基于它进⾏开发的。
distutils 的精髓在于编写 setup.py，它是模块分发与安装的指导⽂件。
你有可能没写过 setup.py ，但你绝对使⽤过 setup.py 来做⼀些事情，⽐如下⾯这条命令，我们经常⽤它来进⾏模块的安装。
1python setup.py install
这样的安装⽅法是通过源码安装，与之对应的是通过⼆进制软件包的安装。
分发⼯具升级：setuptools
setuptools 是 distutils 增强版，不包括在标准库中。其扩展了很多功能，能够帮助开发者更好的创建和分发 Python 包。⼤部分 Python ⽤
户都会使⽤更先进的 setuptools 模块。
distribute 是 setuptools 有⼀个分⽀版本，分⽀的原因可能是有⼀部分开发者认为 setuptools 开发太慢了。但现在，distribute ⼜合并回
了 setuptools 中。因此，我们可以认为它们是同⼀个东西。
如何在⼀个⼲净的环境中安装 setuptools 呢？
主要有两种⽅法：
源码安装：在中下载 zip 包解压执⾏ python setup.py install 安装
通过引导程序安装：下载引导程序，它可以⽤来下载或者更新最新版本的 setuptools
1 2 3 4 5 6 7 8$ wget lecommunity/dist/ez_setup.py # 安装
$ python ez_setup.py
# 更新，以下两种任选
$ python ez_setup.py –U setuptools
$ pip install -U setuptools
easy_install 使⽤指南
当你安装完 setuptools 后，就拥有了⼀个叫做 easy_install 的第三⽅管理⼯具，这也是它区分于 distutils 的⼀⼤改进。这⾥简单介绍⼀下它的⽤法，虽然它已经⽤得⾮常少了。
先是包的安装
1
2 3 4 5 6 7 8 9 10# 通过包名，从PyPI寻最新版本，⾃动下载、编译、安装$ easy_install pkg_name
# 通过包名从指定下载页寻链接来安装或升级包
$ easy_install -f /package_index.html
# 指定线上的包地址安装
$ easy_install example/path/to/MyPackage-1. # 从本地的 .egg ⽂件安装
10 11 12 13 14 15# 从本地的 .egg ⽂件安装
$ easy_
# 在安装时你可以添加额外的参数
指定安装⽬录：--install-dir=DIR, -d DIR 指定⽤户安装：--user
细胞培养工作站
再者是包的升级
1 2 3 4 5# 从 pypi 中搜索并升级包
$ easy_install --upgrade pkg_name # 指定版本进⾏升级
$ easy_install "SomePackage==2.0"
最后是包的删除
1$ easy_install -m pkg_name
需要注意的是，这样的删除，仅是在 easy-install.pth ⽂件中删除，使其不能在 python 中使⽤这个模块，但实际的包还在
你的电脑中，若要删除彻底，需要你⼿动删除相关的 .egg 及其他⽂件。
源码包与⼆进制包什么区别？
Python 包的分发可以分为两种：
1. 以源码包的⽅式发布
源码包安装的过程，是先解压，再编译，最后才安装，所以它是跨平台的，由于每次安装都要进⾏编译，相对⼆进包安装⽅式来说安装速度较慢。
源码包的本质是⼀个压缩包。
2. 以⼆进制包形式发布
⼆进制包的安装过程省去了编译的过程，直接进⾏解压安装，所以安装速度较源码包来说更快。由于不同平台的编译出来的包⽆法通⽤，所以在发布时，需事先编译好多个平台的包。
eggs 与 wheels 有什么区别
Egg 格式是由 setuptools 在 2004 年引⼊，⽽ Wheel 格式是由 PEP427 在 2012 年定义。Wheel 的出现是为了替代 Egg，它的本质是⼀个zip包，
其现在被认为是 Python 的⼆进制包的标准格式。以下是 Wheel 和 Egg 的主要区别：
Wheel 有⼀个官⽅的 PEP427 来定义，⽽ Egg 没有 PEP 定义
Wheel 是⼀种分发格式，即打包格式。⽽ Egg 既是⼀种分发格式，也是⼀种运⾏时安装的格式，并且是可以被直接 import
Wheel ⽂件不会包含 .pyc ⽂件
Wheel 使⽤和 PEP376 兼容的 .dist-info ⽬录，⽽ Egg 使⽤ .egg-info ⽬录
Wheel 有着更丰富的命名规则。
Wheel 是有版本的。每个 Wheel ⽂件都包含 wheel 规范的版本和打包的实现
Wheel 在内部被 sysconfig path type 管理，因此转向其他格式也更容易
wheel 包可以通过 pip 来安装，只不过需要先安装 wheel 模块，然后再使⽤ pip 的命令。
1 2$ pip install wheel
$ pip wheel --wheel-dir=/local/wheels pkg
setup.py 的如何编写
打包分发最关键的⼀步是编写 setup.py ⽂件。以下是⼀个 setup.py 简单的使⽤⽰例：
1
2 3 4 5from setuptools import setup, find_packages setup(
name="mytest",
6 7 8 9 10 11 12 13 14 15 version="1.0",
author="wangbm",
author_email="wongbingming@163",
description="Learn to Pack Python Module",
# 项⽬主页
url="python-online/",
# 你要安装的包，通过 setuptools.find_packages 到当前⽬录下有哪些包 packages=find_packages()
)
接下来，将慢慢扩充这个setup函数，增加更多的参数，以便你能理解setup函数能做哪些事情。程序分类信息
1
2
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28from setuptools import setup, find_packages setup(
classifiers =[
# 发展时期，常见的如下
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 3 - Alpha',
# 开发的⽬标⽤户
'Intended Audience :: Developers',
# 属于什么类型
'Topic :: Software Development :: Build Tools', # 许可证信息压铸机料筒的设计
'License :: OSI Approved :: MIT License',
# ⽬标 Python 版本
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
]
)
关于⽂件的分发1
2
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23from setuptools import setup, find_packages
setup(
name="mytest",
version="1.0",
author="wangbm",
author_email="wongbingming@163",
description="Learn to Pack Python Module",
url="python-online/",
packages=find_packages(),
# 安装过程中，需要安装的静态⽂件，如配置⽂件、service⽂件、图⽚等 data_files=[
('', ['conf/*.conf']),
('/usr/lib/systemd/system/', ['bin/*.service']),
],
# 希望被打包的⽂件
package_data={
'':['*.txt'],
'bandwidth_reporter':['*.txt']
},
# 不打包某些⽂件
exclude_package_data={
24 25 26 27 28 'bandwidth_reporter':['*.txt'] }
)
除了以上的参数配置之外，还可以使⽤⼀个叫做 MANIFEST.in 的⽂件，来控制⽂件的分发。如下这是⼀个 MANIFEST.in 的样例：
1 2 3include *.txt
ome 103recursive-include examples *.txt *.py prune examples/sample?/build
这些配置，规定了如下⼏点
所有根⽬录下的以 txt 为后缀名的⽂件，都会分发
根⽬录下的 examples ⽬录和 txt、py⽂件都会分发
路径匹配上 examples/sample?/build 不会分发
MANIFEST.in 需要放在和 setup.py 同级的顶级⽬录下，setuptools 会⾃动读取该⽂件。关于依赖包下载安装
1
2
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34from setuptools import setup, find_packages
setup(
...
# 表明当前模块依赖哪些包，若环境中没有，则会从pypi中下载安装
install_requires=['docutils>=0.3'],
# setup.py 本⾝要依赖的包，这通常是为⼀些setuptools的插件准备的配置
# 这⾥列出的包，不会⾃动安装。
setup_requires=['pbr'],
# 仅在测试时需要使⽤的依赖，在正常发布的代码中是没有⽤的。
雨水口
# 在执⾏python setup.py test时，可以⾃动安装这三个库，确保测试的正常运⾏。
tests_require=[
'pytest>=3.3.1',
'pytest-cov>=2.5.1',
],
# ⽤于安装setup_requires或tests_require⾥的软件包
# 这些信息会写⼊egg的 metadata 信息中
dependency_links=[
"example2/p/foobar-1.",
],
大花石上莲
# install_requires 在安装模块时会⾃动安装依赖包
# ⽽ extras_require 不会，这⾥仅表⽰该模块会依赖这些包
# 但是这些包通常不会使⽤到，只有当你深度使⽤模块时，才会⽤到，这⾥需要你⼿动安装 extras_require={
'PDF': ["ReportLab>=1.2", "RXP"],
'reST': ["docutils>=0.3"],
}
)
关于安装环境的限制
有些库并不是在所有的 Python 版本中都适⽤的，若⼀个库安装在⼀个未兼容的 Python 环境中，理论上不应该在使⽤时才报错，⽽应该在安装过程就使其失败，
提⽰禁⽌安装。这样的功能，可以使⽤python_requires来实现。
1 2 3 4setup(
...
python_requires='>=2.7, <=3', )
⽣成可执⾏⽂件的分发1
2
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25from setuptools import setup, find_packages
setup(
name="mytest",
version="1.0",
author="wangbm",
author_email="wongbingming@163",
description="Learn to Pack Python Module",
url="python-online/",
packages=find_packages(),
# ⽤来⽀持⾃动⽣成脚本，安装后会⾃动⽣成 /usr/bin/foo 的可执⾏⽂件 # 该⽂件⼊⼝指向 foo/main.py 的main 函数
entry_points={
'console_scripts': [
'foo = foo.main:main'
]
},
# 将 bin/foo.sh 和 bar.py 脚本，⽣成到系统 PATH中
# 执⾏ python setup.py install 后
# 会⽣成如 /usr/bin/foo.sh 和如 /usr/bin/bar.py
scripts=['bin/foo.sh', 'bar.py']
)
上⾯的 scripts ⾥有的脚本中有 sh 和 py 后缀，那么安装后，setuptools 会原封不动的移动到 /usr/bin 中，并添加可执⾏权限。若你想对这些⽂件再作⼀些更改，⽐如去掉多余的后缀，可以这样做
1
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24from setuptoolsmand.install_scripts import install_scripts class InstallScripts(install_scripts):
def run(self):
setuptoolsmand.install_scripts.install_scripts.run(self) # Rename some script files
for script _outputs():
dswith(".py") dswith(".sh"): dest =script[:-3]
else:
continue
print("moving %s to %s"%(script, dest))
setup(
...
镁碳砖
scripts=['bin/foo.sh', 'bar.py'],
cmdclass={
"install_scripts": InstallScripts
}
)
ext_modules
ext_modules 参数⽤于构建 C 和 C++ 扩展扩展包。其是 Extension 实例的列表，每⼀个 Extension 实例描述了⼀个独⽴的扩展模块，扩展模块可以设置扩展包名，头⽂件、源⽂件、链接库及其路径、宏定义和编辑参数等。如：
1 2 3 4 5 6setup(
# other
ext_modules=[
Extension('foo',
glob(path.join(here, 'src', '*.c')),
libraries =[ 'rt'],
include_dirs=[_include()])
豫公网安备41160202000603
站长QQ:729038198
关于我们
投诉建议