2.Python入门之 -- Python 包管理工具解惑

本站文章除注明转载外,均为本站原创或者翻译。

本站文章欢迎各种形式的转载,但请18岁以上的转载者注明文章出处,尊重我的劳动,也尊重你的智商;

本站部分原创和翻译文章提供markdown格式源码,欢迎使用文章源码进行转载;

本博客采用WPCMD维护;

本文标题:Python 包管理工具解惑

本文链接:http://zengrong.net/post/2169.htm

一、困惑

作为一个 Python 初学者,我在包管理上感到相当疑惑(嗯,是困惑)。主要表现在下面几个方面:

这几个包管理工具有什么不同?

distutils

setuptools

distribute

disutils2

distlib

pip

什么时候该用pip,什么时候该用setup.py,它们有关系么?

easy_install、ez_setup.py、setup.py、setup.cfg分别都是干啥的?

wheel 和 pip 的关系?

Egg 和 whl 的关系?

如何发布自己的模块(发布到PyPI)?

如何进行模块的私有发布(不发布到PyPI)?

为了弄清这些问题,我找了许多资料。最后发现最好的资料还是 python 的官方文档。

下面是阅读了所有我找到的资料后的一个总结,希望能帮到几个月后又把这些全部忘光的那个自己。

二、python 包管理工具大乱斗

我用时间顺序来描述乱斗过程。

1. distutils

distutils是 python 标准库的一部分,2000年发布。使用它能够进行 python 模块的安装发布

setup.py 就是利用distutils的功能写成,我们可以看一个简单的setup.py的例子。

在这里可以看到关于 setupt.py 格式的所有详细描述:Writing the Setup Script

要安装一个模块到当前的 python 环境中,可以使用这个模块提供的 setup.py 文件:

pythonsetup.pyinstall

下面的代码会发布一个 python 模块,将其打包成 tar.gz 或者 zip 压缩包:

pythonsetup.pysdist

甚至能打包成 rpm 或者 exe 安装包:

pythonsetup.pybdist_rpmpythonsetup.pybdist_wininst

2. setuptools 和 distribute

setuptools是一个为了增强 distutils 而开发的集合,2004年发布。它包含了easy_install这个工具。

ez_setup.py是 setuptools 的安装工具。ez就是easy的缩写。

简单的说,setuptools 是一个项目的名称,是基础组件。而easy_install是这个项目中提供的工具,它依赖基础组件工作。

为了方便描述,下面文章中提到的 setuptools 被认为与easy_install同义。

使用 setuptools 可以自动下载、构建、安装和管理python 模块。

例如,从 PyPI 上安装一个包:

easy_installSQLObject

下载一个包文件,然后安装它:

easy_installhttp://example.com/path/to/MyPackage-1.2.3.tgz

从一个 .egg 格式安装:

easy_install/my_downloads/OtherPackage-3.2.1-py2.3.egg

distribute是 setuptools 的一个分支版本。分支的原因可能是有一部分开发者认为 setuptools 开发太慢了。但现在,distribute 又合并回了 setuptools 中。因此,我们可以认为它们是同一个东西。事实上,如果你查看一下easy_install的版本,会发现它本质上就是 distribute 。

# easy_install --versiondistribute0.6.28

3. Eggs

Eggs格式是 setuptools 引入的一种文件格式,它使用 .egg 扩展名,用于 Python 模块的安装。

setuptools 可以识别这种格式。并解析它,安装它。

想要详细了解,可以看看这篇:The Quick Guide to Python Eggs

Eggs are to Pythons as Jars are to Java..

4. pip

注意,从此处开始,easy_install和setuptools不再同义。

pip是目前 python 包管理的事实标准,2008年发布。它被用作easy_install的替代品,但是它仍有大量的功能建立在 setuptools 组件之上。

pip 希望不再使用Eggs格式(虽然它支持 Eggs),而更希望采用“源码发行版”(使用python setup.py sdist创建)。这可以充分利用Requirements File Format提供的方便功能。

pip 可以利用 requirments.txt 来实现在依赖的安装。在setup.py中,也存在一个install_requires表来指定依赖的安装。它们的区别在哪里?可以看这篇文章:setup.py vs requirements.txt(中文版)

pip 支持git/svn/hg 等流行的 VCS 系统,可以直接从 gz 或者 zip 压缩包安装,支持搜索包,以及指定服务器安装等等功能。

pip vs easy_install详细介绍了两者的不同。它们可以说是各占胜场,但 pip 明显优势更大。

5. wheel

wheel本质上是一个 zip 包格式,它使用 .whl 扩展名,用于 python 模块的安装,它的出现是为了替代 Eggs。

wheel 还提供了一个bdist_wheel作为 setuptools 的扩展命令,这个命令可以用来生成 wheel 包。

pip 提供了一个 wheel 子命令来安装 wheel 包。当然,需要先安装 wheel 模块。

setup.cfg可以用来定义 wheel 打包时候的相关信息。

Wheel vs Egg详细介绍了 wheel 和 Eggs 格式的区别,很显然,wheel 优势明显。

Python Wheels网站展示了使用 Wheels 发行的 python 模块在 PyPI 上的占有率。

pypip.in也支持 wheel。

6. distutils2 和 distlib

distutils2被设计为distutils的替代品。从2009年开发到2012年。它包含更多的功能,并希望以packaging作为名称进入 python 3.3 成为标准库的一部分。但这个计划后来停滞了

distlibdistutils2的部分,它为distutils2/packaging提供的低级功能增加高级 API,使其便于使用。

这里介绍了 distlib 没有进入 python 3.3 标准库的一些原因。

因此,可以暂时不必了解这两个工具,静观其变即可。

三、工具选择

如果仔细看过上面的乱斗内容,我相信你已经清楚当前应该如何选择了。

对于我这样刚刚开始的新手来说,自然是使用 pip 而不使用easy_install了。

如果发布模块,当然是使用 wheel 格式。

四、发布自己的模块

对于 python3 程序员来说,当然应该先看这一篇:Distributing Python Modules

另外,Tutorial on Packaging and Distributing Projects也足够详细和官方。

而 Python2 程序员则应该看这篇Distributing Python Modules

当然,setuptools 的官方文档也是不错的教程:Building and Distributing Packages with Setuptools

这篇教程可以用来入门:Sharing Your Labor of Love: PyPI Quick and Dirty

至于如何发布自己的模块到 PyPI 或者搭建自己的私有包管理服务器,上面的文章已经讲得非常清楚了。

五、引用

上面提到的大部分资料,都是在这里找到,或者是提到:Python Packaging User Guide

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容