如何实现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 . # 调用模块下的最新文件安装

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

相关内容

热门资讯

蜻蜓订购APP贵金属订购非法期...   蜻蜓订购APP以"投资平台"名义对外宣传,主打贵金属期货(订购)交易。该平台一方面强调自身"正规...
悟空订购APP非法期货交易欺骗...   近期,有投资者反映,“悟空订购APP”等平台以白银、贵金属订购为名,宣传所谓“高收益”“低门槛”...
小赢淘金APP期货投资骗局,平...   “小赢淘金”之流,最擅长的就是用“注册送现金”、“充值返券”的糖衣炮弹来引流。别天真地以为那是福...
八方淘金APP非法期货交易欺骗...   警惕!八方生财、每日淘金、小赢淘金、悟空订购、蜻蜓订购、斗金订购等APP均涉嫌非法期货交易!  ...
智易购APP贵金属订购交易骗局...   很多人看到“3元起投”“充值送福利”“操作简单”“随时提现”这类宣传,很容易把智易购APP当成普...
喜玛银庄APP商品订购投资骗局...   喜玛银庄APP白银、铂金“现货订购”骗局警示:无资质平台涉嫌非法期货交易,投资者爆仓后如何维权?...
吉鑫乐享APP炒贵金属订购交易...   近期,多名投资者反映在“吉鑫乐享APP”进行贵金属投资时遭遇严重亏损,甚至血本无归。看似正规的“...
易掘金APP虚假期货投资骗局,...   “易掘金”的APP它打着“高收益、灵活投资”的旗号,宣称通过“商品订购”就能轻松赚钱,吸引了不少...
在大吉订购APP订购交易亏损被...   近期,不少投资者反映在“大吉订购App”上投资白银、铂金等商品遭遇严重亏损。该平台宣称提供现货订...
铂银壹号APP商品订购交易亏损...   许多中小投资者误以为网上的“商品现货订购”是合规合法的理财渠道,殊不知这背后隐藏着巨大的合规风险...
兴鑫淘金APP贵金属订购交易亏...   白银、贵金属或其他商品类投资,除国家批准的正规期货交易场所及持牌期货公司外,市面上大量第三方交易...
铂银掘金APP无资质的违规平台...   铂银掘金等平台的投资者,往往是被“注册送现金”“充值返现券”“首单免亏”等广告话术吸引,进而下载...
八方淘金APP订购交易不合规,...   “八方淘金APP”“铂银掘金APP”“铂银壹号APP”等软件被指以“现货订购”为名,实际采用高杠...
在指尖订购APP订购商品亏损被...   指尖订购APP这类平台,表面是“订购交易”,实则是披着电商外衣的非法期货陷阱。绝大多数投资者被蒙...
在犀贝易购APP做商品订购交易...   市面上打着“现货投资”“贵金属交易”旗号的APP并不少,但真正合规、受监管的平台并不多。犀贝易购...
易达淘金APP虚假商品订购交易...   易达淘金APP存在严重的虚假宣传与违规交易行为。该平台打着“商品订购”的旗号,实则通过不合规的交...
大浪淘金APP白银订购亏损被骗...   大浪淘金APP最隐蔽的套路,在于其完全封闭的内盘交易系统。表面上,它宣称与国际贵金属市场接轨;实...
一品好购APP上订购白银出现亏...   一品好购APP原名“一品订购”,运营方为上海宝智未来信息技术有限公司。近期不少投资者反映在该平台...
九州订购APP贵金属订购投资骗...   九州订购APP正通过抖.音、快手、今日头条等平台大量投放投资广告,用“5元起投”“充值返现”“0...
坚锅淘金APP交易软件并不正规...   当前,市面上大量所谓的“现货商城订购”交易软件,早已偏离了正常的实物商品买卖,演变为高杠杆、高手...