00-Python 打包工具 setuptools 简介
distutils
: 打包鼻祖,所有打包工具的基础,官方支持。setuptools
:distutils
的升级版。重要distribute
:setuptools
的分支,现在合并回了setuptools
。distutils2
:已废弃。
为什么需要对项目分发打包?
平常我们习惯了使用 pip 来安装一些第三方模块,这个安装过程之所以简单,是因为模块开发者为我们默默地为我们做了所有繁杂的工作,而这个过程就是 打包
。
打包,就是将你的源代码进一步封装,并且将所有的项目部署工作都事先安排好,这样使用者拿到后即装即用,不用再操心如何部署的问题(如果你不想对照着一堆部署文档手工操作的话)。
不管你是在工作中,还是业余准备自己写一个可以上传到 PyPI 的项目,你都要学会如何打包你的项目。
Python 发展了这么些年了,项目打包工具也已经很成熟了。他们都有哪些呢?
你可能听过 distutils
、distutils2
、setuptools
等等,好像很熟悉,却又很陌生,他们都是什么关系呢?
2. 包分发的始祖:distutils
distutils
是 Python 的一个标准库,从命名上很容易看出它是一个分发(distribute)工具(utlis),它是 Python 官方开发的一个分发打包工具,所有后续的打包工具,全部都是基于它进行开发的。
distutils
的精髓在于编写 setup.py,它是模块分发与安装的指导文件。
你有可能没写过 setup.py ,但你绝对使用过 setup.py 来做一些事情,比如下面这条命令,我们经常用它来进行模块的安装。
1 |
|
这样的安装方法是通过源码安装,与之对应的是通过二进制软件包的安装,我会在后面进行介绍。
3. 分发工具升级:setuptools
setuptools
是 distutils 增强版,不包括在标准库中。其扩展了很多功能,能够帮助开发者更好的创建和分发 Python 包。大部分 Python 用户都会使用更先进的 setuptools 模块。
distribute。distribute 是 setuptools 有一个分支版本,分支的原因可能是有一部分开发者认为 setuptools 开发太慢了。但现在,distribute 又合并回了 setuptools 中。因此,我们可以认为它们是同一个东西。
distutils2。还有一个大包分发工具是 distutils2,其试图尝试充分利用distutils、detuptools 和 distribute 并成为 Python 标准库中的标准工具。但该计划并没有达到预期的目的,且已经是一个废弃的项目。
因此,setuptools 是一个优秀的,可靠的 Python 包安装与分发工具。setuptools提供的主要的功能有:
- python库的打包分发
- 依赖包安装与版本管理
- python环境限制
- 生成脚本
- c/c++ 拓展
源码包与二进制包区别
python库的打包分发方式有两种:源码包source dist(简称sdist)、二进制包binary dist(简称bdist)。
1、源码包
源码包安装的过程,是先解压,再编译,最后才安装,所以它是跨平台的,由于每次安装都要进行编译,相对二进包安装方式来说安装速度较慢。
源码包的本质是一个压缩包,其常见的格式有:
格式 | 后缀 |
---|---|
zip | .zip |
gztar | .tar.gz |
bztar | .tar.bz2 |
ztar | .tra.Z |
tar | .tar |
2、二进制包
二进制包的安装过程省去了编译的过程,直接进行解压安装,所以安装速度较源码包来说更快。
由于不同平台的编译出来的包无法通用,所以在发布时,需事先在对应的平台编译好多个平台的包。
二进制包的常见格式有:
格式 | 后缀 |
---|---|
egg | .egg |
wheel | .whl |
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 |
|