python的distutils、setuptools模块
创始人
2024-03-26 15:32:28
0

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 setupsetup(name="hello_module",version="1.0",author="ljk",author_email="wilber@sh.com",py_modules=['hello'],)

三、执行打包命令

python setup sdist

再次查看当前目录下自动生成了一个文件夹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 osdef fun():print "i am in the path:"print os.getcwd()

二、配置setup.py文件

创建setup.py文件,填写必要的打包信息。

 setup.py

#-*- encoding: UTF-8 -*-from setuptools import setupsetup(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']},)

在配置中将该模块需要的依赖全部都写好,安装时指定地址去下载。这种方式简化了使用时的安装过程,但是还不够好。最好的方式是pip的自动下载。

三、打包

python setup.py sdist

 打包之后多出两个文件夹,分别是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的管理工具。

  1. pbr是setuptools的辅助工具,最初为openstack开发,基于d2to1。Pbr会读取和过滤setup.cfg中的内容,然后将解析后的数据提供给setup.py作为参数。
  2. setup.cfg提供setup.py的默认参数,同时易于修改。Setup.py先解析setup.cfg文件,然后执行相关命令。包括以下功能:
  3. 1、从git中获取Version,AUTHORS和ChangeLog信息
  4. 2、SphinxAutodoc。pbr会扫描project,找到所有模块,生成stubfiles
  5. 3、Requirements。读取requirements.txt文件,生成setup函数需要依赖包
  6. 4、long_description。从README.rst、README.txt或者READMEfile中生成long_description参数

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

setup.py

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

setup.cfg

[metadata]name= keystoneversion= 2015.2summary= OpenStack Identitydescription-file=README.rstauthor= OpenStackauthor-email= openstack-dev@lists.openstack.orghome-page= http://www.openstack.org/classifier=Environment:: OpenStackIntendedAudience :: Information TechnologyIntendedAudience :: System AdministratorsLicense:: OSI Approved :: Apache Software LicenseOperatingSystem :: POSIX :: LinuxProgrammingLanguage :: PythonProgrammingLanguage :: Python :: 2ProgrammingLanguage :: Python :: 2.7[files]packages=keystone[global]setup-hooks=pbr.hooks.setup_hook[egg_info]tag_build=tag_date= 0tag_svn_revision= 0[build_sphinx]all_files= 1build-dir= doc/buildsource-dir= doc/source[compile_catalog]directory= keystone/localedomain= keystone

相关内容

热门资讯

监控摄像头接入GB28181平... 流程简介将监控摄像头的视频在网站和APP中直播,要解决的几个问题是:1&...
Windows10添加群晖磁盘... 在使用群晖NAS时,我们需要通过本地映射的方式把NAS映射成本地的一块磁盘使用。 通过...
protocol buffer... 目录 目录 什么是protocol buffer 1.protobuf 1.1安装  1.2使用...
在Word、WPS中插入AxM... 引言 我最近需要写一些文章,在排版时发现AxMath插入的公式竟然会导致行间距异常&#...
Fluent中创建监测点 1 概述某些仿真问题,需要创建监测点,用于获取空间定点的数据࿰...
educoder数据结构与算法...                                                   ...
MySQL下载和安装(Wind... 前言:刚换了一台电脑,里面所有东西都需要重新配置,习惯了所...
MFC文件操作  MFC提供了一个文件操作的基类CFile,这个类提供了一个没有缓存的二进制格式的磁盘...
有效的括号 一、题目 给定一个只包括 '(',')','{','}'...
【Ctfer训练计划】——(三... 作者名:Demo不是emo  主页面链接:主页传送门 创作初心ÿ...