Python 分发工具初探之 setuptools

admin

2023-07-31 00:40:02

0次

这篇文章主要介绍了一下 setuptools 是什么，以及它的功能和特点，并且介绍了如何使用它来创建和安装使用自己的包，这篇文章仅仅讲了最基本的功能和用法，一些对于进阶的用法会在下篇文章中进行介绍。

0x00 setuptools 是什么

setuptools 与 disutils

我们通常所知道的 Python 分发工具是 Python distutils， setuptools 可以说是它的增强版，它能帮助我们更好的创建和分发 Python 的包，尤其是具有复杂依赖关系的包。对于开发者来说，能够更好的组织自己项目的分发和发布；对于用户来说，不需要安装 setuptools 也可以使用由它创建的包，只需要一个启动模块即可。

实现这样的的包管理机制主要由两部分构成：

一个存储在 Python 官方网站的集中式仓库，名叫 Python Package Index（PyPI）
另外就是基于 distutils 开发的 setuptools 包管理系统

它提供的内容包括：

用来提供标准元数据字段：诸如作者名、版权类型等信息的骨架
一组用来将包中的代码来构建软件安装包的辅助工具

distutils 仅仅适用于包，它无法定义包之间的依赖关系。但是 setuptools 通过添加一个基本的依赖系统以及许多相关功能，弥补了该缺陷。他还提供了自动包查询程序，用来自动获取包之间的依赖关系，并完成这些包的安装，大大降低了安装各种包的难度，使之更加方便。

0x01 安装 setuptools

Ubuntu：

1	sudo apt–get install python–setuptools

Mac：

安装 wget：

12345

curl –O http://ftp.gnu.org/gnu/wget/wget-1.13.4.tar.gztar –xzvf wget–1.13.4.tar.gzcd wget–1.13.4./configuremakesudo make install

安装 setuputils：

12	wget http://peak.telecommunity.com/dist/ez_setup.pysudopython ez_setup.py

0x02 创建一个简单的包

创建一个空的包

新建一个 demo 目录

12	mkdir demo1cd demo1

在目录下新建 setup.py 文件

1234567

from setuptools import setup, find_packages setup(name = \’demo1\’,version = \’0.1\’,packages = find_packages(),)

将该项目打包

1	python setup.py bdist_egg

这时我们查看该项目目录：

1234567891011

我们看到在 dist 目录中的就是生成的 egg 包，将其解压：

123456789101112

unzip –l demo1–0.1–py2.7.egg Archive: demo1–0.1–py2.7.eggLength Date Time Name———— —— —— ——1 03–22–16 23:29 EGG–INFO/dependency_links.txt177 03–22–16 23:29 EGG–INFO/PKG–INFO124 03–22–16 23:29 EGG–INFO/SOURCES.txt1 03–22–16 23:29 EGG–INFO/top_level.txt1 03–22–16 23:29 EGG–INFO/zip–safe———— ———–304 5 files

以上的程序是最简单的一个 setup.py 程序，如果想要发布到 PyPI 就需要参考官方给出的示例：

12345678910111213141516171819202122232425262728

from setuptools import setup, find_packagessetup(name = \”HelloWorld\”,version = \”0.1\”,packages = find_packages(),scripts = [\’say_hello.py\’], # Project uses reStructuredText, so ensure that the docutils get# installed or upgraded on the target machineinstall_requires = [\’docutils>=0.3\’], package_data = {# If any package contains *.txt or *.rst files, include them:\’\’: [\’*.txt\’, \’*.rst\’],# And include any *.msg files found in the \’hello\’ package, too:\’hello\’: [\’*.msg\’],}, # metadata for upload to PyPIauthor = \”Me\”,author_email = \”me@example.com\”,description = \”This is an Example Package\”,license = \”PSF\”,keywords = \”hello world example examples\”,url = \”http://example.com/HelloWorld/\”, # project home page, if any # could also include long_description, download_url, classifiers, etc.)

给包中添加内容

我们上边生成的 egg 是一个空的，没有实际的内容，现在我们来添加一些内容：

12	mkdir testcd test

新建 __init__.py,加入如下代码：

1234567

#-*- coding:utf-8 -*- def test():print \”hello world!\” if __name__ == \’__main__\’:test()

再次生成 egg 包：

1	python setup.py bdist_egg

查看 egg 包内容：

12345678910111213

unzip –l demo1–0.1–py2.7.eggArchive: demo1–0.1–py2.7.eggLength Date Time Name———— ——

上一篇：flask 上下文的实现

下一篇：基于Scikit-Learn的五个文本分类案例研究