使用Distutils分发自己编写的Python包

翻译自官方文档

本文档从模块开发人员的角度描述了Python Distribution Utilities(“Distutils”),介绍了如何使用Distutils将Python模块和扩展程序提供给更加广泛的使用者,并使得构建/释放/安装机制的开销很少。

概念&术语

对于模块开发人员和安装第三方模块的用户/管理员来说,使用Distutils是非常简单的。作为一名开发人员,您的责任(当然除了编写可靠的,有详细记录和经过良好测试的代码)是:

  • 写一个安装脚本(按照惯例为setup.py)
  • (可选)写入设置配置文件
  • 建立一个源码分发包
  • (可选)创建一个或多个内置(二进制)分发包

这些都会在本文档中一一提到。

并不是所有的模块开发人员都可以访问多种平台,因此总想着他们可以创建大量的内置分发包是不可行的。希望出现一类称为“packagers”的中介机构,以满足这一需求。packagers将采用模块开发人员发布的源代码,将其构建在一个或多个平台上,并发布生成的内置分发包。因此,最流行的平台上的用户将能够以最自然的方式为他们的平台安装大多数流行的Python模块分发包,而无需运行单个安装脚本或编译一行代码。

一个简单实例

安装脚本通常非常简单,尽管由Python编写,但是对于可以使用的脚本没有任何限制,可还是要在安装脚本中应该谨慎处理那些重要的操作。 与Autoconf风格的配置脚本不同的是,在构建和安装模块分发包的过程中,安装脚本可能会多次运行。

如果你想做的只是分发一个包含在foo.py文件中的foo模块,那么你的安装脚本就可以这么简单:

from distutils.core import setup
setup(name='foo',
      version='1.0',
      py_modules=['foo'],
      )

一些需要注意的地方:

  • 您提供给Distutils的大多数信息都作为关键字参数提供给setup()函数

  • 这些关键字参数分为两类:包元数据(名称,版本号)以及有关软件包内容的信息(在这种情况下是纯Python模块的列表)

  • 模块由模块名称指定,而不是文件名(对于包和扩展名也是如此)

  • 建议您提供更多元数据,特别是您的名称,电子邮件地址和项目的URL(请参阅编写安装脚本一节)

如果要将源码进行分发,你需要在setup.py写入上述代码,并从命令行处运行:

python setup.py sdist

对于Windows用户来说,你需要执行:

setup.py sdist

sdist将创建一个存档文件(例如,Unix上的tarball文件,Windows上的ZIP文件),其中包含您的安装脚本setup.py和您的模块foo.py。 归档文件将被命名为foo-1.0.tar.gz(或.zip),并将打包到目录foo-1.0中。

如果最终用户希望安装您的foo模块,那么她所要做的就是下载foo-1.0.tar.gz(或.zip),解压缩,并从foo-1.0目录运行:

python setup.py install

这将最终将foo.py复制到Python安装中的第三方模块的相应目录。

这个简单的例子演示了Distutils的一些基本概念。 首先,开发人员和安装人员都有相同的基本用户界面,即安装脚本。 区别在于Distutils使用的命令:sdist命令几乎专门用于模块开发人员,而安装程序更常用于安装程序(尽管大多数开发人员都希望偶尔安装自己的代码)。

如果你想为用户做一些简单的事情,你可以为他们创建一个或多个内置(二进制)的分发包。 例如,如果您正在Windows机器上运行,并希望为其他Windows用户提供方便,则可以使用bdist_wininst命令创建一个可执行安装程序(这个平台最合适的构建版本的类型)。 例如:

python setup.py bdist_wininst

这将在当前目录中创建可执行安装程序foo-1.0.win32.exe

其他有用的内置分发格式是RPM。 例如,以下命令将创建一个名为foo-1.0.noarch.rpm的RPM文件:

python setup.py bdist_rpm

注:bdist_rpm命令使用rpm可执行文件,因此必须在基于RPM的系统上运行,如Red Hat Linux,SuSE Linux或Mandrake Linux。

python setup.py bdist --help-formats

你可以通过这条指令来查看运行了什么样的分发格式。

常用的Python术语

模块(module):Python中代码可重用性的基本单位:由一些其他代码导入的代码块。 这里涉及到三种类型的模块:纯Python模块(Python modules),扩展模块(extension modules)和包(packages)。

纯Python模块(Python modules):一个用Python编写并包含在一个.py文件中的模块(也可能是关联的.pyc和/或.pyo文件)。 有时被称为“纯模块”。

扩展模块(extension modules):一个用Python实现的低级语言编写的模块:C / C ++ for Python,Java for Jython。 通常包含在单个可动态加载的预编译文件中。 Unix上的Python扩展的共享对象(.so)文件,Windows上的Python扩展的DLL(给定.pyd扩展名)或Jython扩展的Java类文件。 (请注意,目前,Distutils仅处理Python的C / C ++扩展。)

包(packages):包含其他模块的模块; 通常包含在文件系统中的目录中,并通过存在文件__init__.py与其他目录区分开来。

根包(root packages)
包的层次结构的根。 (这不是一个包,因为它没有一个__init__.py文件,但我们必须称之为一些)。绝大多数的标准库是根包,许多小的,独立的第三个 不属于较大模块集合的一个模块。 与常规包不同,根包中的模块可以在许多目录中找到:实际上,sys.path中列出的每个目录都向根包提供模块。

Distutils特定术语

以下术语更具体地适用于使用Distutils分发Python模块的方面:

模块分发包:作为一个可下载的资源一起分发的Python模块的集合,并且要大量安装。一些众所周知的模块分布的例子有数字Python,PyXML,PIL(Python影像库)或mxBase。 (这将被称为包,除了该术语已经在Python上下文中:单个模块分发可能包含零个,一个或多个Python包。)

纯模块分发包:一个仅包含纯Python模块和包的模块分发。有时被称为“纯分配”。

非纯模块分发包:一个包含至少一个扩展模块的模块分发。有时被称为“非纯分配”。

根分发包:源树(或源分发)的顶层目录; setup.py存在的目录。一般来说,setup.py将从此目录运行。

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

推荐阅读更多精彩内容

  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,421评论 6 428
  • GitHub 上有一个 Awesome - XXX 系列的资源整理,资源非常丰富,涉及面非常广。awesome-p...
    若与阅读 18,591评论 4 418
  • 环境管理管理Python版本和环境的工具。p–非常简单的交互式python版本管理工具。pyenv–简单的Pyth...
    MrHamster阅读 3,775评论 1 61
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 这周完成的 在这周通过对招生活动和iOS教师端进行集中地测试迭代,梳理并修复了测试过程中发现的问题和bug...
    heartshapebox阅读 337评论 0 0