天天看點

保姆級教程帶你開發優質的Python庫之上篇【建議收藏】總結

前面學委的python入門到精通專欄積累了8篇python文章,當然學委部落格還有幾十篇python應用的文章。

展示了很多啊,一路跟上的朋友估計也學習到很多了。

這次幾分鐘,給大家縷一縷,指導大家開發一個python庫。下次帶大家開發生成器!

(先導說明,下面圖中的聯系群體/聯系方式均為demo展示作用,不要搜尋!不要關注!哈哈哈)

什麼是python庫?

python庫,簡單了解就是一個python腳本代碼集合。這個庫可以包括一個或者多個python代碼檔案。

重點是,提供統一入口(子產品)給他人使用。

小白如果還不清楚,就把它了解為一個數學裡面的一個公式。

我們運用公式來計算出資料結果的過程,可以類比使用python庫調用并運作的到結果。

現在開發一個庫

之前寫過 一個小而全的Python項目示例,但是這個項目相對新手來說,還是元素過多了。

第一步,項目基本配置

必備檔案:README.md ,這個 檔案告訴了其他開發者,你分享的代碼的一些說明和使用資訊。

典型的項目README檔案展示如下:

保姆級教程帶你開發優質的Python庫之上篇【建議收藏】總結

生成上面的内容可以複制這裡的README.md進行修改

重點是:

項目介紹必要有的

安裝,類似pip install xxx(xxx為你的庫名)

使用的簡單說明

其他資訊像加入社群群體的可以另外再補充。

第二步開發子產品内的代碼

python裡面很簡單,建立一個目錄裡面放置一個__init__.py 就能把目前目錄标記為可用子產品了。

但是我們不要那麼魯莽。

建立一個pypi_seed目

然後再裡面放置__init__.py 檔案

最後編寫main.py(這是庫的核心檔案,也可以叫做core.py)

效果如下:

保姆級教程帶你開發優質的Python庫之上篇【建議收藏】總結

第三步,豐富一下核心代碼

上面的操作還隻是建立了一些空檔案。

下面我們打開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目的)

可以做很多事情的,但是這篇從簡單入手,後續會開發生成器!

好了,開發結束了。

最後調用運作看下效果

保姆級教程帶你開發優質的Python庫之上篇【建議收藏】總結

可以在庫提示中輸出一些開發群體資訊,請讀者不要搜尋。

補充一下,其他人調用你的庫是這樣的:

import pypi_seed.main #引入你的庫的主程式
main.main() #調用主程式的main函數
      

總結

整個過程挺簡單的。

别人找到你的庫就很不容易了,是以務必把README說明寫的越簡單越直白越好!

然後是使用的例子,必須力求簡潔易懂。