python的构建工具setup.py的方法使用示例


Posted in Python onOctober 23, 2017

本文介绍了python的构建工具setup.py,分享个大家,具体如下:

一、构建工具setup.py的应用场景

在安装python的相关模块和库时,我们一般使用“pip install  模块名”或者“python setup.py install”,前者是在线安装,会安装该包的相关依赖包;后者是下载源码包然后在本地安装,不会安装该包的相关依赖包。所以在安装普通的python包时,利用pip工具相当简单。但是在如下场景下,使用python setup.py install会更适合需求:

在编写相关系统时,python 如何实现连同依赖包一起打包发布?

假如我在本机开发一个程序,需要用到python的redis、mysql模块以及自己编写的redis_run.py模块。我怎么实现在服务器上去发布该系统,如何实现依赖模块和自己编写的模块redis_run.py一起打包,实现一键安装呢?同时将自己编写的redis_run.py模块以exe文件格式安装到python的全局执行路径C:\Python27\Scripts下呢?

在这种应用场景下,pip工具似乎派不上了用场,只能使用python的构建工具setup.py了,使用此构建工具可以实现上述应用场景需求,只需在 setup.py 文件中写明依赖的库和版本,然后到目标机器上使用python setup.py install安装。

二、setup.py介绍

from setuptools import setup, find_packages 
 
setup( 
 name = "test", 
 version = "1.0", 
 keywords = ("test", "xxx"), 
 description = "eds sdk", 
 long_description = "eds sdk for python", 
 license = "MIT Licence", 
 
 url = "http://test.com", 
 author = "test", 
 author_email = "test@gmail.com", 
 
 packages = find_packages(), 
 include_package_data = True, 
 platforms = "any", 
 install_requires = [], 
 
 scripts = [], 
 entry_points = { 
  'console_scripts': [ 
   'test = test.help:main' 
  ] 
 } 
)

 setup.py各参数介绍:

--name 包名称

--version (-V) 包版本

--author 程序的作者

--author_email 程序的作者的邮箱地址

--maintainer 维护者

--maintainer_email 维护者的邮箱地址

--url 程序的官网地址

--license 程序的授权信息

--description 程序的简单描述

--long_description 程序的详细描述

--platforms 程序适用的软件平台列表

--classifiers 程序的所属分类列表

--keywords 程序的关键字列表

--packages 需要处理的包目录(包含__init__.py的文件夹)

--py_modules 需要打包的python文件列表

--download_url 程序的下载地址

--cmdclass

--data_files 打包时需要打包的数据文件,如图片,配置文件等

--scripts 安装时需要执行的脚步列表

--package_dir 告诉setuptools哪些目录下的文件被映射到哪个源码包。一个例子:package_dir = {'': 'lib'},表示“root package”中的模块都在lib 目录中。

--requires 定义依赖哪些模块

--provides定义可以为哪些模块提供依赖

--find_packages() 对于简单工程来说,手动增加packages参数很容易,刚刚我们用到了这个函数,它默认在和setup.py同一目录下搜索各个含有 __init__.py的包。

其实我们可以将包统一放在一个src目录中,另外,这个包内可能还有aaa.txt文件和data数据文件夹。另外,也可以排除一些特定的包

find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"])

--install_requires = ["requests"] 需要安装的依赖包

--entry_points 动态发现服务和插件,下面详细讲

下列entry_points中: console_scripts 指明了命令行工具的名称;在“redis_run = RedisRun.redis_run:main”中,等号前面指明了工具包的名称,等号后面的内容指明了程序的入口地址。

entry_points={'console_scripts': [
   'redis_run = RedisRun.redis_run:main',
 ]}

这里可以有多条记录,这样一个项目就可以制作多个命令行工具了,比如:

setup(
 entry_points = {
  'console_scripts': [
   'foo = demo:test',
   'bar = demo:test',
  ]}
)

三、setup.py的项目示例代码

#!/usr/bin/env python
# coding=utf-8

from setuptools import setup

'''
把redis服务打包成C:\Python27\Scripts下的exe文件
'''

setup(
 name="RedisRun", #pypi中的名称,pip或者easy_install安装时使用的名称,或生成egg文件的名称
 version="1.0",
 author="Andreas Schroeder",
 author_email="andreas@drqueue.org",
 description=("This is a service of redis subscripe"),
 license="GPLv3",
 keywords="redis subscripe",
 url="https://ssl.xxx.org/redmine/projects/RedisRun",
 packages=['RedisRun'], # 需要打包的目录列表

 # 需要安装的依赖
 install_requires=[
  'redis>=2.10.5',
  'setuptools>=16.0',
 ],

 # 添加这个选项,在windows下Python目录的scripts下生成exe文件
 # 注意:模块与函数之间是冒号:
 entry_points={'console_scripts': [
  'redis_run = RedisRun.redis_run:main',
 ]},

 # long_description=read('README.md'),
 classifiers=[ # 程序的所属分类列表
  "Development Status :: 3 - Alpha",
  "Topic :: Utilities",
  "License :: OSI Approved :: GNU General Public License (GPL)",
 ],
 # 此项需要,否则卸载时报windows error
 zip_safe=False
)

四、修改后的项目代码(此时RedisRun模块是DrQueue模块的子模块,这是因为要导入某些公用的模块)

#!/usr/bin/env python
# coding=utf-8

from setuptools import setup

'''
把redis服务打包成C:\Python27\Scripts下的exe文件
'''

setup(
 name="RedisRun", #pypi中的名称,pip或者easy_install安装时使用的名称
 version="1.0",
 author="Andreas Schroeder",
 author_email="andreas@drqueue.org",
 description=("This is a service of redis subscripe"),
 license="GPLv3",
 keywords="redis subscripe",
 url="https://ssl.xxx.org/redmine/projects/RedisRun",
 packages=['DrQueue'], # 需要打包的目录列表

 # 需要安装的依赖
 install_requires=[
  'redis>=2.10.5',
 ],

 # 添加这个选项,在windows下Python目录的scripts下生成exe文件
 # 注意:模块与函数之间是冒号:
 entry_points={'console_scripts': [
  'redis_run = DrQueue.RedisRun.redis_run:main',
 ]},

 # long_description=read('README.md'),
 classifiers=[ # 程序的所属分类列表
  "Development Status :: 3 - Alpha",
  "Topic :: Utilities",
  "License :: OSI Approved :: GNU General Public License (GPL)",
 ],
 # 此项需要,否则卸载时报windows error
 zip_safe=False
)

 此时项目的目录结构为:

python的构建工具setup.py的方法使用示例

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python遍历指定文件及文件夹的方法
May 09 Python
python中map()与zip()操作方法
Feb 27 Python
Python cookbook(数据结构与算法)实现查找两个字典相同点的方法
Feb 18 Python
python实现求解列表中元素的排列和组合问题
Mar 15 Python
python线程池threadpool使用篇
Apr 27 Python
使用python中的in ,not in来检查元素是不是在列表中的方法
Jul 06 Python
python使用Matplotlib绘制分段函数
Sep 25 Python
在python中使用with打开多个文件的方法
Jan 07 Python
python实现车牌识别的示例代码
Aug 05 Python
关于pytorch处理类别不平衡的问题
Dec 31 Python
tensorflow 实现从checkpoint中获取graph信息
Feb 10 Python
Django 项目布局方法(值得推荐)
Mar 22 Python
python使用pyqt写带界面工具的示例代码
Oct 23 #Python
基于Django的python验证码(实例讲解)
Oct 23 #Python
itchat接口使用示例
Oct 23 #Python
python实现微信接口(itchat)详细介绍
Oct 23 #Python
python爬虫_微信公众号推送信息爬取的实例
Oct 23 #Python
Python 模拟员工信息数据库操作的实例
Oct 23 #Python
Scrapy爬虫实例讲解_校花网
Oct 23 #Python
You might like
php中强制下载文件的代码(解决了IE下中文文件名乱码问题)
2011/05/09 PHP
Laravel关系模型指定条件查询方法
2019/10/10 PHP
js 刷新页面的代码小结 推荐
2010/04/02 Javascript
关于JS控制代码暂停的实现方法分享
2012/10/11 Javascript
给文字加上着重号的JS代码
2013/11/12 Javascript
jQuery提示效果代码分享
2014/11/20 Javascript
node.js中的events.EventEmitter.listenerCount方法使用说明
2014/12/08 Javascript
js实现顶部可折叠的菜单工具栏效果实例
2015/05/09 Javascript
13个PHP函数超实用
2015/10/21 Javascript
学习JavaScript设计模式(单例模式)
2015/11/26 Javascript
JavaScript数组的栈方法与队列方法详解
2016/05/26 Javascript
js插件dropload上拉下滑加载数据实例解析
2016/07/27 Javascript
微信小程序 缓存(本地缓存、异步缓存、同步缓存)详解
2017/01/17 Javascript
详解Javascript中DOM的范围
2017/02/13 Javascript
原生JS实现的碰撞检测功能示例
2018/05/18 Javascript
详解Vue.js自定义tipOnce指令用法实例
2018/12/19 Javascript
layui 上传插件 带预览 非自动上传功能的实例(非常实用)
2019/09/23 Javascript
vue中的过滤器及其时间格式化问题
2020/04/09 Javascript
vue+element实现图片上传及裁剪功能
2020/06/29 Javascript
关于JavaScript数组去重的一些理解汇总
2020/09/10 Javascript
全面解析js中的原型,原型对象,原型链
2021/01/25 Javascript
win7安装python生成随机数代码分享
2013/12/27 Python
对Python中range()函数和list的比较
2018/04/19 Python
使用pip安装python库的多种方式
2019/07/31 Python
python实现字典嵌套列表取值
2019/12/16 Python
Python魔法方法 容器部方法详解
2020/01/02 Python
如何在keras中添加自己的优化器(如adam等)
2020/06/19 Python
python空元组在all中返回结果详解
2020/12/15 Python
使用python tkinter开发一个爬取B站直播弹幕工具的实现代码
2021/02/07 Python
在线购买廉价折扣书籍和小说:BookOutlet.com
2018/02/19 全球购物
北美女性服装零售连锁店:maurices
2019/06/12 全球购物
2013年学期结束动员演讲稿
2014/01/07 职场文书
金融管理专业求职信
2014/07/10 职场文书
公务员考察材料范文
2014/12/23 职场文书
民事撤诉申请书范本
2015/05/18 职场文书
村主任当选感言
2015/08/01 职场文书