主頁 > 軟體設計 > 如何寫出更具有Python風格的代碼

如何寫出更具有Python風格的代碼

2020-11-15 10:16:49 軟體設計

我們都喜歡 Python,因為它讓編程和理解變的更為簡單,但是一不小心,我們就會忽略規則,以非 Pythonic 方式撰寫一堆垃圾代碼,從而浪費 Python 這個出色的語言賦予我們的優雅,Python 的代碼風格是非常優雅、明確和簡單,在 Python 解釋器中執行 import this 你可以看到 Tim Peters 撰寫的 Python 之禪:

>>> import this
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

這里我找了目前最好的中文版本:

美 優于 丑

明確 優于 隱晦

簡單 優于 復雜

復雜 也好過 繁復

扁平 優于 嵌套

稀疏 優于 擁擠

可讀性很重要

固然代碼實用與否 比潔癖更重要,

我們以為的特例也往往沒有特殊到必須打破上述規則的程度

除非刻意地靜默,否則不要無故忽視例外

如果遇到模棱兩可的邏輯,請不要自作聰明地瞎猜,

應該提供一種,且最好只提供一種,一目了然的解決方案

當然這是沒法一蹴而就的,除非你是荷蘭人[1]

固然,立刻著手 好過 永遠不做,

然而,永遠不做 也好過 不審慎思考一擼袖子就莽著干

如果你的實作很難解釋,它就一定不是個好主意

即使你的實作簡單到爆,它也有可能是個好辦法

命名空間大法好,不搞不是地球人!

[1]:本文作者 Tim peters 解釋說這里的荷蘭人指的是 Python 的作者 Guido van Rossum.

以下是用 Python 撰寫更好的代碼的 8 種方法:

一、忘掉類 C 語言風格

如果需要列印串列中的所有元素及其索引,你想到的第一件事是:

for i in range(len(arr)):
    print(i, arr[i])

那么你仍然在撰寫 C 代碼,擺脫這一點,請牢記 Python 關鍵字 enumerate ,它索引串列/字串中的所有元素,并且支持設定索引的起始編號

>>> for index, item in enumerate(['a','b','c']): 
...     print(index, item)
... 
0 a
1 b
2 c
>>> for index, item in enumerate(['a','b','c'],1): #這里第二個引數可以設定起始編號
...     print(index,item)
... 
1 a
2 b
3 c

現在看起來更好了,而且更加 Pythonic,將串列轉換成字串呢?如果你這樣寫:

# The C way
string = ''
for i in arr:
    string += i

就是 C 風格,如果使用 Python 的關鍵字 join,不僅效率更高,而且更優雅:

# The Python way
string = ''.join(arr)

就像 join 一樣 ,Python 有很多神奇的關鍵字,因此請不要為語言作業,而是使用該語言為你作業,

二、牢記 PEP8

我不是要求你完全遵循 PEP8,而是要求遵循其中的大多數規則,何況現在有很多自動格式化的工具,足以讓你的代碼更加美觀,我們的 Python 之父也說過:閱讀代碼的頻率遠遠高于寫代碼的頻率,他是如此的正確!因此代碼的可讀性非常重要,

你是否對自己曾經寫過的代碼感到好奇?為什么這么寫,這句話為什么在這?好吧,PEP8 是大多數這類問題的答案,盡管代碼注釋是個好方法,但是代碼的風格也需要加以調整,比如變數 i , j , count 等即使第一次出現時寫了注釋,也不能保證后面你仍然記得住,這樣來看就浪費了寶貴的時間,

任何普通的程式員都可以撰寫計算機可以理解的代碼,只有好的程式員可以撰寫人類可以理解的代碼,

首選 CamelCase 作為類, UPPER_WITH_UNDERSCORES 作為常量,而 lower_with_underscores 作為變數,方法和模塊名稱,即使使用,也要避免使用單一名稱功能 lambda ,

三、善用推導式

常用的推導式有:串列推導式,集合推導式,字典推導式,先說下串列推導式,

串列推導式就是當我們需要基于一個已有的串列創建新的串列時,所使用的語法格式,串列推導式包含以下四個部分:

1、一個輸入序列(Input Sequence) 2、一個變數,代表著輸入序列的一個成員(Variable) 3、一個可選的判定運算式,表達這個變數滿足的條件(Optional Predicate ) 4、一個輸出序列,根據 2 和 3 生成一個輸出序列(Output Expression)

比如有個串列既有數字,又有字符,現在需要計算數字的平方,并將結果放在新的串列中,如果不用串列推導式,寫出的代碼就是這樣的:

# bad code
a_list = [1, ‘4’, 9, ‘a’, 0, 4]

squared_ints = []
for item in a_list:
    if type(item) == types.IntType:
        squared_ints.append(item**2)

如果使用串列推導式,只需要兩行代碼,非常的優雅:

a_list = [1, ‘4’, 9, ‘a’, 0, 4]
squared_ints = [ e**2 for e in a_list if type(e) == types.IntType ]

當然,如果你喜歡 map 和 filter,你還可以這樣做,當時這是不推薦的,因為可讀性不好:

map(lambda e: e**2, filter(lambda e: type(e) == types.IntType, a_list))

比如集合推導式的使用:

給定輸入

names = [ 'Bob', 'JOHN', 'alice', 'bob', 'ALICE', 'J', 'Bob' ]

希望得到:

{ 'Bob', 'John', 'Alice' }

那么集合推導式就是:

{ name[0].upper() + name[1:].lower() for name in names if len(name) > 1 }

再比如字典推導式:

mcase = {'a':10, 'b': 34, 'A': 7, 'Z':3}

mcase_frequency = { k.lower() : mcase.get(k.lower(), 0) + mcase.get(k.upper(), 0) for k in mcase.keys() }

# mcase_frequency == {'a': 17, 'z': 3, 'b': 34}

從上面可以看出,推導式風格的代碼是優雅的,人類易讀的,

四、你還在顯式的關閉檔案嗎?

如果你在寫代碼時仍然在顯式的關閉檔案,就像上圖中的 programmer,你在為編程語言作業,如果你學會了使用 with 背景關系管理器,那么你就是一個 Python programmer,讓編程語言為你作業:

with open('filename.txt', 'w') as filename:
    filename.write('Hello')

當程式退出 with 塊時,檔案會自動關閉,with 陳述句的語法格式:

with VAR as EXPR:
    BLOCK

相當于:

mgr = (EXPR)
exit = type(mgr).__exit__  # Not calling it yet
value = type(mgr).__enter__(mgr)
exc = True
try:
    try:
        VAR = value  # Only if "as VAR" is present
        BLOCK
    except:
        # The exceptional case is handled here
        exc = False
        if not exit(mgr, *sys.exc_info()):
            raise
        # The exception is swallowed if exit() returns true
finally:
    # The normal and non-local-goto cases are handled here
    if exc:
        exit(mgr, None, None, None)

有很多網路連接、資料庫連接庫都會提供 with 功能,甚至熟悉了 with 的實作機制后,可以自行實作 with 功能:

class File(object):
    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)
    def __enter__(self):
        return self.file_obj
    def __exit__(self, type, value, traceback):
        self.file_obj.close()

只要定義了 __enter__,__exit__方法,就可以使用 with 陳述句:

with File('demo.txt', 'w') as opened_file:
    opened_file.write('Hola!')

五、使用迭代器和生成器

迭代器:iterator 生成器:generator

迭代器和生成器都是 Python 中功能強大的工具,值得精通,迭代器是一個更籠統的概念:任何一個物件只要它所屬的類具有__next__方法(Python 2是next)和具有回傳 self 的__iter__方法都是迭代器,

每個生成器都是一個迭代器,但反之不然,生成器是通過呼叫具有一個或多個 yield 運算式的函式而構建的,并且該函式是滿足上一段對iterator 的定義的物件,

使用區別:

網路上很多技術博主都說生成器是懶人版的迭代器,比迭代器更節省記憶體,其實是錯誤的,他們都很節省記憶體(我會舉例子),

他們真正的區別是:當你需要一個具有某些復雜的狀態維護行為的類,或者想要公開除__next__(和__iter____init__)之外的其他方法時,你就需要自定義迭代器,而不是生成器,

通常,一個生成器(有時,對于足夠簡單的需求,一個生成器運算式)就足夠了,并且它更容易撰寫代碼,

比如說計算正整數 a 到 b (b 遠遠大于 a)直接的平方,生成器的話就是:

def squares(start, stop):
    for i in range(start, stop):
        yield i * i

generator = squares(a, b)

或者:

generator = (i*i for i in range(a, b))

如果是迭代器,則是這樣:

class Squares(object):
    def __init__(self, start, stop):
       self.start = start
       self.stop = stop
    def __iter__(self): return self
    def __next__(self): # next in Python 2
       if self.start >= self.stop:
           raise StopIteration
       current = self.start * self.start
       self.start += 1
       return current

iterator = Squares(a, b)

可以看出,迭代器寫起來稍麻煩,當也更為靈活,比如你想提供一個 current 方法時,可以直接添加到 Squares 類中:

    def current(self):
       return self.start

從上述可以看出,迭代器并沒有保存 a 到 b 之間的所有值,所有并不消耗過多的記憶體,這一點也可以自行測驗,代碼如下:

>>> from collections.abc import Iterator
>>> from sys import getsizeof
>>> a = [i for i in range(1001)]
>>> print(type(a))
<class 'list'>
>>> print(getsizeof(a))
9016
>>>
>>> b = iter(a)
>>> print(type(b))
<class 'list_iterator'>
>>> print(isinstance(b,Iterator))
True
>>> print(getsizeof(b))
48
>>> c = (i for i in range(1001))
>>> print(getsizeof(b))
48
>>> type(c)
<class 'generator'>
>>> type(b)
<class 'list_iterator'>

可以看出 b 是 iterator,c 是 generator,它們占用的記憶體大小是一樣的,

六、善用 itertools

itertools 模塊標準化了一個快速、高效利用記憶體的核心工具集,這些工具本身或組合都很有用,它們一起形成了“迭代器代數”,這使得在純 Python 中有可以創建簡潔又高效的專用工具,比如,如果你想要字串中所有字符的組合或串列中數字的所有組合,則只需撰寫

from itertools import combinations
names = 'ABC'
for combination in combinations(names, 2):
    print(combination)
''' Output -
    ('A', 'B')
    ('A', 'C')
    ('B', 'C')
'''

這是一個值得經常使用的標準庫,更多詳細功能請參考官方檔案:https://docs.python.org/zh-cn/3/library/itertools.html[1]

七、善用 collections

這又是一個值得使用的標準庫 collections,它提供替代內置的資料型別的多個容器,如 defaultdict、OrderedDict、namedtuple、Counter、deque 等,非常使用,而且比自己實作要安全穩定的多,比如:

# frequency of all characters in a string in sorted order
from collections import (OrderedDict, Counter)
string = 'abcbcaaba'
freq = Counter(string)
freq_sorted = OrderedDict(freq.most_common())
for key, val in freq_sorted.items():
    print(key, val)
''' Output -
    ('a', 4)
    ('b', 3)
    ('c', 2)
'''

不多說了,看官方檔案:https://docs.python.org/3/library/collections.html[2]

八、不要過度使用類

不要過度使用類,堅持用 Java 和 C ++ 的程式員會經常使用類,但是在使用 Python 時,可以在函式和模塊的幫助下復用代碼,除非絕對需要,否則不必創建類,

本文講述類 8 個讓你寫出更好 Python 代碼的方法,希望對你有所幫助,

推薦閱讀:

10個技巧讓你的代碼更優雅

6 個值得玩味的 Python 代碼

參考資料

[1]

https://docs.python.org/zh-cn/3/library/itertools.html: https://docs.python.org/zh-cn/3/library/itertools.html

[2]

https://docs.python.org/3/library/collections.html: https://docs.python.org/3/library/collections.html

轉載請註明出處,本文鏈接:https://www.uj5u.com/ruanti/217017.html

標籤:其他

上一篇:Python 實作文字聊天室

下一篇:線性判別函式(Python實作批感知器演算法、Ho Kashyap演算法和MSE多類擴展方法)——模式識別編程作業

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 面試突擊第一季,第二季,第三季

    第一季必考 https://www.bilibili.com/video/BV1FE411y79Y?from=search&seid=15921726601957489746 第二季分布式 https://www.bilibili.com/video/BV13f4y127ee/?spm_id_fro ......

    uj5u.com 2020-09-10 05:35:24 more
  • 第三單元作業總結

    1.前言 這應該是本學期最后一次寫作業總結了吧。總體來說,對作業的節奏也差不多掌握了,作業做起來的效率也更高了。雖然和之前的作業一樣,作業中都要用到新的知識,但是相比之前,更加懂得了如何利用工具以及資料。雖然之間卡過殼,但總體而言,這幾次作業還算完成的比較好。 2.作業程序總結 相比前兩個單元,此單 ......

    uj5u.com 2020-09-10 05:35:41 more
  • 北航OO(2020)第四單元博客作業暨課程總結博客

    北航OO(2020)第四單元博客作業暨課程總結博客 本單元作業的架構設計 在本單元中,由于UML圖具有比較清晰的樹形結構,因此我對其中需要進行查詢操作的元素進行了包裝,在樹的父節點中存盤所有孩子的參考。考慮到性能問題,我采用了快取機制,一次查詢后盡可能快取已經遍歷過的資訊,以減少遍歷次數。 本單元我 ......

    uj5u.com 2020-09-10 05:35:48 more
  • BUAA_OO_第四單元

    一、UML決議器設計 ? 先看下題目:第四單元實作一個基于JDK 8帶有效性檢查的UML(Unified Modeling Language)類圖,順序圖,狀態圖分析器 MyUmlInteraction,實際上我們要建立一個有向圖模型,UML中的物件(元素)可能與同級元素連接,也可與低級元素相連形成 ......

    uj5u.com 2020-09-10 05:35:54 more
  • 6.1邏輯運算子

    邏輯運算子 1. && 短路與 運算式1 && 運算式2 01.運算式1為true并且運算式2也為true 整體回傳為true 02.運算式1為false,將不會執行運算式2 整體回傳為false 03.只要有一個運算式為false 整體回傳為false 2. || 短路或 運算式1 || 運算式2 ......

    uj5u.com 2020-09-10 05:35:56 more
  • BUAAOO 第四單元 & 課程總結

    1. 第四單元:StarUml檔案決議 本單元采用了圖模型決議UML。 UML檔案可以抽象為圖、子圖、邊的邏輯結構。 在實作中,圖的節點包括類、介面、屬性,子圖包括狀態圖、順序圖等。 采用了三次遍歷UML元素的方法建圖,第一遍遍歷建點,第二、三次遍歷設定屬性、連邊,實作圖物件的初始化。這里借鑒了一些 ......

    uj5u.com 2020-09-10 05:36:06 more
  • 談談我對C# 多型的理解

    面向物件三要素:封裝、繼承、多型。 封裝和繼承,這兩個比較好理解,但要理解多型的話,可就稍微有點難度了。今天,我們就來講講多型的理解。 我們應該經常會看到面試題目:請談談對多型的理解。 其實呢,多型非常簡單,就一句話:呼叫同一種方法產生了不同的結果。 具體實作方式有三種。 一、多載 多載很簡單。 p ......

    uj5u.com 2020-09-10 05:36:09 more
  • Python 資料驅動工具:DDT

    背景 python 的unittest 沒有自帶資料驅動功能。 所以如果使用unittest,同時又想使用資料驅動,那么就可以使用DDT來完成。 DDT是 “Data-Driven Tests”的縮寫。 資料:http://ddt.readthedocs.io/en/latest/ 使用方法 dd. ......

    uj5u.com 2020-09-10 05:36:13 more
  • Python里面的xlrd模塊詳解

    那我就一下面積個問題對xlrd模塊進行學習一下: 1.什么是xlrd模塊? 2.為什么使用xlrd模塊? 3.怎樣使用xlrd模塊? 1.什么是xlrd模塊? ?python操作excel主要用到xlrd和xlwt這兩個庫,即xlrd是讀excel,xlwt是寫excel的庫。 今天就先來說一下xl ......

    uj5u.com 2020-09-10 05:36:28 more
  • 當我們創建HashMap時,底層到底做了什么?

    jdk1.7中的底層實作程序(底層基于陣列+鏈表) 在我們new HashMap()時,底層創建了默認長度為16的一維陣列Entry[ ] table。當我們呼叫map.put(key1,value1)方法向HashMap里添加資料的時候: 首先,呼叫key1所在類的hashCode()計算key1 ......

    uj5u.com 2020-09-10 05:36:38 more
最新发布
  • 【中介者設計模式詳解】C/Java/JS/Go/Python/TS不同語言實作

    * 中介者模式是一種行為型設計模式,它可以用來減少類之間的直接依賴關系,
    * 將物件之間的通信封裝到一個中介者物件中,從而使得各個物件之間的關系更加松散。
    * 在中介者模式中,物件之間不再直接相互互動,而是通過中介者來中轉訊息。 ......

    uj5u.com 2023-04-20 08:20:47 more
  • 露天煤礦現場調研和交流案例分享

    他們集團的資訊化公司及研究院在一個礦區正在做智能礦山的統一平臺的 試點,專案投資大概1億,包括了礦山的各方面的內容,顯示得我們這次交流有點多余。他們2年前開始做智能礦山的規劃,有很多煤礦行業專家的加持,他們的描述是非常完美,但是去年底應該上線的平臺,現在還沒有看到影子。他們確實有很多場景需求,但是被... ......

    uj5u.com 2023-04-20 08:20:25 more
  • 《社區人員管理》實戰案例設計&個人案例分享

    設計是一個讓人夢想成真程序,開始編碼、測驗、除錯之前進行需求分析和架構設計,才能保證關鍵方面都做正確 ......

    uj5u.com 2023-04-20 08:20:17 more
  • 軟體架構生態化-多角色交付的探索實踐

    作為一個技術架構師,不僅僅要緊跟行業技術趨勢,還要結合研發團隊現狀及痛點,探索新的交付方案。在日常中,你是否遇到如下問題 “ 業務需求排期長研發是瓶頸;非研發角色感受不到研發技改提效的變化;引入ISV 團隊又擔心質量和安全,培訓周期長“等等,基于此我們探索了一種新的技術體系及交付方案來解決如上問題。 ......

    uj5u.com 2023-04-20 08:20:10 more
  • 【中介者設計模式詳解】C/Java/JS/Go/Python/TS不同語言實作

    * 中介者模式是一種行為型設計模式,它可以用來減少類之間的直接依賴關系,
    * 將物件之間的通信封裝到一個中介者物件中,從而使得各個物件之間的關系更加松散。
    * 在中介者模式中,物件之間不再直接相互互動,而是通過中介者來中轉訊息。 ......

    uj5u.com 2023-04-20 08:19:44 more
  • 露天煤礦現場調研和交流案例分享

    他們集團的資訊化公司及研究院在一個礦區正在做智能礦山的統一平臺的 試點,專案投資大概1億,包括了礦山的各方面的內容,顯示得我們這次交流有點多余。他們2年前開始做智能礦山的規劃,有很多煤礦行業專家的加持,他們的描述是非常完美,但是去年底應該上線的平臺,現在還沒有看到影子。他們確實有很多場景需求,但是被... ......

    uj5u.com 2023-04-20 08:19:07 more
  • 《社區人員管理》實戰案例設計&個人案例分享

    設計是一個讓人夢想成真程序,開始編碼、測驗、除錯之前進行需求分析和架構設計,才能保證關鍵方面都做正確 ......

    uj5u.com 2023-04-20 08:18:57 more
  • 軟體架構生態化-多角色交付的探索實踐

    作為一個技術架構師,不僅僅要緊跟行業技術趨勢,還要結合研發團隊現狀及痛點,探索新的交付方案。在日常中,你是否遇到如下問題 “ 業務需求排期長研發是瓶頸;非研發角色感受不到研發技改提效的變化;引入ISV 團隊又擔心質量和安全,培訓周期長“等等,基于此我們探索了一種新的技術體系及交付方案來解決如上問題。 ......

    uj5u.com 2023-04-20 08:18:49 more
  • 05單件模式

    #經典的單件模式 public class Singleton { private static Singleton uniqueInstance; //一個靜態變數持有Singleton類的唯一實體。 // 其他有用的實體變數寫在這里 //構造器宣告為私有,只有Singleton可以實體化這個類! ......

    uj5u.com 2023-04-19 08:42:51 more
  • 【架構與設計】常見微服務分層架構的區別和落地實踐

    軟體工程的方方面面都遵循一個最基本的道理:沒有銀彈,架構分層模型更是如此,每一種都有各自優缺點,所以請根據不同的業務場景,并遵循簡單、可演進這兩個重要的架構原則選擇合適的架構分層模型即可。 ......

    uj5u.com 2023-04-19 08:42:41 more