Python打包模块wheel的使用方法与将python包发布到PyPI的方法详解


Posted in Python onFebruary 12, 2020

wheel文件

Wheel和Egg都是python的打包格式,目的是支持不需要编译或制作的安装过程,实际上也是一种压缩文件,将.whl的后缀改为.zip即可可看到压缩包里面的内容。按照官网说法,wheels是发行版Python的新标准并且要取代.egg。

Egg格式是由setuptools在2004年引入,而Wheel格式是由PEP427在2012年定义。 Wheel现在被认为是Python的二进制包的标准格式。

以下是Wheel和Egg的主要的不同点:

Wheel有一个官方的PEP427来定义,而Egg没有PEP定义。

Wheel是一种分发格式,即打包格式。而Egg既是一种分发格式,也是一种 运行时安装的格式,并且是可以被import的。

Wheel文件不会包含.pyc文件

Wheel使用和PEP376兼容的.dist-info目录,而Egg使用.egg-info目录。

Wheel有着更丰富的命名规则。

Wheel是有版本的,每个Wheel文件都包含wheel规格的版本和打包它的实现。

Wheel在内部被sysconfig path type管理,因此转向其他格式也更容易。

distutils和setuptools工具

用来Python环境中构建和安装额外的模块,模块可以基于Python,也可以C/C++写的扩展模块,可以是python包,包中包含了C和Python编写的模块。

setuptools是 Python Enterprise Application Kit(PEAK)的一个副项目,它是一组Python的 distutilsde工具的增强版(适用于 Python 2.3.5 以上的版本,64 位平台则适用于 Python 2.4 以上的版本),可以让程序员更方便的创建和发布 Python 包,特别是那些对其它包具有依赖性的状况。

setuptools重点在于setup.py文件编写:

setup.py参数介绍:

name : 打包起来的包的文件名

version : 版本号,添加为打包文件的后缀名

author : 作者

author_email : 作者的邮箱

py_modules : 打包的.py文件

packages: 打包的python文件夹

include_package_data : 项目里会有一些非py文件,比如html和js等,这时候就要靠include_package_data 和 package_data 来指定了。package_data:一般写成{‘your_package_name': [“files”]}, include_package_data还没完,还需要修改MANIFEST.in文件.MANIFEST.in文件的语法为: include xxx/xxx/xxx/.ini/(所有以.ini结尾的文件,也可以直接指定文件名)

license : 支持的开源协议

description : 对项目简短的一个形容

ext_modules : 是一个包含Extension实例的列表,Extension的定义也有一些参数。

ext_package : 定义extension的相对路径

requires : 定义依赖哪些模块

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

data_files :指定其他的一些文件(如配置文件),规定了哪些文件被安装到哪些目录中。如果目录名是相对路径,则是相对于sys.prefix或sys.exec_prefix的路径。如果没有提供模板,会被添加到MANIFEST文件中。

将python文件(.py)封装成可安装使用的模块

参考:https://docs.python.org/3.6/distutils/introduction.html#distutils-simple-example

printtest.py

def test():

  print('print test')

将以上.py文件做成python模块,需要在相同目录下创建setup.py文件,setup.py中输入配置信息:

from setuptools import setup

setup(name='printtest',

   version='1.0',

   py_modules=['printtest'],

   )

打开终端,定位到该文件夹下,输入:

python setup.py sdist

此时在目录中生成dist文件夹,文件夹中有testpg-1.0.tar.gz文件,用户安装的话只需要testpg-1.0.tar.gz文件即可。

将此文件解压得到testpg-1.0文件夹,会发现该文件夹有我们刚刚书写的3个py文件,还有一个PKG-INFO,打开该文件,会显示该模块的具体信息:由于我们没有设置,所以为UNKOWN

Metadata-Version: 1.0

Name: printtest

Version: 1.0

Summary: UNKNOWN

Home-page: UNKNOWN

Author: UNKNOWN

Author-email: UNKNOWN

License: UNKNOWN

Description: UNKNOWN

Platform: UNKNOWN

终端定位到此文件夹下,输入以下命令,模块将会被安装到解释器对应的Lib/site-packages目录下:

python setup.py install

安装后,会发现Lib/site-packages目录下存在printtest.py文件和printtest-1.0-py3.6.egg-info

应用:

import printtest

printtest.test()

输出:

print test

封装Python包

导入单个Python文件时成为Python模块,而包含多个Python文件的文件夹成为一个Python包。本节主要讲述怎样封装一个Python包。

1.创建一个文件夹,将需要封装的pagtest文件夹(里面为.py文件,需要包括一个__init__.py文件,内容可以为空)放到该文件夹中,然后创建setup.py文件对包进行配置:

from setuptools import setup
setup(name='pagtest',
   version='1.0.0',
   description='A print test for PyPI',
   author='winycg',
   author_email='win@163.com',
   url='https://www.python.org/',
   license='MIT',
   keywords='ga nn',
   project_urls={
      'Documentation': 'https://packaging.python.org/tutorials/distributing-packages/',
      'Funding': 'https://donate.pypi.org',
      'Source': 'https://github.com/pypa/sampleproject/',
      'Tracker': 'https://github.com/pypa/sampleproject/issues',
   },
   packages=['pagtest'],
   install_requires=['numpy>=1.14', 'tensorflow>=1.7'],
   python_requires='>=3'
   )

2.创建README.txt文件用于对文件的安装以及使用信息做描述

3.目前文件夹的目录的架构为:

pagtest/

    __init__.py

    print1.py

    print2.py

setup.py

README.txt

输入以下命令进行打包,制作source distribution(源代码发布包),此命令将会把所有内容在dist/目录打包为pagtest-1.0.0.tar.gz

python setup.py sdist

4.上传到PyPI上。上传时,可以建立一个账户验证文件~/.pypirc(Windows不可以,因为文件命名中含有非法字符),也可以在上传时输入账户和密码。

[distutils]

index-servers=pypi

[pypi]

repository = https://upload.pypi.org/legacy/

username = <username>

password = <password>

5.将命令行定位到此文件夹下,输入命令对dist目录下的pagtest-1.0.0.tar.gzt包进行上传,twine为Python包需要安装:

twine upload dist/*

制作python包为wheel文件

wheel是一个已经编译好的包,在安装时不需要编译过程,安装whl文件时要比发布的源文件安装要快。

在如上第2步后,输入如下命令即可在生成.whl

python setup.py bdist_wheel

.whl文件在dist目录下,上传到PyPI:

twine upload dist/*

更新Python包

修改setup.py中的版本号,然后直接上传即可

更多关于Python打包模块wheel的使用方法请查看下面的相关链接

Python 相关文章推荐
python根据出生日期返回年龄的方法
Mar 26 Python
python中list常用操作实例详解
Jun 03 Python
Python如何实现文本转语音
Aug 08 Python
Python标准库之itertools库的使用方法
Sep 07 Python
django实现用户登陆功能详解
Dec 11 Python
pandas中去除指定字符的实例
May 18 Python
对python opencv 添加文字 cv2.putText 的各参数介绍
Dec 05 Python
python执行scp命令拷贝文件及文件夹到远程主机的目录方法
Jul 08 Python
详解Python3迁移接口变化采坑记
Oct 11 Python
Python运行异常管理解决方案
Mar 09 Python
python可以用哪些数据库
Jun 22 Python
No module named ‘win32gui‘ 的解决方法(踩坑之旅)
Feb 18 Python
Python sep参数使用方法详解
Feb 12 #Python
Python多重继承之菱形继承的实例详解
Feb 12 #Python
Python实现桌面翻译工具【新手必学】
Feb 12 #Python
PyCharm无法引用自身项目解决方式
Feb 12 #Python
pycharm不能运行.py文件的解决方法
Feb 12 #Python
Python3+Selenium+Chrome实现自动填写WPS表单
Feb 12 #Python
pytorch中使用cuda扩展的实现示例
Feb 12 #Python
You might like
PHP隐形一句话后门,和ThinkPHP框架加密码程序(base64_decode)
2011/11/02 PHP
php读取csv文件后,uft8 bom导致在页面上显示出现问题的解决方法
2013/08/10 PHP
PHP 超级全局变量相关总结
2020/06/30 PHP
简单三步,搞掂内存泄漏
2007/03/10 Javascript
一个简单的javascript类定义例子
2009/09/12 Javascript
javascript getElementsByClassName 和js取地址栏参数
2010/01/02 Javascript
js点击出现悬浮窗效果不使用JQuery插件
2014/01/20 Javascript
浅谈javascript中this在事件中的应用
2015/02/15 Javascript
jQuery检测鼠标左键和右键点击的方法
2015/03/17 Javascript
ajax+jQuery实现级联显示地址的方法
2015/05/06 Javascript
浅谈javascript中的DOM方法
2015/07/16 Javascript
jquery实现滑屏大图定时收缩为小banner图片的广告代码
2015/09/02 Javascript
AngularJS 2.0新特性有哪些
2016/02/18 Javascript
Vue.js第四天学习笔记
2016/12/02 Javascript
Node.js对MongoDB数据库实现模糊查询的方法
2017/05/03 Javascript
jsonp跨域获取百度联想词的方法分析
2019/05/13 Javascript
详解javascript中var与ES6规范中let、const区别与用法
2020/01/11 Javascript
从零学Python之入门(四)运算
2014/05/27 Python
Python中3种内建数据结构:列表、元组和字典
2014/11/30 Python
利用Python实现颜色色值转换的小工具
2016/10/27 Python
Python 利用内置set函数对字符串和列表进行去重的方法
2018/06/29 Python
对tensorflow 的模型保存和调用实例讲解
2018/07/28 Python
详解python爬虫系列之初识爬虫
2019/04/06 Python
Python3.6实现带有简单界面的有道翻译小程序
2019/04/16 Python
Python字符串格式化f-string多种功能实现
2020/05/07 Python
tensorflow实现从.ckpt文件中读取任意变量
2020/05/26 Python
Python析构函数__del__定义原理解析
2020/11/20 Python
创伤外科专业推荐信范文
2013/11/19 职场文书
杠杆的科学教学反思
2014/01/10 职场文书
诚实守信演讲稿
2014/09/01 职场文书
2014幼儿教师个人工作总结
2014/12/03 职场文书
企业介绍信范文
2015/01/30 职场文书
事业单位财务人员岗位职责
2015/04/14 职场文书
小学班主任工作随笔
2015/08/15 职场文书
深入理解python协程
2021/06/15 Python
通过Qt连接OpenGauss数据库的详细教程
2021/06/23 PostgreSQL