詳解Python變量與注釋高級用法
Python變量與注釋高級用法
1.概述
好的變量和注釋并非為計算機而寫，而是為每個閱讀代碼的人而寫。變量與注釋是表達作者思想的基礎(chǔ)，他們對代碼質(zhì)量的貢獻母庸質(zhì)疑。
2.變量
2.1.變量解包
1.什么是變量解包
把一個可迭代對象的所有成員，一次性的賦值給多個變量的過程就是變量解包。
2.變量解包語法
# 變量解包
username = ['zhangsan', '18']
name, age = username
print('name:{}, age:{} '.format(name, age))
# 嵌套類型變量解包
username = [1, ['zhangsan', 18]]
number, (name, age) = username
print('number:{}, name:{}, age:{}'.format(number, name, age))
# 匹配模式解包
data = ['zhangsan', 'banana', 'apple', 'orange', 18]
name, *fruits, score = data
print('name:{}, fruits:{}, score:{}'.format(name, fruits, score))
# 切片解包
data = ['zhangsan', 'banana', 'apple', 'orange', 18]
name, fruits, score = data[0], data[1:-1], data[-1]
print('name:{}, fruits:{}, score:{}'.format(name, fruits, score))
# 變量解包用到for循環(huán)
for name, age in [('zhangsan', 15), ('lisi', 18)]:
print('name:{}, age:{}'.format(name, age))
# 單下劃線變量名
username = ['zhangsan', 19]
name, _ = username
print(name, _)
2.2.給變量注明類型
1.變量注明類型介紹
python給變量注明類型，與java變量類型不同，python的變量類型只是一種提示功能，不提供任何校驗功能。
因此傳入的變量類型與校驗類型不一致也不會報錯。
變量注明類型語法非常簡單，在變量名稱后面用冒號分隔表名類型即可。
2.變量注明類型示例
# list表示參數(shù)為列表類型，int表示里面的成員是整形
def remove_invalid(item: list[int]):
print(item)
# 傳入符合變量類型參數(shù)
remove_invalid([1, 2, 3])
# 傳入不符合變量類型參數(shù)，不影響函數(shù)執(zhí)行結(jié)果。
remove_invalid(1)
# 類型注解使用demo
class Duck:
def __init__(self, color:str):
self.color = color
# 為quack方法注明返回值類型為None
def quack(self) -> None:
print(f"Hi, I'm a {self.color} duck")
# -> List[Duck]：用typing模塊的List對象為函數(shù)返回值標(biāo)注具體類型
def create_random_ducks(number:int) -> List[Duck]:
# 為變量加上類型聲明
ducks: List[Duck] = []
for _ in number:
color = random.choice(['yellow', 'white', 'gray'])
ducks.append(Duck(color=color))
return ducks
ducks = create_random_ducks((1,2,3))
for duck in ducks:
duck.quack()2.3.變量命名原則
給變量起名主要有兩種流派：一是通過大小寫界定單詞的駝峰命名，例如Java語言。二是通過下劃線連接的蛇形命名，例如python語言。
- 遵循PEP8原則
- 描述性要強
- 長度盡量短
- 變量注明類型
- 超短命名
1.遵循PEP8原則
PEP8原名《Python Enhacement Proposal #8》譯為《8 號 Python 增強規(guī)范》為代碼編寫風(fēng)格提供了指南，變量命名部分規(guī)范如下。
- 普通變量，使用蛇形命名法，比如max_value
- 常量，采用全部大寫字母，使用下劃線連接，比如 MAX_VALUE
- 僅內(nèi)部使用變量，在變量前增加下劃線前綴，比如 _local_var
- 變量名稱與python關(guān)鍵字沖突時，在變量末尾追加下劃線，比如 class_
2.描述性要強
寫作過程中一項重要的工作就是為句子斟酌恰當(dāng)?shù)脑~語，不同的詞語描述性的強弱是不同的。比如”冬天傲骨的梅花“ 就比 ”花“ 描述性要強。為變量命名和詞語一樣，同樣有描述性強弱之分。
下面是描述性強弱不同的變量，對比可以感受到描述性強的變量名稱使代碼更易讀。
# 描述性弱的變量名稱:看不出它在描述什么 vlaue = process(s.strip()) # 描述性強的變量名稱：從用戶輸入?yún)?shù)中解析出用戶名稱，并剔除參數(shù)中的空格。 username = extract_username(input_string.strip())
3.長度盡量短
假如一個特別長的重復(fù)出現(xiàn)，讀者不會覺得它精確，反而是啰嗦難讀。在保證描述性清晰前提下，盡量讓名字簡短易讀，通?？刂圃?個單詞內(nèi)。
4.變量注明類型
雖然python的變量不需要聲明類型，但是為了提升可讀性，我們可以為變量注明類型。
除了為變量注明類型外，還有約定俗稱的變量名稱與類型建立匹配關(guān)系，下面是一些變量名稱和類型匹配的例子。
| 變量名 | 含義 | 說明 |
|---|---|---|
| is_superuser | 是否是超級用戶 | is 表示是或不是 |
| has_errors | 有沒有錯 | hans 表示有或沒有 |
| allow_empty | 是否允許空值 | allow表示是否允許 |
5.超短命令
在變量命名中有一類名稱比較特別，只有一兩個字母，通常他們分為兩類，一類是大家約定俗稱的短名字，另一類是起別名。
約定俗稱常用名稱
- 數(shù)組索引三劍客 i、j、k
- 某個整數(shù) n
- 某個字符串 s
- 某個異常 e
- 文件對象 fp
長名稱起別名
is_not_normal as l
3.注釋
注釋不會影響代碼的行為，它會影響代碼的可讀性。
3.1.注釋類型
python的注釋分為兩種，一種是代碼內(nèi)注釋，一種是函數(shù)、類的注釋也稱為接口注釋。
行內(nèi)注釋
# 使用strip()去掉空格的好處： # 1.數(shù)據(jù)庫保存數(shù)據(jù)時占用空間更小 # 2.不必因為用戶多打了空格而要求用戶重新輸入。 username = extract_username(input_string.strip())
接口注釋
class Person: # 使用三個單引號或三個雙引號就是接口注釋。 '''人 ：param name: 姓名 : param age: 年齡 : param favrite_color: 最喜歡的顏色 ''' def __init__(self, name, age, favrite_color): self.name = name self.age = age self.favrite_color = color
3.2.錯誤使用注釋案例
1.用注釋屏蔽代碼
在編程中會用注釋屏蔽代碼，如果這些代碼不需要了可以直接刪掉，如果需要用到這些代碼可以從Git倉庫中找到。臨時注釋掉的大段代碼，對于閱讀代碼的人來說是一種干擾，沒有任何意義。
2.用注釋復(fù)述代碼
# 調(diào)用strip()去掉空格 input_string = input_string.strip()
上面這樣的注釋完全是冗余的，因為讀者從代碼本身就能讀到注釋里的信息。好的注釋應(yīng)該是這樣
# 如果將帶有空格的參數(shù)傳遞到后端處理，可能會造成服務(wù)奔潰 # 因此使用strip()去掉收尾空格 input_string = input_string.strip()
注釋作為代碼之外的說明性文字，應(yīng)該盡量提供那些讀者無法從代碼里讀出的信息，描述代碼為什么要這么做，而不是簡單復(fù)述代碼本身。
除了為什么的解釋性注釋外，還有一種注釋也很常見：指引性注釋
這種注釋不復(fù)述代碼，而是簡明扼要概括代碼功能，起到”代碼導(dǎo)讀“作用。
指引性注釋并不提供代碼里讀不到東西——假如沒有注釋，耐心讀完所有代碼也能知道代碼做了什么。指引性注釋就是降低代碼認知的成本，讓我們更容易理解代碼的意圖。
指引性注釋示例
# 初始化訪問服務(wù)的client對象 token = token_service.get_token() service_client = ServiceClient(token = token) service_client.ready()
3.弄錯接口注釋的受眾
到此這篇關(guān)于Python變量與注釋高級用法的文章就介紹到這了,更多相關(guān)Python變量與注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了解決keras加入lambda層時shape的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-06-06
這篇文章主要介紹了如何在Python中實現(xiàn)goto語句的方法，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-05-05
在Python編程中運算符是用于執(zhí)行各種操作的特殊符號或關(guān)鍵字,下面這篇文章主要給大家介紹了關(guān)于Python中8種運算符介紹以及示例的相關(guān)資料,文中通過圖文介紹的非常詳細,需要的朋友可以參考下2024-02-02
今天小編就為大家分享一篇python:print格式化輸出到文件的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-05-05
python實現(xiàn)簡單神經(jīng)網(wǎng)絡(luò)算法
這篇文章主要為大家詳細介紹了python實現(xiàn)簡單神經(jīng)網(wǎng)絡(luò)算法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-03-03
使用OpenCV進行指紋識別涵蓋特征提取與匹配,通過SIFT和FLANN實現(xiàn)匹配點計算,進而識別指紋ID和姓名,盡管OpenCV具備強大的圖像處理功能,指紋識別依舊面臨挑戰(zhàn),需要的朋友可以參考下2024-10-10
python從內(nèi)存地址上加載python對象過程詳解
這篇文章主要介紹了python從內(nèi)存地址上加載pythn對象過程詳解,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-01-01
Jupyter Notebook是基于網(wǎng)頁的用于交互計算的應(yīng)用程序,Jupyter notebook,作為Python廣受歡迎的一款I(lǐng)DLE,其直觀性、簡易性、易于閱讀等優(yōu)點廣受許多Python用戶所推薦,這篇文章介紹Jupyter中markdown的操作,感興趣的朋友一起看看吧2024-01-01
這篇文章主要介紹了運行python腳本更改Windows背景，使用常用的命令更改桌面背景，以更改ctype中的系統(tǒng)參數(shù)，下面來看看具體得更改過程吧2022-01-01
裝飾器是一個返回函數(shù)的函數(shù)。寫一個裝飾器，除了最常見的在函數(shù)中定義函數(shù)以外，Python還允許使用類來定義一個裝飾器。這篇文章給大家分享Python 使用類寫裝飾器的小技巧，一起看看吧2018-09-09