python构建并发布自己的包

一、背景

我们平时使用pip install xxx安装包,使用包,但是如果:我们拉取pypi社区的某GitHub项目源码后,发现其源码某文件中会出现:

py 复制代码
import xxx.module_A
from xxx import module_A
import xxx.module_A as A
from xxx import module_A as A

这种字样

注意 :这里的xxx是某文件所在目录的包名,也就是其所属包的名字

注意:不可以直接导入包,python是一定要落脚于模块的

那么直接运行源码,会出现依赖的问题;如何解决这个问题,是本博客解决的事情

类似于下图的依赖过程:

tool.py依赖my_module.py时,平时都是直接引入模块名,但是在发布后的包中,会出现import my_package.my_module as my_module

和我们认知中不一样,并且直接运行这个脚本会出错:

所以我们需要搞清楚这个包为什么这样引入

二、实验过程

包的文件结构:

注意 :实际的包是my_package,而不是这个项目

与第一部分一样,tool依赖了my_module

使用时的测试代码:

py 复制代码
import my_package.tool as tool

if __name__ == "__main__":
    print("hello world")
    tool.my_tool()

构建包

在项目目录下(而不是实际的包目录下),新建setup.py文件:

py 复制代码
from setuptools import setup, find_packages

VERSION = '0.0.1' 
DESCRIPTION = 'My first Python package'
LONG_DESCRIPTION = 'My first Python package with a slightly longer description'

# 配置
setup(
       # 名称必须匹配文件名 'verysimplemodule'
        name="my_package", 
        version=VERSION,
        author="masteryi",
        author_email="<youremail@email.com>",
        description=DESCRIPTION,
        long_description=LONG_DESCRIPTION,
        packages=find_packages(),
        install_requires=[], # add any additional packages that 
        # 需要和你的包一起安装,例如:'caer'
        
        keywords=['python', 'first package'],
        classifiers= [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Education",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 3",
            "Operating System :: MacOS :: MacOS X",
            "Operating System :: Microsoft :: Windows",
        ]
)

测试包

执行python setup.py install

本地安装自己写的包:

成功安装:

在测试文件测试,成功输出:

shell 复制代码
PS D:\project\test_my_pkg> python .\test.py
hello world
this is my_module
this is sub_pkg's m_1
this is sub_pkg's m_2

三、心得

构建包的话,各个模块需要统一引入包名作为所构建包的名称,子包也是一样的处理,否则会出现找不到包的问题

如果按照自己的构建项目的方式构建包,就会出现包的路径有问题的情况

参考资料

相关推荐
艾莉丝努力练剑18 分钟前
【LeetCode&数据结构】单链表的应用——反转链表问题、链表的中间节点问题详解
c语言·开发语言·数据结构·学习·算法·leetcode·链表
橡晟4 小时前
深度学习入门:让神经网络变得“深不可测“⚡(二)
人工智能·python·深度学习·机器学习·计算机视觉
墨尘游子4 小时前
神经网络的层与块
人工智能·python·深度学习·机器学习
倔强青铜34 小时前
苦练Python第18天:Python异常处理锦囊
开发语言·python
u_topian5 小时前
【个人笔记】Qt使用的一些易错问题
开发语言·笔记·qt
企鹅与蟒蛇5 小时前
Ubuntu-25.04 Wayland桌面环境安装Anaconda3之后无法启动anaconda-navigator问题解决
linux·运维·python·ubuntu·anaconda
autobaba5 小时前
编写bat文件自动打开chrome浏览器,并通过selenium抓取浏览器操作chrome
chrome·python·selenium·rpa
珊瑚里的鱼5 小时前
LeetCode 692题解 | 前K个高频单词
开发语言·c++·算法·leetcode·职场和发展·学习方法
AI+程序员在路上5 小时前
QTextCodec的功能及其在Qt5及Qt6中的演变
开发语言·c++·qt
xingshanchang5 小时前
Matlab的命令行窗口内容的记录-利用diary记录日志/保存命令窗口输出
开发语言·matlab