目录

技术背景python项目示例用__init__.py文件构造的简单项目构造setup文件依赖包配置文件执行安装软件包功能测试安装包的删除总结概要版权声明技术背景

在上一篇博客中，我们介绍了如何使用pyinstaller将python项目打包成一个可执行文件，并且放在系统目录下，让系统用户可以直接识别到我们构造的项目。而python项目中常见的setup.py其实也是在执行类似的构建的功能，通过setup.py文件可以将python包按照指定的方案进行构建，构建出来的可执行文件是一个egg文件。最后将这个egg文件转移到python包的统一管理路径下，这样我们就可以在系统内任一位置的python文件中调用我们构建好的这个python库。

python项目示例

首先我们构造一个大概的目录结构，项目的路径如下所示：

[dechin@dechin-manjaro test_setup]$ tree.├── requirements.txt├── setup.py└── ts    └── __init__.py1 directory, 3 files

在一个名为test_setup的路径下，作为我们最上层的项目根目录。然后在根目录下有需求配置文件requirements.txt，我们可以在这个文件中添加我们的python库所依赖的其他python库，如numpy、scipy等。而setup.py就是我们这里的安装文件，在后面的章节中会着重提到。最后是我们的项目的核心路径ts，里面包含了我们的核心代码。

用__init__.py文件构造的简单项目

在一个普通的python项目中，我们可以用目录.模块名.函数名的形式来构造python项目的引用方法。但是对于一些比较简单的库而言，比如定义一个二叉树的数据结构这种简单的项目，我们可以直接在__init__.py文件里面直接定义好所有的项目函数及内容。当然，对于一些比较大型的比较规范的项目而言，也会用__init__.py文件作为一个统一的函数入口，以提升模块化项目的可用性。在本测试用例中，我们也定义了一个简单的py核心代码文件如下：

[dechin@dechin-manjaro test_setup]$ cat ts/__init__.py # __init__.pydef p2(number):    return number ** 2def p3(number):    return number ** 3

这个名为ts的项目具有两个函数功能：p2用于计算输入参数的平方，以及p3用于计算输入参数的立方。

构造setup文件

我们主要是基于setuptools来实现一个python项目的构建，以下直接展示本项目的构建方法：

# setup.pyimport osfrom setuptools import setup, find_packages__version__ = '1.0' # 版本号requirements = open('requirements.txt').readlines() # 依赖文件setup(    name = 'ts', # 在pip中显示的项目名称    version = __version__,    author = 'Dechin',    author_email = 'dechin.phy@gmail.com',    url = '',    description = 'ts: Test Setup',    packages = find_packages(exclude=["tests"]), # 项目中需要拷贝到指定路径的文件夹    python_requires = '>=3.5.0',    install_requires = requirements # 安装依赖        )

在这个构建方法中，我们配置了项目的版本号（版本管理）、依赖库、项目名称以及需要进行构建的文件夹。比如这里我们加了一个exclude的选项排除了tests目录（虽然本项目中并没有这个目录，但是一般我们都要剔除测试目录）。当然我们也可以用指定目录进行构建的方法，但是这里不做过多的赘述。

依赖包配置文件

python之所以这么火，很大程度上就得益于其强大的生态，而这些生态都是靠别人搭建好的轮子来支撑起来的。因此大部分的python项目都会依赖于第三方的python包，在安装的时候我们可以仅用一个文件就进行配置：

[dechin@dechin-manjaro test_setup]$ cat requirements.txt numpy==1.20.1

在requirements.txt的配置文件中，我们最好是能够指定一个固定的版本号，这样可以确保软件的兼容性。

执行安装

按照上述的方法对我们的python项目进行编写后，就可以开始执行构建，如果需要测试编译可以先运行python3 setup.py build来进行测试，在安装成功后再执行install指令，当然我们也可以直接一步执行python3 setup.py install指令来进行安装：

[dechin@dechin-manjaro test_setup]$ python3 setup.py installrunning installrunning bdist_eggrunning egg_infowriting ts.egg-info/PKG-INFOwriting dependency_links to ts.egg-info/dependency_links.txtwriting requirements to ts.egg-info/requires.txtwriting top-level names to ts.egg-info/top_level.txtreading manifest file 'ts.egg-info/SOURCES.txt'writing manifest file 'ts.egg-info/SOURCES.txt'installing library code to build/bdist.linux-x86_64/eggrunning install_librunning build_pycreating build/libcreating build/lib/tscopying ts/__init__.py -> build/lib/tscreating build/bdist.linux-x86_64/eggcreating build/bdist.linux-x86_64/egg/tscopying build/lib/ts/__init__.py -> build/bdist.linux-x86_64/egg/tsbyte-compiling build/bdist.linux-x86_64/egg/ts/__init__.py to __init__.cpython-38.pyccreating build/bdist.linux-x86_64/egg/EGG-INFOcopying ts.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFOcopying ts.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFOcopying ts.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFOcopying ts.egg-info/requires.txt -> build/bdist.linux-x86_64/egg/EGG-INFOcopying ts.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFOzip_safe flag not set; analyzing archive contents...creating 'dist/ts-1.0-py3.8.egg' and adding 'build/bdist.linux-x86_64/egg' to itremoving 'build/bdist.linux-x86_64/egg' (and everything under it)Processing ts-1.0-py3.8.eggCopying ts-1.0-py3.8.egg to /home/dechin/anaconda3/lib/python3.8/site-packagesAdding ts 1.0 to easy-install.pth fileInstalled /home/dechin/anaconda3/lib/python3.8/site-packages/ts-1.0-py3.8.eggProcessing dependencies for ts==1.0Searching for numpy==1.20.1Best match: numpy 1.20.1Adding numpy 1.20.1 to easy-install.pth fileInstalling f2py script to /home/dechin/anaconda3/binInstalling f2py3 script to /home/dechin/anaconda3/binInstalling f2py3.8 script to /home/dechin/anaconda3/binUsing /home/dechin/anaconda3/lib/python3.8/site-packagesFinished processing dependencies for ts==1.0

安装完成后，我们可以在pip的管理包目录下找到我们所构建的python包：

[dechin@dechin-manjaro test_setup]$ python3 -m pip listPackage                            Version---------------------------------- -------------------ts                                 1.0

同时在执行完build指令之后，本地目录下会生成一系列的编译构建目录，如build和dist等：

[dechin@dechin-manjaro test_setup]$ tree.├── build│   └── bdist.linux-x86_64├── dist│   └── ts-1.0-py3.8.egg├── requirements.txt├── setup.py├── ts│   ├── __init__.py│   └── __pycache__│       └── __init__.cpython-38.pyc└── ts.egg-info    ├── dependency_links.txt    ├── PKG-INFO    ├── requires.txt    ├── SOURCES.txt    └── top_level.txt6 directories, 10 files

而dist目录下的egg文件在执行完install指令之后，会被拷贝到系统指定的python包管理路径下，我们可以在系统中搜索到这个文件：

[dechin-root test_setup]# find / -name *ts-1.0-py3.8.egg/home/dechin/anaconda3/lib/python3.8/site-packages/ts-1.0-py3.8.egg/home/dechin/projects/2021-python/setup/test_setup/dist/ts-1.0-py3.8.egg

这里我们可以看到第一个路径就是python包管理路径。

软件包功能测试

在安装完成后，我们可以在任意的路径下引用到我们构建好的ts项目，比如这里我们可以用ipython来测试一下：

[dechin@dechin-manjaro test_setup]$ ipythonPython 3.8.5 (default, Sep  4 2020, 07:30:14) Type 'copyright', 'credits' or 'license' for more informationIPython 7.19.0 -- An enhanced Interactive Python. Type '?' for help.In [1]: from ts import p2, p3In [2]: p2(4)Out[2]: 16In [3]: p3(4)Out[3]: 64

测试结果表明，我们成功地从编译构建好的ts项目中引用了平方和立方的计算函数。

安装包的删除

跟其他的python包一样，我们可以用pip来统一管理，也可以用pip来直接删除我们自己安装的ts项目：

[dechin@dechin-manjaro test_setup]$ python3 -m pip uninstall tsFound existing installation: ts 1.0Uninstalling ts-1.0:  Would remove:    /home/dechin/anaconda3/lib/python3.8/site-packages/ts-1.0-py3.8.eggProceed (y/n)? y  Successfully uninstalled ts-1.0

一个完善的python项目，不仅需要梳理好核心代码的软件架构，还需要定义好依赖文件、编译构建文件、API接口文档、编码规范门禁等。这里我们介绍了如何用setup.py文件来完善一个最简单的python项目，这也是每一个python开源项目所必须要具备的条件。

版权声明

本文首发链接为：

作者ID：DechinPhy

更多原著文章请参考：