浅析python打包工具distutils、setuptools


Posted in Python onApril 20, 2018

python中安装包的方式有很多种:

  1. 源码包:python setup.py install
  2. 在线安装:pip install 包名(linux) / easy_install 包名(window)

python包在开发中十分常见,一般的使用套路是所有的功能做一个python模块包,打包模块,然后发布,安装使用。打包和安装包就是最常见的工作。学习中遇到distutils和setuptools两种打包的工具,学习之后做笔记记录。

distutils

distutils 是 python 标准库的一部分,这个库的目的是为开发者提供一种方便的打包方式, 同时为使用者提供方便的安装方式。当我们开发了自己的模块之后,使用distutils的setup.py打包。

一、完成功能python

浅析python打包工具distutils、setuptools

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'],
)

三、执行打包命令

浅析python打包工具distutils、setuptools

再次查看当前目录下自动生成了一个文件夹dist,文件夹中有一个压缩包即为我们的目标文件。另外有一个记录文件MANIFEST。

浅析python打包工具distutils、setuptools

四、安装模块

hello_module-1.0.tar.gz 是生成的python模块。切换到的我的python虚拟环境中,安装该模块。

浅析python打包工具distutils、setuptools

浅析python打包工具distutils、setuptools

使用python setup.py install 安装该模块。从路径可以看出,该模块安装到标准库的制定路径下。

浅析python打包工具distutils、setuptools

五、使用模块

 安装好模块之后,在python的交互环境中导入模块。模块就是hello.py文件,引用hello.py文件中的hello_fun()函数。

浅析python打包工具distutils、setuptools

setuptools

setuptools是distutils的增强版。setuptools有一个entry_points功能很方便,类似linux启动某个服务,如在linux命令行里firefox能启动火狐浏览器。

首先检验没有安装之前,命令path没有作用。

浅析python打包工具distutils、setuptools

 一、创建功能包

创建一个文件夹demo,在文件夹里创建get_path.py和__init__.py两个文件。get_path.py是功能函数,__init__.py是包的标识文件。

浅析python打包工具distutils、setuptools

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的自动下载。

三、打包

浅析python打包工具distutils、setuptools 

打包之后多出两个文件夹,分别是demo.egg-info和dist。demo.egg-info是必要的安装信息,而dist中的压缩包就是安装包。

浅析python打包工具distutils、setuptools

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

浅析python打包工具distutils、setuptools

四、安装包

浅析python打包工具distutils、setuptools

五、使用包

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

浅析python打包工具distutils、setuptools

同时也可以导入使用。

浅析python打包工具distutils、setuptools

 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 ,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!

Python 相关文章推荐
django1.8使用表单上传文件的实现方法
Nov 04 Python
深入解答关于Python的11道基本面试题
Apr 01 Python
Python对象类型及其运算方法(详解)
Jul 05 Python
python+tkinter编写电脑桌面放大镜程序实例代码
Jan 16 Python
Django model反向关联名称的方法
Dec 15 Python
Pandas中resample方法详解
Jul 02 Python
python按比例随机切分数据的实现
Jul 11 Python
python随机模块random使用方法详解
Feb 14 Python
利用scikitlearn画ROC曲线实例
Jul 02 Python
Python 如何对文件目录操作
Jul 10 Python
简单了解python关键字global nonlocal区别
Sep 21 Python
Python借助with语句实现代码段只执行有限次
Mar 23 Python
PyQt5每天必学之切换按钮
Aug 20 #Python
PyQt5每天必学之滑块控件QSlider
Apr 20 #Python
PyQt4实现下拉菜单可供选择并打印出来
Apr 20 #Python
PyQt5每天必学之组合框
Apr 20 #Python
python 时间信息“2018-02-04 18:23:35“ 解析成字典形式的结果代码详解
Apr 19 #Python
Pyqt实现无边框窗口拖动以及窗口大小改变
Apr 19 #Python
Python利用pandas计算多个CSV文件数据值的实例
Apr 19 #Python
You might like
PHP统计目录下的文件总数及代码行数(去除注释及空行)
2011/01/17 PHP
PHP正则替换函数preg_replace和preg_replace_callback使用总结
2014/09/22 PHP
PHP数组和explode函数示例总结
2015/05/08 PHP
Laravel 5.1 on SAE环境开发教程【附项目demo源码】
2016/10/09 PHP
PHP实现的曲线统计图表示例
2016/11/10 PHP
PHP使用Redis长连接的方法详解
2018/02/12 PHP
JAVASCRIPT HashTable
2007/01/22 Javascript
JS+CSS实现感应鼠标渐变显示DIV层的方法
2015/02/20 Javascript
原创jQuery弹出层插件分享
2015/04/02 Javascript
JS实现点击按钮控制Div变宽、增高及调整背景色的方法
2015/08/05 Javascript
微信小程序 地图定位简单实例
2016/10/14 Javascript
jQuery实现表格元素动态创建功能
2017/01/09 Javascript
JS实现简易刻度时钟示例代码
2017/03/11 Javascript
javascrit中undefined和null的区别详解
2019/04/07 Javascript
JS localStorage存储对象,sessionStorage存储数组对象操作示例
2020/02/15 Javascript
通过vue.extend实现消息提示弹框的方法记录
2021/01/07 Vue.js
手动实现把python项目发布为exe可执行程序过程分享
2014/10/23 Python
Python实现大文件排序的方法
2015/07/10 Python
Python对list列表结构中的值进行去重的方法总结
2016/05/07 Python
浅谈Python peewee 使用经验
2017/10/20 Python
微信小程序跳一跳游戏 python脚本跳一跳刷高分技巧
2018/01/04 Python
Django 内置权限扩展案例详解
2019/03/04 Python
基于django channel实现websocket的聊天室的方法示例
2019/04/11 Python
python批量修改ssh密码的实现
2019/08/08 Python
Python shutil模块用法实例分析
2019/10/02 Python
Windows下Sqlmap环境安装教程详解
2020/08/04 Python
Python系统公网私网流量监控实现流程
2020/11/23 Python
python drf各类组件的用法和作用
2021/01/12 Python
html5使用html2canvas实现浏览器截图的示例
2017/08/31 HTML / CSS
马智宇结婚主持词
2014/04/01 职场文书
奥巴马竞选演讲稿
2014/05/15 职场文书
教师优秀党员事迹材料
2014/08/14 职场文书
财政局党的群众路线教育实践活动整改方案
2014/09/21 职场文书
司法局2014法制宣传日活动总结
2014/11/01 职场文书
酒店人事主管岗位职责
2015/04/11 职场文书
MySQL数据库实验实现简单数据库应用系统设计
2022/06/21 MySQL