python27期day16:序列化、json、pickle、hashlib、collections、軟件開發規範、做業。

序列化模塊:
什麼是序列化呢? 序列化的本質就是將一種數據結構(如字典、列表)等轉換成一個特殊的序列(字符串或者bytes)的過程就叫作序列化。
將這個字典直接寫入文件是不能夠的,必須轉化成字符串的形式,並且你讀取出來也是字符串形式的字典(能夠用代碼展現)。
json序列化除了能夠解決寫入文件的問題,還能夠解決網絡傳輸的問題,好比你將一個list數據結構經過網絡傳給另個開發者,那麼你不能夠直接傳輸,以前咱們說過,你要想傳輸出去必須用bytes類型。可是bytes類型只能與字符串類型互相轉化,它不能與其餘數據結構直接轉化,因此,你只能將list ---> 字符串 ---> bytes 而後發送,對方收到以後,在decode() 解碼成原字符串。此時這個字符串不能是咱們以前學過的str那種字符串,由於它不能反解,必需要是這個特殊的字符串,他能夠反解成list 這樣開發者之間就能夠藉助網絡互傳數據了,不只僅是開發者之間,你要藉助網絡爬取數據這些數據多半是這種特殊的字符串,你接受到以後,在反解成你須要的數據類型。
序列化模塊就是將一個常見的數據結構轉化成一個特殊的序列,而且這個特殊的序列還能夠反解回去。它的主要用途:文件讀寫數據,網絡傳輸數據。

不一樣語言都遵循的一種數據轉化格式,即不一樣語言都使用的特殊字符串。(好比Python的一個列表[1, 2, 3]利用json轉化成特殊的字符串,而後在編碼成bytes發送給php的開發者,php的開發者就能夠解碼成特殊的字符串,而後在反解成原數組(列表): [1, 2, 3])php

json序列化只支持部分Python數據結構:dict,list, tuple,str,int, float,True,False,Nonejava

支持Python全部的數據類型包括實例化對象。python

json模塊是將知足條件的數據結構轉化成特殊的字符串,而且也能夠反序列化還原回去。linux

序列化模塊總共只有兩種用法,要不就是用於網絡傳輸的中間環節,要不就是文件存儲的中間環節,因此json模塊總共就有兩對四個方法:git

json模塊:

​ 用於網絡傳輸:dumps、loadsgithub

​ 用於文件寫讀:dump、loadredis

dumps、loads:算法

一、將字典類型轉換成字符串類型:數據庫

import json 編程

dic = {'k1':'v1','k2':'v2','k3':'v3'}

str_dic = json.dumps(dic) #序列化:將一個字典轉換成一個字符串

print(type(str_dic),str_dic)

結果:<class 'str'> {"k3": "v3", "k1": "v1", "k2": "v2"} #注意,json轉換完的字符串類型的字典中的字符串是由""表示的
二、將字符串類型的字典轉換成字典類型用loads:

import json

dic2 = json.loads(str_dic) #反序列化:將一個字符串格式的字典轉換成一個字典

#注意,要用json的loads功能處理的字符串類型的字典中的字符串必須由""表示

print(type(dic2),dic2)

結果:<class 'dict'> {'k1': 'v1', 'k2': 'v2', 'k3': 'v3'}

三、還支持列表類型:

list_dic = [1,['a','b','c'],3,{'k1':'v1','k2':'v2'}]

str_dic = json.dumps(list_dic) #也能夠處理嵌套的數據類型

print(type(str_dic),str_dic)

結果:<class 'str'> [1, ["a", "b", "c"], 3, {"k1": "v1", "k2": "v2"}]

list_dic2 = json.loads(str_dic)

print(type(list_dic2),list_dic2)

結果:<class 'list'> [1, ['a', 'b', 'c'], 3, {'k1': 'v1', 'k2': 'v2'}]

dump、load:

一、將對象轉換成字符串寫入到文件當中:

import json

f = open('json_file.json','w')

dic = {'k1':'v1','k2':'v2','k3':'v3'}

json.dump(dic,f) #dump方法接收一個文件句柄,直接將字典轉換成json字符串寫入文件

f.close() # json文件也是文件,就是專門存儲json字符串的文件。

二、將文件中的字符串類型的字典轉換成字典:

import json

f = open('json_file.json')

dic2 = json.load(f) #load方法接收一個文件句柄,直接將文件中的json字符串轉換成數據結構返回

f.close()

print(type(dic2),dic2)

三、其餘參數說明:

ensure_ascii:,當它爲True的時候,全部非ASCII碼字符顯示爲\uXXXX序列,只需在dump時將ensure_ascii設置爲False便可,此時存入json的中文便可正常顯示。

separators:分隔符,其實是(item_separator, dict_separator)的一個元組,默認的就是(,,:);這表示dictionary內keys之間用「,」隔開,而KEY和value之間用「:」隔開。

sort_keys:將數據根據keys的值進行排序。 剩下的本身看源碼研究

四、json序列化存儲多個數據到同一個文件中:

對於json序列化,存儲多個數據到一個文件中是有問題的,默認一個json文件只能存儲一個json數據,可是也能夠解決,舉例說明:

對於json 存儲多個數據到文件中:
dic1 = {'name':'oldboy1'}
dic2 = {'name':'oldboy2'}
dic3 = {'name':'oldboy3'}
f = open('序列化',encoding='utf-8',mode='a')
json.dump(dic1,f)
json.dump(dic2,f)
json.dump(dic3,f)
f.close()

f = open('序列化',encoding='utf-8')

ret = json.load(f)

ret1 = json.load(f)

ret2 = json.load(f)

print(ret)

上邊的代碼會報錯,解決方法:

dic1 = {'name':'oldboy1'} dic2 = {'name':'oldboy2'} dic3 = {'name':'oldboy3'} f = open('序列化',encoding='utf-8',mode='a') str1 = json.dumps(dic1) f.write(str1+'\n') str2 = json.dumps(dic2) f.write(str2+'\n') str3 = json.dumps(dic3) f.write(str3+'\n') f.close()
f = open('序列化',encoding='utf-8') for line in f: print(json.loads(line))
pickle模塊:

只能是Python語言遵循的一種數據轉化格式,只能在python語言中使用。

pickle模塊是將Python全部的數據結構以及對象等轉化成bytes類型,而後還能夠反序列化還原回去。

 剛纔也跟你們提到了pickle模塊,pickle模塊是隻能Python語言識別的序列化模塊。若是把序列化模塊比喻成全世界公認的一種交流語言,也就是標準的話,json就是像是英語,全世界(python,java,php,C,等等)都遵循這個標準。而pickle就是中文,只有中國人(python)做爲第一交流語言。

既然只是Python語言使用,那麼它支持Python全部的數據類型包括後面咱們要講的實例化對象等,它能將這些全部的數據結構序列化成特殊的bytes,而後還能夠反序列化還原。使用上與json幾乎差很少,也是兩對四個方法。

用於網絡傳輸:dumps、loads

​用於文件寫讀:dump、load

dumps、loads:

import pickle

dic = {'k1':'v1','k2':'v2','k3':'v3'}

str_dic = pickle.dumps(dic)

print(str_dic) # bytes類型

dic2 = pickle.loads(str_dic)

print(dic2) #字典

# 還能夠序列化對象

import pickle

def func():

   print(666)

ret = pickle.dumps(func)

print(ret,type(ret)) # b'\x80\x03c__main__\nfunc\nq\x00.' <class 'bytes'>

f1 = pickle.loads(ret) # f1獲得 func函數的內存地址

f1() # 執行func函數

dump、load:

dic = {(1,2):'oldboy',1:True,'set':{1,2,3}}

f = open('pick序列化',mode='wb')

pickle.dump(dic,f)

f.close()

with open('pick序列化',mode='wb') as f1:

   pickle.dump(dic,f1)

pickle序列化存儲多個數據到一個文件中:

dic1 = {'name':'oldboy1'}

dic2 = {'name':'oldboy2'}

dic3 = {'name':'oldboy3'}

f = open('pick多數據',mode='wb')

pickle.dump(dic1,f)

pickle.dump(dic2,f)

pickle.dump(dic3,f)

f.close()

f = open('pick多數據',mode='rb')

while True:

   try:

      print(pickle.load(f))

   except EOFError:

     break

f.close()

這時候機智的你又要說了,既然pickle如此強大,爲何還要學json呢?這裏咱們要說明一下,json是一種全部的語言均可以識別的數據結構。若是咱們將一個字典或者序列化成了一個json存在文件裏,那麼java代碼或者js代碼也能夠拿來用。可是若是咱們用pickle進行序列化,其餘語言就不能讀懂這是什麼了~因此,若是你序列化的內容是列表或者字典,咱們很是推薦你使用json模塊,但若是出於某種緣由你不得不序列化其餘的數據類型,而將來你還會用python對這個數據進行反序列化的話,那麼就可使用pickle。

shelve模塊
​ shelve模塊:相似於字典的操做方式去操做特殊的字符串(不講,能夠課下了解)。
#一、將字典放入文本
import shelve
f = shelve.open(r"shelve")
f["stul_info"] = {"name":"alex","age":"18"}
f.close()
# dic = {}
# dic["name"] = "alvin"
# dic["info"] = {"name":"alex"}
XML模塊
#一、用getroot打印根節點
import xml.etree.ElementTree as ET #as後面的ET代指前面模塊的名字
tree = ET.parse("xml_lesson.xml") #用ET裏面的parse方法並賦予對象tree、
root = tree.getroot()
print(root.tag)
#二、遍歷xml文檔
for i in root:
print(i)
#三、遍歷屬性tag
for i in root:
print(i.tag)
#四、雙層循環遍歷
for i in root:
for j in i:
print(j.tag)
#五、看值attrib屬性組成鍵值對
for i in root :
print(i.attrib)
#六、遍歷打印子元素
for i in root:
for j in i:
print(j.attrib)
#七、text
for i in root:
for j in i:
print(j.text)
re正則模塊
import re
#一、找到以a開頭和l結尾的
s = "hellocdalexfdsfdsfdsf"
print(s.find("alex"))
#二、371481198506143635(alex身份證號)
print(re.findall("\d+","alex22ccsd45vcxvcx767bvcbcv876"))
#三、findall(匹配規則+內容)
print(re.findall("alex","afdsvcxvfsg"))
#四、a..x(表明以a開頭中間任意兩個字符以x結尾的
print(re.findall("a..x","affxcvcvsdf"))
#五、^尖角號表明以什麼開頭
print(re.findall("^a..c","acxcxacxcx"))
#六、$表明以什麼結尾
print(re.findall("a..x$","acxvfsdfsdarrx"))
#七、*表明0到無窮次
print(re.findall("d*","dfdsfdsfdsadsadddddddddvcxvxc"))
#八、?
#九、{}爲範圍取
#十、[]中括號字符集
#十一、(小括號
print(re.findall("\([^()]*\)","12 + (34 * 6 + 2 - 5*(2-1)"))
#12\d
#13\D
#1四、|管道符表明或的意思
print(re.findall(r"ka|b","sdjkbsf"))
print(re.findall(r"ka|b","sdjkabsf"))
print(re.findall(r"ka|bc","sdjkabcsf"))
#1五、d+
print(re.sub("\d+","A","fdsfdsfjaskd4324vcxvxc"))
#1六、加參數
print(re.subn("\d","A","jackcxcvsdfd4343543543vcxvxcavcxvxd543534fdfds",8))
#1七、
loging日誌模塊
#一、日誌級別
import logging
#二、增長參數
# logging.basicConfig(
# level=logging.DEBUG,
# filename="logger.log",
# filename="w" #模式是追加
# )
# logging.debug("debug message")
# logging.info("info message")
# logging.warning("warning message")
# logging.error("error message")
# logging.critical("critical message")
#三、
import configparser
config = configparser.ConfigParser() #用configparser模塊裏面的ConfigParser類生成config對象
config["DEFAULT"] = {"ServerAliveInterval" : "45", #鍵值對
"Compression": "yes",
"CompressionLevel" : "9"}

config["bitbucket.org"] = {}
config["bitbucket.org"]["User"] = "hg"
config["topsecret.server.com"] = {}
topsecret = config["topsecret.server.com"]
topsecret["Host Port"] = "50022"
topsecret["ForwardXll"] = "no"
config["DEFAULT"]["ForwardXll"] = "yes"
with open("example.ini","w") as configfile:
config.write(configfile)
hashlib哈希模塊:

hashlib的特徵以及使用要點:

一、bytes類型數據 ---> 經過hashlib算法 ---> 固定長度的字符串

二、不一樣的bytes類型數據轉化成的結果必定不一樣。

三、相同的bytes類型數據轉化成的結果必定相同。

四、此轉化過程不可逆。

hashlib模塊就至關於一個算法的集合,這裏麪包含着不少的算法,算法越高,轉化成的結果越複雜,安全程度越高,相應的效率就會越低。

普通加密:

咱們以常見的摘要算法MD5爲例,計算出一個字符串的MD5值:

import hashlib

md5 = hashlib.md5()

md5.update('123456'.encode('utf-8')) # 必須是bytes類型纔可以進行加密

print(md5.hexdigest())

# 計算結果以下:

'e10adc3949ba59abbe56e057f20f883e'

# 驗證:相同的bytes數據轉化的結果必定相同

import hashlib

md5 = hashlib.md5()

md5.update('123456'.encode('utf-8'))

print(md5.hexdigest())

# 計算結果以下:

'e10adc3949ba59abbe56e057f20f883e'

# 驗證:不相同的bytes數據轉化的結果必定不相同

import hashlib

md5 = hashlib.md5()

md5.update('12345'.encode('utf-8'))

print(md5.hexdigest())

# 計算結果以下:

'827ccb0eea8a706c4c34a16891f84e7b'

固定加鹽:

ret = hashlib.md5('xx教育'.encode('utf-8')) # xx教育就是固定的鹽

ret.update('a'.encode('utf-8'))

print(ret.hexdigest())

結果:d9e8fff14a026ecefa7d700334279762

動態加鹽:

username = '寶元666'

ret = hashlib.md5(username[::2].encode('utf-8')) # 針對於每一個帳戶,每一個帳戶的鹽都不同

ret.update('a'.encode('utf-8'))

print(ret.hexdigest())

sha系列:sha1,sha224,sha512等等,數字越大,加密的方法越複雜,安全性越高,可是效率就會越慢。

ret = hashlib.sha1()

ret.update('guobaoyuan'.encode('utf-8'))

print(ret.hexdigest())

#也可加鹽

ret = hashlib.sha384(b'asfdsa')

ret.update('guobaoyuan'.encode('utf-8'))

print(ret.hexdigest())

# 也能夠加動態的鹽

ret = hashlib.sha384(b'asfdsa'[::2])

ret.update('guobaoyuan'.encode('utf-8'))

print(ret.hexdigest())

文件的一致性校驗:

hashlib模塊除了能夠用於密碼加密以外,還有一個經常使用的功能,那就是文件的一致性校驗。linux講究:一切皆文件,咱們普通的文件,是文件,視頻,音頻,圖片,以及應用程序等都是文件。咱們都從網上下載過資源,好比咱們剛開學時讓你們從網上下載Python解釋器,當時你可能沒有注意過,其實你下載的時候都是帶一個MD5或者shax值的,爲何? 咱們的網絡世界是很不安全的,常常會遇到病毒,木馬等,有些你是看不到的可能就植入了你的電腦中,那麼他們是怎麼來的? 都是經過網絡傳入來的,就是你在網上下載一些資源的時候,趁虛而入,固然大部分被咱們的瀏覽器或者殺毒軟件攔截了,可是還有一部分偷偷的進入你的磁盤中了。那麼咱們本身如何驗證咱們下載的資源是否有病毒呢?這就須要文件的一致性校驗了。在咱們下載一個軟件時,每每都帶有一個MD5或者shax值,當咱們下載完成這個應用程序時你要是對比大小根本看不出什麼問題,你應該對比他們的md5值,若是兩個md5值相同,就證實這個應用程序是安全的,若是你下載的這個文件的MD5值與服務端給你提供的不一樣,那麼就證實你這個應用程序確定是植入病毒了(文件損壞的概率很低),那麼你就應該趕忙刪除,不該該安裝此應用程序。

咱們以前說過,md5計算的就是bytes類型的數據的轉換值,同一個bytes數據用一樣的加密方式轉化成的結果必定相同,若是不一樣的bytes數據(即便一個數據只是刪除了一個空格)那麼用一樣的加密方式轉化成的結果必定是不一樣的。因此,hashlib也是驗證文件一致性的重要工具。

校驗Pyhton解釋器的Md5值是否相同:

import hashlib
def file_check(file_path):
with open(file_path,mode='rb') as f1:
sha256 = hashlib.md5()
while 1:
content = f1.read(1024)
if content:
sha256.update(content)
else:
return sha256.hexdigest()
print(file_check('python-3.6.6-amd64.exe'))
socketserver模塊:

server類:處理連接包含:BaseServer、TcpServer、UdpServer、UnixStreamServer、UnixDatagramServer。
request類:處理通訊包含BaseRequestHandler、StreamRequestHandler、DatagramRequestHandler。
對於tcp來講
self.request=conn
對於udp來講
self.request=(client_data_bytes,udp的套接字對象)
collections(收藏)模塊:
在內置數據類型(dict、list、set、tuple)的基礎上,collections模塊還提供了幾個額外的數據類型:Counter、deque、defaultdict、namedtuple和OrderedDict以及判斷什麼是可迭代對象什麼是迭代器

1.namedtuple: 生成可使用名字來訪問元素內容的tuple

2.deque: 雙端隊列,能夠快速的從另一側追加和推出對象

3.Counter: 計數器,主要用來計數

4.OrderedDict: 有序字典

5.defaultdict: 帶有默認值的字典

namedtuple:

咱們知道tuple能夠表示不變數據,例如,一個點的二維座標就能夠表示成:



可是,看到(1, 2),很難看出這個tuple是用來表示一個座標的。
這時,namedtuple就派上了用場:p = (1, 2)
from collections import namedtuple
point = namedtuple("point",["x","y"])
p = point(1,2)
print(p)
結果:point(x=1, y=2)

deque:

使用list存儲數據時,按索引訪問元素很快,可是插入和刪除元素就很慢了,由於list是線性存儲,數據量大的時候,插入和刪除效率很低。 

deque是爲了高效實現插入和刪除操做的雙向列表,適合用於隊列和棧:

from collections import deque

q = deque(['a', 'b', 'c'])

q.append('x')

q.appendleft('y')

print(q)

 

結果:q deque(['y', 'a', 'b', 'c', 'x'])

deque除了實現list的append()和pop()外,還支持appendleft()和popleft(),這樣就能夠很是高效地往頭部添加或刪除元素。

OrderedDict:

使用dict時,Key是無序的。在對dict作迭代時,咱們沒法肯定Key的順序。

若是要保持Key的順序,能夠用OrderedDict:

from collections import OrderedDict
od = OrderedDict([("a",1),("b",2),("c",3)])
print(od)
結果:OrderedDict([('a', 1), ('b', 2), ('c', 3)])
OrderedDict的Key會按照插入的順序排列,不是Key自己排序:
from collections import OrderedDict
od = OrderedDict([("a",1),("b",2),("c",3)])
od["z"] = 1
od["y"] = 2
od["x"] = 3
print(od.keys())

結果:odict_keys(['a', 'b', 'c', 'z', 'y', 'x'])

defaultdict:

有以下值集合 [11,22,33,44,55,66,77,88,99,90...],將全部大於 66 的值保存至字典的第一個key中,將小於 66 的值保存至第二個key的值中。

即: {'k1': 大於66 , 'k2': 小於66}

from collections import defaultdict
values = [11,22,33,44,55,66,77,88,99,90]
my_dict = defaultdict(list)
for value in values:
if value > 66:
my_dict["k1"].append(value)
else:
my_dict["k2"].append(value)
print(my_dict)
結果:defaultdict(<class 'list'>, {'k2': [11, 22, 33, 44, 55, 66], 'k1': [77, 88, 99, 90]})

Counter:

Counter類的目的是用來跟蹤值出現的次數。它是一個無序的容器類型,以字典的鍵值對形式存儲,其中元素做爲key,其計數做爲value。計數值能夠是任意的Interger(包括0和負數)。Counter類和其餘語言的bags或multisets很類似。

from collections import Counter
c = Counter("dsadasdsfdafsdsfds")
print(c)
結果:Counter({'d': 6, 's': 6, 'a': 3, 'f': 3})

isinstance:

判斷當前數據類型,返回的是一個布爾值

from collections import Iterable,Iterator lst = [1,2,3,4] print(isinstance(lst,list)) # 判斷lst是否是列表類型 返回的是True print(isinstance(lst,Iterator)) # 判斷lst是否是迭代器 返回的是False print(isinstance(lst,Iterable)) # 判斷lst是否是可迭代對象 返回的是True
軟件開發規範:

你如今包括以前寫的一些程序,所謂的'項目',都是在一個py文件下完成的,代碼量撐死也就幾百行,你認爲沒問題,挺好。可是真正的後端開發的項目,系統等,少則幾萬行代碼,多則十幾萬,幾十萬行代碼,你全都放在一個py文件中行麼?固然你能夠說,只要能實現功能便可。我們舉個例子,若是你的衣物只有三四件,那麼你隨便堆在櫥櫃裏,沒問題,咋都能找到,也不顯得特別亂,可是若是你的衣物,有三四十件的時候,你在都堆在櫥櫃裏,可想而知,你找你穿過三天的襪子,最終從你的大衣口袋裏翻出來了,這是什麼感受和心情......

  軟件開發,規範你的項目目錄結構,代碼規範,遵循PEP8規範等等,讓你更加清晰滴,合理滴開發。

那麼接下來咱們以博客園系統的做業舉例,將咱們以前在一個py文件中的全部代碼,整合成規範的開發。

首先咱們看一下,這個是咱們以前的目錄結構(簡化版):

image-20190808184433407

py文件的具體代碼以下:

status_dic = { 'username': None, 'status': False, } flag = True def login(): i = 0 with open('register', encoding='utf-8') as f1: dic = {i.strip().split('|')[0]: i.strip().split('|')[1] for i in f1} while i < 3: username = input('請輸入用戶名:').strip() password = input('請輸入密碼:').strip() if username in dic and dic[username] == password: print('登陸成功') return True else: print('用戶名密碼錯誤,請從新登陸') i += 1 def register(): with open('register', encoding='utf-8') as f1: dic = {i.strip().split('|')[0]: i.strip().split('|')[1] for i in f1} while 1: print('\033[1;45m 歡迎來到註冊頁面 \033[0m') username = input('請輸入用戶名:').strip() if not username.isalnum(): print('\033[1;31;0m 用戶名有非法字符,請從新輸入 \033[0m') continue if username in dic: print('\033[1;31;0m 用戶名已經存在,請從新輸入 \033[0m') continue password = input('請輸入密碼:').strip() if 6 <= len(password) <= 14: with open('register', encoding='utf-8', mode='a') as f1: f1.write(f'\n{username}|{password}') status_dic['username'] = str(username) status_dic['status'] = True print('\033[1;32;0m 恭喜您,註冊成功!已幫您成功登陸~ \033[0m') return True else: print('\033[1;31;0m 密碼長度超出範圍,請從新輸入 \033[0m') def auth(func): def inner(*args, **kwargs): if status_dic['status']: ret = func(*args, **kwargs) return ret else: print('\033[1;31;0m 請先進行登陸 \033[0m') if login(): ret = func(*args, **kwargs) return ret return inner @auth def article(): print(f'\033[1;32;0m 歡迎{status_dic["username"]}訪問文章頁面\033[0m') @auth def diary(): print(f'\033[1;32;0m 歡迎{status_dic["username"]}訪問日記頁面\033[0m') @auth def comment(): print(f'\033[1;32;0m 歡迎{status_dic["username"]}訪問評論頁面\033[0m') @auth def enshrine(): print(f'\033[1;32;0m 歡迎{status_dic["username"]}訪問收藏頁面\033[0m') def login_out(): status_dic['username'] = None status_dic['status'] = False print('\033[1;32;0m 註銷成功 \033[0m') def exit_program(): global flag flag = False return flag choice_dict = { 1: login, 2: register, 3: article, 4: diary, 5: comment, 6: enshrine, 7: login_out, 8: exit_program, } while flag: print(''' 歡迎來到博客園首頁 1:請登陸 2:請註冊 3:文章頁面 4:日記頁面 5:評論頁面 6:收藏頁面 7:註銷 8:退出程序''') choice = input('請輸入您選擇的序號:').strip() if choice.isdigit(): choice = int(choice) if 0 < choice <= len(choice_dict): choice_dict[choice]() else: print('\033[1;31;0m 您輸入的超出範圍,請從新輸入 \033[0m') else: print('\033[1;31;0m 您您輸入的選項有非法字符,請從新輸入 \033[0m') 

此時咱們是將全部的代碼都寫到了一個py文件中,若是代碼量多且都在一個py文件中,那麼對於代碼結構不清晰,不規範,運行起來效率也會很是低。因此咱們接下來一步一步的修改:

  1. 程序配置.

image-20190808183553328

你項目中全部的有關文件的操做出現幾處,都是直接寫的register相對路徑,若是說這個register註冊表路徑改變了,或者你改變了register註冊表的名稱,那麼相應的這幾處都須要一一更改,這樣其實你就是把代碼寫死了,那麼怎麼解決? 我要統一相同的路徑,也就是統一相同的變量,在文件的最上面寫一個變量指向register註冊表的路徑,代碼中若是須要這個路徑時,直接引用便可。

image-20190808183612322

  1. 劃分文件

image-20190808183637363

一個項目的函數不能只是這些,咱們只是舉個例子,這個小做業函數都已經這麼多了,那麼要是一個具體的實際的項目,函數會很是多,因此咱們應該將這些函數進行分類,而後分文件而治。在這裏我劃分瞭如下幾個文件:

settings.py: 配置文件,就是放置一些項目中須要的靜態參數,好比文件路徑,數據庫配置,軟件的默認設置等等

相似於咱們做業中的這個:

image-20190808183653259

common.py:公共組件文件,這裏面放置一些咱們經常使用的公共組件函數,並非咱們核心邏輯的函數,而更像是服務於整個程序中的公用的插件,程序中須要即調用。好比咱們程序中的裝飾器auth,有些函數是須要這個裝飾器認證的,可是有一些是不須要這個裝飾器認證的,它既是何處須要何處調用便可。好比還有密碼加密功能,序列化功能,日誌功能等這些功能均可以放在這裏。

image-20190808183706876

src.py:這個文件主要存放的就是核心邏輯功能,你看你須要進行選擇的這些核心功能函數,都應該放在這個文件中。

image-20190808183722810

start.py:項目啓動文件。你的項目須要有專門的文件啓動,而不是在你的核心邏輯部分進行啓動的,有人對這個可能不太理解,我爲何還要設置一個單獨的啓動文件呢?你看你生活中使用的全部電器基本都一個單獨的啓動按鈕,汽車,熱水器,電視,等等等等,那麼爲何他們會單獨設置一個啓動按鈕,而不是在一堆線路板或者內部隨便找一個地方開啓呢? 目的就是放在顯眼的位置,方便開啓。你想一想你的項目這麼多py文件,若是src文件也有不少,那麼到底哪一個文件啓動整個項目,你還得一個一個去尋找,太麻煩了,這樣我把它單獨拿出來,就是方便開啓整個項目。

那麼咱們寫的項目開啓整個項目的代碼就是下面這段:

image-20190808183736591

你把這些放置到一個文件中也能夠,可是沒有必要,咱們只須要一個命令或者一個開啓指令就行,就比如咱們開啓電視只須要讓人很快的找到那個按鈕便可,對於按鈕後面的一些複雜的線路板,咱們並不關心,因此咱們要將上面這個段代碼整合成一個函數,開啓項目的''按鈕''就是此函數的執行便可。

image-20190808183749056

這個按鈕要放到啓動文件start.py裏面。

除了以上這幾個py文件以外還有幾個文件,也是很是重要的:

相似於register文件:這個文件文件名不固定,register只是咱們項目中用到的註冊表,可是這種文件就是存儲數據的文件,相似於文本數據庫,那麼咱們一些項目中的數據有的是從數據庫中獲取的,有些數據就是這種文本數據庫中獲取的,總之,你的項目中有時會遇到將一些數據存儲在文件中,與程序交互的狀況,因此咱們要單獨設置這樣的文件。

log文件:log文件顧名思義就是存儲log日誌的文件。日誌咱們一會就會講到,日誌主要是供開發人員使用。好比你項目中出現一些bug問題,好比開發人員對服務器作的一些操做都會記錄到日誌中,以便開發者瀏覽,查詢。

至此,咱們將這個做業原來的兩個文件,合理的劃分紅了6個文件,可是仍是有問題的,若是咱們的項目很大,你的每個部分相應的你一個文件存不下的,好比你的src主邏輯文件,函數不少,你是否是得分紅:src1.py src2.py?

你的文本數據庫register這個只是一個註冊表,若是你還有我的信息表,記錄表呢? 若是是這樣,你的整個項目也是很是凌亂的:

image-20190808183851177

3. 劃分具體目錄

上面看着就很是亂了,那麼如何整改呢? 其實很是簡單,原來你就是30件衣服放在一個衣櫃裏,那麼你就得分類裝,放外套的地方,放內衣的地方,放佩飾的地方等等,可是忽然你的衣服編程300件了,那一個衣櫃放不下,我就整多個櫃子,分別放置不一樣的衣物。因此咱們這能夠整多個文件夾,分別管理不一樣的物品,那麼標準版本的目錄結構就來了:

爲何要設計項目目錄結構?

"設計項目目錄結構",就和"代碼編碼風格"同樣,屬於我的風格問題。對於這種風格上的規範,一直都存在兩種態度:

  1. 一類同窗認爲,這種我的風格問題"可有可無"。理由是能讓程序work就好,風格問題根本不是問題。
  2. 另外一類同窗認爲,規範化能更好的控制程序結構,讓程序具備更高的可讀性。

我是比較偏向於後者的,由於我是前一類同窗思想行爲下的直接受害者。我曾經維護過一個很是很差讀的項目,其實現的邏輯並不複雜,可是卻耗費了我很是長的時間去理解它想表達的意思。今後我我的對於提升項目可讀性、可維護性的要求就很高了。"項目目錄結構"其實也是屬於"可讀性和可維護性"的範疇,咱們設計一個層次清晰的目錄結構,就是爲了達到如下兩點:

  1. 可讀性高: 不熟悉這個項目的代碼的人,一眼就能看懂目錄結構,知道程序啓動腳本是哪一個,測試目錄在哪兒,配置文件在哪兒等等。從而很是快速的瞭解這個項目。
  2. 可維護性高: 定義好組織規則後,維護者就能很明確地知道,新增的哪一個文件和代碼應該放在什麼目錄之下。這個好處是,隨着時間的推移,代碼/配置的規模增長,項目結構不會混亂,仍然可以組織良好。

因此,我認爲,保持一個層次清晰的目錄結構是有必要的。更況且組織一個良好的工程目錄,實際上是一件很簡單的事兒。

image-20190808183906562

上面那個圖片就是較好的目錄結構。

二. 按照項目目錄結構,規範博客園系統

接下來,我就帶領你們把具體的代碼寫入對應的文件中,而且將此項目啓動起來,必定要跟着個人步驟一步一步去執行:

  1. 配置start.py文件

咱們首先要配置啓動文件,啓動文件很簡答就是將項目的啓動執行放置start.py文件中,運行start.py文件能夠成功啓動項目便可。 那麼項目的啓動就是這個指令run() 咱們把這個run()放置此文件中不就好了?

image-20190808184513416

這樣你能執行這個項目麼?確定是不能夠呀,你的starts.py根本就找不到run這個變量,確定是會報錯的。

NameError: name 'run' is not defined 本文件確定是找不到run這個變量也就是函數名的,不過這個難不倒咱們,咱們剛學了模塊, 另個一文件的內容咱們能夠引用過來。可是你發現import run 或者 from src import run 都是報錯的。爲何呢? 騷年,遇到報錯不要慌!咱們說過你的模塊之因此能夠引用,那是由於你的模塊確定在這個三個地方:內存,內置,sys.path裏面,那麼core在內存中確定是沒有的,也不是內置,並且sys.path也不可能有,由於sys.path只會將你當前的目錄(bin)加載到內存,因此你剛纔那麼引用確定是有問題的,那麼如何解決?內存,內置你是左右不了的,你只能將core的路徑添加到sys.path中,這樣就能夠了。

import sys sys.path.append(r'D:\lnh.python\py project\teaching_show\blog\core') from src import run run() 

這樣雖然解決了,可是你不以爲有問題麼?你如今從這個start文件須要引用src文件,那麼你須要手動的將src的工做目錄添加到sys.path中,那麼有沒有可能你會引用到其餘的文件?好比你的項目中可能須要引用conf,lib等其餘py文件,那麼在每次引用以前,或者是開啓項目時,所有把他們添加到sys.path中麼?

sys.path.append(r'D:\lnh.python\py project\teaching_show\blog\core') sys.path.append(r'D:\lnh.python\py project\teaching_show\blog\conf') sys.path.append(r'D:\lnh.python\py project\teaching_show\blog\db') sys.path.append(r'D:\lnh.python\py project\teaching_show\blog\lib') 

這樣是否是太麻煩了? 咱們應該怎麼作?咱們應該把項目的工做路徑添加到sys.path中,用一個例子說明:你想找張三,李四,王五,趙六等人,這些人所有都在一棟樓好比在匯德商廈,那麼我就告訴你匯德商廈的位置:北京昌平區沙河鎮匯德商廈。 你到了匯德商廈你在找具體這些人就能夠了。因此咱們只要將這個blog項目的工做目錄添加到sys.path中,這樣不管這個項目中的任意一個文件引用項目中哪一個文件,就均可以找到了。因此:

import sys
sys.path.append(r'D:\lnh.python\py project\teaching_show\blog')
from core.src import run
run()

上面仍是差一點點,你這樣寫你的blog的路徑就寫死了,你的項目不可能只在你的電腦上,項目是共同開發的,你的項目確定會出如今別人電腦上,那麼你的路徑就是問題了,在你的電腦上你的blog項目的路徑是上面所寫的,若是移植到別人電腦上,他的路徑不可能與你的路徑相同, 這樣就會報錯了,因此咱們這個路徑要動態獲取,不能寫死,因此這樣就解決了:

import sys import os # sys.path.append(r'D:\lnh.python\py project\teaching_show\blog') print(os.path.dirname(__file__)) # 獲取本文件的絕對路徑 # D:/lnh.python/py project/teaching_show/blog/bin print(os.path.dirname(os.path.dirname(__file__))) # 獲取父級目錄也就是blog的絕對路徑 # D:/lnh.python/py project/teaching_show/blog BATH_DIR = os.path.dirname(os.path.dirname(__file__)) sys.path.append(BATH_DIR) from core.src import run run() 

那麼還差一個小問題,這個starts文件能夠當作腳本文件進行直接啓動,若是是做爲模塊,被別人引用的話,按照這麼寫,也是能夠啓動整個程序的,這樣合理麼?這樣是不合理的,做爲啓動文件,是不能夠被別人引用啓動的,因此咱們此時要想到 __name__了:

import sys import os # sys.path.append(r'D:\lnh.python\py project\teaching_show\blog') # print(os.path.dirname(__file__)) # 獲取本文件的絕對路徑 # D:/lnh.python/py project/teaching_show/blog/bin # print(os.path.dirname(os.path.dirname(__file__))) # 獲取父級目錄也就是blog的絕對路徑 # D:/lnh.python/py project/teaching_show/blog BATH_DIR = os.path.dirname(os.path.dirname(__file__)) sys.path.append(BATH_DIR) from core.src import run if __name__ == '__main__': run() 

這樣,咱們的starts啓動文件就已經配置成功了。之後只要咱們經過starts文件啓動整個程序,它會先將整個項目的工做目錄添加到sys.path中,而後在啓動程序,這樣我整個項目裏面的任何的py文件想引用項目中的其餘py文件,都是你能夠的了。

  1. 配置settings.py文件。

接下來,咱們就會將咱們項目中的靜態路徑,數據庫的鏈接設置等等文件放置在settings文件中。

咱們看一下,你的主邏輯src中有這樣幾個變量:

status_dic = { 'username': None, 'status': False, } flag = True register_path = r'D:\lnh.python\py project\teaching_show\blog\register' 

咱們是否是應該把這幾個變量都放置在settings文件中呢?不是!setttings文件叫作配置文件,其實也叫作配置靜態文件,什麼叫靜態? 靜態就是通常不會輕易改變的,可是對於上面的代碼status_dic ,flag這兩個變量,因爲在使用這個系統時會時長變化,因此不建議將這個兩個變量放置在settings配置文件中,只須要將register_path放置進去就能夠。

register_path = r'D:\lnh.python\py project\teaching_show\blog\register' 

image-20190808185147957

可是你將這個變量放置在settings.py以後,你的程序啓動起來是有問題,爲何?

with open(register_path, encoding='utf-8') as f1: NameError: name 'register_path' is not defined 

由於主邏輯src中找不到register_path這個路徑了,因此會報錯,那麼咱們解決方式就是在src主邏輯中引用settings.py文件中的register_path就能夠了。

image-20190808185220737

這裏引起一個問題:爲何你這樣寫就能夠直接引用settings文件呢?咱們在starts文件中已經說了,剛已啓動blog文件時,咱們手動將blog的路徑添加到sys.path中了,這就意味着,我在整個項目中的任何py文件,均可以引用到blog項目目錄下面的任何目錄:bin,conf,core,db,lib,log這幾個,因此,剛纔咱們引用settings文件纔是能夠的。

  1. 配置common.py文件

接下來,咱們要配置咱們的公共組件文件,在咱們這個項目中,裝飾器就是公共組件的工具,咱們要把裝飾器這個工具配置到common.py文件中。先把裝飾器代碼剪切到common.py文件中。這樣直接粘過來,是有各類問題的:

image-20190808185244851

因此咱們要在common.py文件中引入src文件的這兩個變量。

image-20190808185313895

但是你的src文件中使用了auth裝飾器,此時你的auth裝飾器已經移動位置了,因此你要在src文件中引用auth裝飾器,這樣纔可使用上

image-20190808185333682

image-20190808185348147

OK,這樣你就算是將你以前寫的模擬博客園登陸的做業按照規範化目錄結構合理的完善完成了,最後還有一個關於README文檔的書寫。

關於README的內容

這個我以爲是每一個項目都應該有的一個文件,目的是能簡要描述該項目的信息,讓讀者快速瞭解這個項目。

它須要說明如下幾個事項:

  1. 軟件定位,軟件的基本功能。
  2. 運行代碼的方法: 安裝環境、啓動命令等。
  3. 簡要的使用說明。
  4. 代碼目錄結構說明,更詳細點能夠說明軟件的基本原理。
  5. 常見問題說明。

我以爲有以上幾點是比較好的一個README。在軟件開發初期,因爲開發過程當中以上內容可能不明確或者發生變化,並非必定要在一開始就將全部信息都補全。可是在項目完結的時候,是須要撰寫這樣的一個文檔的。

能夠參考Redis源碼中Readme的寫法,這裏面簡潔可是清晰的描述了Redis功能和源碼結構。

做業題:

# 1.使用軟件開發規範的方式實現一下模擬博客園登陸# a.註冊時須要對密碼進行加密# b.登陸時須要加密而後校驗"""2.使用hashlib和json從新實現三次登陸鎖定a.註冊時須要對密碼進行加密b.將錯誤用戶帳號和錯誤次數編寫成以下結構,存儲到錯誤文件中{"alex":2}{"meet":3}"""import hashlibimport jsonlogin_dic = {    "count":3}file_path = "userinfo.txt"error_path = "error_user.txt"def my_md5(user,pwd):    md5 = hashlib.md5(user.encode("utf-8"))    md5.update(pwd.encode("utf-8"))    pwd = md5.hexdigest()    return pwddef auth(user,pwd):    with open(file_path, "a+", encoding="utf-8")as ff:        ff.seek(0)        pwd = my_md5(user, pwd)        for em in ff:            file_user, file_pwd = em.strip().split(":")            # pwd = my_md5(user, pwd)      # 錯誤問題:同名            # print(file_user,file_pwd,user,pwd)            if file_user == user and file_pwd == pwd:                print(f"歡迎{user}登陸!")                login_dic['count'] = 0                return        else:            login_dic['count'] -= 1            if user in error_dic:                error_dic[user] += 1            else:                error_dic[user] = 1            f = open(error_path, 'w', encoding="utf-8")            f.write(json.dumps(error_dic))            print(f"用戶密碼錯誤,剩餘次數:{login_dic['count']}")def register(user,pwd):    """    註冊    :param user:    :param pwd:    :return:    """    with open(file_path,"a+",encoding="utf-8")as f:        f.seek(0)        for i in f:            file_user,file_pwd = i.split(":") # ['alex',"alex1234"]            if user == file_user:                print("用戶名已存在!")                return        else:            pwd = my_md5(user,pwd)            print(pwd)            f.write(f"{user}:{pwd}\n")            print("註冊成功!")error_dic = {} # {"alex":2,"meet":3}def login(user,pwd):    with open(error_path,"a+",encoding="utf-8")as f1:        f1.seek(0)        for i in f1:            error_dic.update(json.loads(i))        print(error_dic)        if user in error_dic:            if error_dic[user] >= 3:                print(f"{user}用戶鎖定!")                login_dic['count'] = 0            else:                auth(user,pwd)        else:            auth(user,pwd)msg = """1.登陸2.註冊"""func_dic = {   "2":register,   "1":login}while login_dic['count']:    choose = input(msg)    if choose in func_dic:        user = input("username:")        pwd = input("password:")        func_dic[choose](user, pwd)    else:        print("輸入有誤!")# 22e02a465ca7e6f8e93db22ebb78f096
相關文章
相關標籤/搜索