保姆级教程带你开发优质的Python库之上篇建议收藏

Posted 雷学委

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了保姆级教程带你开发优质的Python库之上篇建议收藏相关的知识,希望对你有一定的参考价值。

正式的Python专栏第9篇,同学站住,别错过这个从0开始的文章!

前面学委的python入门到精通专栏积累了8篇python文章,当然学委博客还有几十篇python应用的文章。

展示了很多啊,一路跟上的朋友估计也学习到很多了。

这次几分钟,给大家缕一缕,指导大家开发一个python库。下次带大家开发生成器!

(先导说明,下面图中的联系群体/联系方式均为demo展示作用,不要搜索!不要关注!哈哈哈)

什么是python库?

python库,简单理解就是一个python脚本代码集合。这个库可以包括一个或者多个python代码文件。
重点是,提供统一入口(模块)给他人使用。

小白如果还不清楚,就把它理解为一个数学里面的一个公式。

我们运用公式来计算出数据结果的过程,可以类比使用python库调用并运行的到结果。

现在开发一个库

之前写过 一个小而全的Python项目示例,但是这个项目相对新手来说,还是元素过多了。

第一步,项目基本配置

必备文件:README.md ,这个 文件告诉了其他开发者,你分享的代码的一些说明和使用信息。

典型的项目README文件展示如下:

生成上面的内容可以复制这里的README.md进行修改

重点是:

  • 项目介绍必要有的
  • 安装,类似pip install xxx(xxx为你的库名)
  • 使用的简单说明

其他信息像加入社区群体的可以另外再补充。

第二步开发模块内的代码

python里面很简单,创建一个目录里面放置一个__init__.py 就能把当前目录标记为可用模块了。

但是我们不要那么鲁莽。

  1. 创建一个pypi_seed目
  2. 然后再里面放置__init__.py 文件
  3. 最后编写main.py(这是库的核心文件,也可以叫做core.py)

效果如下:

第三步,丰富一下核心代码

上面的操作还只是创建了一些空文件。

下面我们打开main.py 复制黏贴下面的内容。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : 2021/9/5 12:07 上午
# @Author : LeiXueWei
# @CSDN/Juejin/Wechat: 雷学委
# @XueWeiTag: CodingDemo
# @File : main.py
# @Project : pypi_seed


def main():
    print("pypi_seed 种子项目")
    print("欢迎关注公众号【雷学委】【孤寒】【布小禅】,加入Python开发者阵营!")
    print("===========================================")
    print("如何创建项目:")
    print("1)打开python终端REPL:")
    print("2)输入下面代码:")
    print("import pypi_seed.main as pm")
    print("pm.generate() #当前目录生成pypi_sample")
    print("#或者加一个路径参数")
    print("pm.generate('/tmp') #当前目录生成/tmp/pypi_sample")
    print("#或者指定更多项目信息:")
    print("pm.generate(path=\\".\\", project=\\"pypi_sample\\", author=\\"pypi_seed\\") #当前目录生成/tmp/pypi_sample,作者pypi_sample")
    print("===========================================")
    print("Please feel free to contact us【Python全栈技术学习交流】:https://jq.qq.com/?_wv=1027&k=ISjeG32x ")
    print("===========================================")




if __name__ == '__main__':
    main()

代码解析:

上面实现了一个main函数,输出了一些程序信息。比如一些虚拟账号和联系方式,强烈提示读者不要打开链接或者搜索群体!(学委这里特别标注了一下!仅为demo目的)

可以做很多事情的,但是这篇从简单入手,后续会开发生成器!

好了,开发结束了。

最后调用运行看下效果


可以在库提示中输出一些开发群体信息,请读者不要搜索

补充一下,其他人调用你的库是这样的:

import pypi_seed.main #引入你的库的主程序
main.main() #调用主程序的main函数

总结

整个过程挺简单的。

别人找到你的库就很不容易了,所以务必把README说明写的越简单越直白越好!

然后是使用的例子,必须力求简洁易懂。

喜欢Python的朋友,请关注学习 Python基础专栏 or Python入门到精通大专栏

持续学习持续开发,我是雷学委!
编程很有趣,关键是把技术搞透彻讲明白。
创作不易,请关注收藏点赞,或者留下评论打打气!

以上是关于保姆级教程带你开发优质的Python库之上篇建议收藏的主要内容,如果未能解决你的问题,请参考以下文章

保姆级教程带你开发优质的Python库之下篇种子项目

保姆级教程带你开发优质的Python库之下篇种子项目

保姆级教程带你开发优质的Python库之中篇命令行发行

保姆级教程带你开发优质的Python库之中篇命令行发行

保姆级教程HTML两万字笔记大总结建议收藏(上篇)

保姆级教程HTML两万字笔记大总结建议收藏(上篇)