淺析python打包工具distutils、setuptools

python套件在開發中十分常見，一般的使用套路是所有的功能做一個python模組包，打包模組，然後發布，安裝使用。這篇文章為大家介紹了python打包工具distutils、setuptools的相關知識，有興趣的朋友一起看看吧

python中安裝包的方式有很多種：

1. #原始碼套件：python setup.py install

2. 線上安裝：pip install 套件名稱（linux） / easy_install 套件名稱(window)

##python套件在開發中十分常見，一般的使用套路是所有的功能做一個python模組包，打包模組，然後發布，安裝使用。打包和安裝包是最常見的工作。學習中遇到distutils和setuptools兩種打包的工具，學習之後做筆記記錄。 distutils

distutils 是python 標準函式庫的一部分，這個函式庫的目的是為開發者提供一個方便的打包方式， 同時為使用者提供方便的安裝方式。當我們開發了自己的模組之後，使用distutils的setup.py打包。 一、完成功能python

#hello.py

def hello_fun():
 print "i say hello to you"

二、建立setup.py檔案

setup.py

from distutils.core import setup
setup(
 name="hello_module",
 version="1.0",
 author="ljk",
 author_email="wilber@sh.com",
 py_modules=['hello'],
)

三、執行打包指令

<img src="https://img.php.cn/upload/article/000/153/291/c9ec895b33001f9a73ccf3328f67de41-1.png" alt=""/>

再次查看目前目錄下自動產生了一個資料夾dist，資料夾中有一個壓縮包就是為我們的目標檔案。另外有一個記錄檔MANIFEST。

四、安裝模組

#hello_module-1.0.tar.gz 是產生的python模組。切換到的我的python虛擬環境中，安裝模組。

使用

python setup.py install

安裝該模組。從路徑可以看出，該模組安裝到標準庫的製定路徑下。

五、使用模組

# 安裝好模組之後，在python的互動環境中匯入模組。模組就是hello.py文件，引用hello.py檔案中的hello_fun()函數。

setuptools

#setuptools是distutils的增強版。 setuptools有一個entry_points功能很方便，類似linux啟動某個服務，如在linux指令列裡firefox能啟動火狐瀏覽器。

在先檢驗沒有安裝之前，指令path沒有作用。

 一、建立功能包

建立一個資料夾demo，在資料夾裡建立get_path .py和__init__.py兩個檔案。 get_path.py是功能函數，__init__.py是套件的識別檔。

get_path.py

#

import os
def fun():
 print "i am in the path:"
 print os.getcwd()

二、配置setup.py文件

建立setup.py文件，填寫必要的打包資訊。

 setup.py

#-*- encoding: UTF-8 -*-
from setuptools import setup
setup(
 name = "demo",    # 包名
 version = "0.1",    # 版本信息
 packages = ['demo'],   # 要打包的项目文件夹
 include_package_data=True, # 自动打包文件夹内所有数据
 zip_safe=True,    # 设定项目包为安全，不用每次都检测其安全性
 install_requires = [   # 安装依赖的其他包（测试数据）
 'docutils>=0.3',
 'requests',
 ],
 # 设置程序的入口为path
 # 安装后，命令行执行path相当于调用get_path.py中的fun方法
 entry_points={
  'console_scripts':[
   'path = demo.get_path:fun'
          ]
 },
)
<br data-filtered="filtered"><br data-filtered="filtered">

#在設定中將此模組所需的依賴一切都寫好，安裝時指定地址去下載。這種方式簡化了使用時的安裝過程，但還不夠好。最好的方式是pip的自動下載。 三、打包

# 

###打包之後多出兩個資料夾，分別是demo.egg-info和dist。 demo.egg-info是必要的安裝訊息，而dist中的壓縮包就是安裝包。 ###

查看dist/demo-0.1.tar.gz解压之后的文件。

四、安装包

五、使用包

安装之后在命令行中直接输入path，回车能够看到调用了get_path.py中的函数fun()，输出字符串。

同时也可以导入使用。

setuptools的进阶使用

上面使用setuptools时只是简单的用一个配置文件setup.py就完成了打包信息填写。在真实的开发环境中，往往是多个文件配合。以openstack的打包为例。openstack中引入了Pbr的管理工具。

pbr是setuptools的辅助工具，最初为openstack开发，基于d2to1。Pbr会读取和过滤setup.cfg中的内容，然后将解析后的数据提供给setup.py作为参数。

setup.cfg提供setup.py的默认参数，同时易于修改。Setup.py先解析setup.cfg文件，然后执行相关命令。包括以下功能：

1、从git中获取Version，AUTHORS和ChangeLog信息

2、SphinxAutodoc。pbr会扫描project，找到所有模块，生成stubfiles

3、Requirements。读取requirements.txt文件，生成setup函数需要依赖包

4、long_description。从README.rst、README.txt或者READMEfile中生成long_description参数

Pbr的文件很简单，如下。配置之后会自动寻找目录下的setup.cfg文件，解析文件参数给setup.py使用。

setup.py

from setuptools import setup
setuptools.setup(
setup_requires=['pbr'],
pbr=True)
setup.cfg

[metadata]
name= keystone
version= 2015.2
summary= OpenStack Identity
description-file=
README.rst
author= OpenStack
author-email= openstack-dev@lists.openstack.org
home-page= http://www.openstack.org/
classifier=
Environment:: OpenStack
IntendedAudience :: Information Technology
IntendedAudience :: System Administrators
License:: OSI Approved :: Apache Software License
OperatingSystem :: POSIX :: Linux
ProgrammingLanguage :: Python
ProgrammingLanguage :: Python :: 2
ProgrammingLanguage :: Python :: 2.7
[files]
packages=
keystone
[global]
setup-hooks=
pbr.hooks.setup_hook
[egg_info]
tag_build=
tag_date= 0
tag_svn_revision= 0
[build_sphinx]
all_files= 1
build-dir= doc/build
source-dir= doc/source
[compile_catalog]
directory= keystone/locale
domain= keystone

以上是淺析python打包工具distutils、setuptools的詳細內容。更多資訊請關注PHP中文網其他相關文章！