python中创建一个包并引用使用的操作方法

来自:网络
时间:2022-12-28
阅读:

一、Python包

python包在开发中十分常见,一般通过导入包含特定功能的python模块包进行使用。当然,也可以自己创建打包模块,然后发布,安装使用。

1、安装包

在线安装包:pip install 包名;
安装第三方包:python setup.py  install (几乎每个python第三方包中都有这个setup.py文件,这个文件是作者打包时设置的文件,而安装第三方包时,也是要先进入到setup.py文件所在目录,然后执行python setup.py install)

2、distutils 和 setuptools 两种打包的工具

distutils

distutils 是 python 标准库的一部分,这个库的目的是为开发者提供一种方便的打包方式, 同时为使用者提供方便的安装方式。当我们开发了自己的模块之后,使用distutils的setup.py打包。
使用详情如下:
(1)在自己项目的根目录下新建一个setup.py的脚本,然后在脚本中输入下面的代码,假设你要打包的module名称为str.py

from distutils.core import setup 
setup (
    name = 'str', 
    version = '1.0', 
    py_modules = ['str'], 
)

(3)根目录下执行打包命令:python setup.py sdist ,将自己的python文件打包,此时会发现多了一个文件夹dist,此文件夹下面多了一个str-0.1.tar.gz的压缩包,这个压缩包里面就是untitled目录下的项目代码

(4)安装包:进入cmd,然后输入dos命令进入setup.py文件所在目录,然后输入python setup.py install。

setuptools

setuptools是distutils的增强版。它可以帮助我们更简单的创建和分发Python包,尤其是拥有依赖关系的。用户在使用setuptools创建的包时,并不需要已安装setuptools,只要一个启动模块setup.py即可。

使用详情如下:

(1)安装pip install python-setuptools后,在自己项目的根目录下新建一个setup.py的脚本(注意:每个目录中都需要创建一个init.py的文件,表示这个目录是一个包)

from setuptools import setup, find_packages 
setup( 
    name = "demo", 
    version = "0.1", 
    packages = find_packages(), # 代表在当前目录,以及当前目录下,所有的python包(带__init__.py的目录)都搜索,并一起打成egg文件包。find_packages(xyz),就是搜索名称为xyz的包,以及xyz的下层目录的包搜索出来,并一起打成egg文件包 
    include_package_data=True, #包含数据文件 
    install_requires=reqs, #指明依赖,该参数包含说明依赖的字符串或列表 
)

(2)根目录下执行打包命令:python setup.py sdist_egg即可打包一个egg格式的包。可以看到,里面是一系列自动生成的文件。如图:

python中创建一个包并引用使用的操作方法

(3)而dist中的压缩包就是安装包,此时默认的egg包,egg包就是zip包,如果需要使用egg包,简单方法是name将egg后缀改成zip解压即可(或者进入cmd,然后输入dos命令进入setup.py文件所在目录,然后输入python setup.py install)(4)测试导入包:

python中创建一个包并引用使用的操作方法

实际项目中,安装非官方的第三方包时,可以下载到本地后,在setup.py文件夹下执行python setup.py install,或者在包根目录通过pip install -e . 安装pip会自动将包复制到site-packages,他的作用是:

  • 安装site-packages/PackageName.egg-link文件
  • 添加路径 site-packages/easy-install.pth
返回顶部
顶部