如何实现python构建打包供他人安装
admin
2024-03-12 22:33:25
0

假如在同一级目录下有两个python文件(即python模块),那么这两个模块不需要安装也能相互进行import引用,但是不在同级目录下甚至不在同一项目中的模块怎么做到相互引用呢?

Python setuptools

setuptools是python自带用于打包构建的工具,使用此工具可打包出可供import引用的模块或者可供他人安装的wheel包。
官方文档:setuptools

pip install安装模块

首先需要在项目根目录创建setup.py,用于设置setuptools的构建配置。这里是直接使用的setuptools.setup()函数进行配置,官方推荐的方式是使用setup.cfg配置文件。

import setuptools
setuptools.setup(name='test-tool', # 扩展功能包名称py_modules=['test'] # 打包模块名称,对应test.py,安装包之后使用此名称进行import
)

切换到项目根目录,通过pip install .命令进行安装。安装成功后,就可以在其他python文件中import模块并调用该模块下的函数。

pip wheel打包构建

这里同样是使用setuptools.setup()函数方式进行配置,如下。

#!/usr/bin/python
# -*- coding: UTF-8 -*-
import setuptoolssetuptools.setup(name='test-tool',version='1.0.0',description='Description.',author='San',author_email='San@163.com',package_dir={"": "src"}, # 打包目录packages=setuptools.find_packages(where='src') # 搜索存在__init__.py打包文件夹
)

使用pip wheel .打包后会在当前目录生成*.whl文件,将这个文件提供给其他人,其他人通过pip install *.whl就能将此安装包安装到扩展库。
关于打包配置需要说明以下几点:

  1. find_packages()只会搜索目录下包含__init__.py文件的目录进行打包。
  2. find_packages()可以设置打包剔除目录:
setuptools.find_packages(exclude=['additional*']) # 剔除additional目录
  1. 区分.whl包python包的概念:
    打包成功生成的.whl文件是一个安装包,而python包指的是含有__init__.py文件的目录。
  2. 安装包被安装成功后,会在D:\python3.10\Lib\site-packages路径下出现python扩展功能包,注意D:\python3.10为python在本机的安装目录。
  3. 项目的层级目录使用官方推荐的创建方法,如下:
├── src
│   └── mypkg
│       ├── __init__.py
│       └── tool1.py
├── setup.py
└── setup.cfg
如何确定打包构建的代码是否正确
  1. 项目构建后,会出现./build/lib目录,在该目录下的模块才会被打进.whl安装包。
  2. 对于不需要被打包的模块,需要在此目录中删除或者使用setup.py clean清除临时打包目录。
  3. 在此目录下可以对打包的模块和模块下的代码进行检查确定。

构建问题解决

执行pip wheel .报错usage: setup.py [global_opts]

报错usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]

  • 解决办法:
    查看具体报错信息,发现造成错误的原因是没安装wheel工具,实际在执行时用的指令是setup.py install
    最简单的解决办法是pip install wheel安装wheel,其次可以使用传统指令python setup.py bdist_wheel去打包。
打包报错error: package directory ‘mypkg’ does not exist

造成此错误的原因是配置打包目录src时没有同时设置find_packages()。正确示例如下。

package_dir={"": "src"},
packages=setuptools.find_packages(where='src')
error: error in ‘egg_base’ option: ‘src’ does not exist or is not a directory

文件夹src与setup.py不在同级目录下时会出现此错误,需将setup.py移至与src文件夹同级目录。

引用模块报错Cannot find reference ‘test-tool’ in ‘init.py’

此问题也是个大坑,找了很久原因,最后发现是模块名称(也就是python文件)命名中包含"-",不符合Python编写规范导致的。

python文件只能以英文小写命名,单词间可以用下划线

常用构建命令

pip list # 查看已安装扩展包列表
pip uninstall test-tool # 卸载扩展包
pip wheel . # 打包构建
pip install cert_kit-1.0.0-py3-none-any.whl # 安装扩展包
pip install -e . # 调用模块下的最新文件安装

本文以个人经验总结而成,内容有误的地方还请读者指正。

相关内容

热门资讯

银行间主要利率债午间走势分化 每经AI快讯,7月28日,银行间主要利率债午间走势分化,30年期国债“26超长特别国债04”收益率下...
2026海河国际消费论坛即将在... 2026海河国际消费论坛将于7月30日下午在天津启幕,目前各项筹备工作已全部就绪。本届论坛以“创新服...
原创 一... 前言 1942年的一天,一名身穿军装的年轻人,悄悄走到一位老妇人的面前。他脸上带着疲惫,眼神中却依然...
原创 曹... 八十岁的曹德旺,这几年在公开场合谈到房子这两个字,语气一次比一次冷。他早年那句"房子不过是钢筋水泥堆...
股息率近5.5%!港股红利低波... 7月28日,港股红利资产延续强势。截至13时48分,港股红利低波ETF招商(520550)涨0.46...
企业文件共享平台怎么选?主流方... 文件共享平台种类繁多,各有侧重。今天这篇文章,把2026年市面上主流的企业文件共享平台做个系统梳理,...
币圈院士:7.26以太坊(ET... 币圈院士:7.26以太坊(ETH)双周期指标暗藏方向,行情即将破位?最新行情分析参考 以太坊现价18...
老铺黄金发盈喜后股价跌16.2... 观点网讯:7月28日,老铺黄金股价裂口低开12.97%,最低见325.8港元,收盘报332港元,跌1...
苏泊尔上半年营收净利双降,法籍... 瑞财经 严明会 近日,苏泊尔(002032.SZ)披露2026年半年度业绩快报。 公告显示,公司上半...
IPO雷达|陕西瑞科回复二轮问... 深圳商报·读创客户端记者 梁佳彤 7月27日,据北交所官网,陕西瑞科新材料股份有限公司(下称“陕西瑞...
普京签令,俄军扩编 据新华社报道,俄罗斯总统普京27日签署命令, 决定组建几支军事建筑工程部队,并将俄武装力量编制总人数...
2027年德国杜塞尔多夫国际铸... 展会名称:2027年德国杜塞尔多夫国际铸造、冶金、热处理及铸件展览会GMTN 开始时间:2027-0...
郑州有了温通刮痧培训示范基地 本报讯(记者 杨振东 通讯员 张丹婧)温通刮痧是中医外治法里的一种,简单说就是在传统刮痧基础上,结合...
整箱茅台和单瓶茅台,回收行情为... 不少天津藏友存在疑惑:同样年份、同样品相的飞天茅台,整箱装和拆箱单瓶的回收报价存在差距,不清楚背后的...
北京五粮液收购需要遵循哪些通用... 北京五粮液收购的行业背景 近年来高端白酒的收藏与流通市场规模稳步扩张,北京作为国内重要的消费城市,五...
微软CEO重磅警告:只依赖一家... 来源:环球网 【环球网科技综合报道】7月28日消息,据外媒TechCrunch报道,微软CEO萨提亚...
策略师:金价夏季维持4000美... 汇通财经APP讯——今夏金价大概率在4000美元/盎司附近震荡筑底,市场等待美联储货币政策清晰指引。...
大众叙事下白酒行业周期如何拆解... 白酒行业的波动往往并非单纯由供需关系决定,而是 宏观经济预期与 渠道库存周期共振的结果。在大众认知中...
沈皓南:黄金低位大区间运行,短... 大家好,我是沈皓南,差不多有一个月没有更新黄金文章了,这段时间我去了美丽的新疆,自驾了独库公路,观赏...
原创 上... 2000年9月28日傍晚,济青高速临淄出口边一家小饭馆的木门被推开,六个山东汉子鱼贯而入。几个小时前...