5年 Python 功力，總結了 10 個開發技巧！網友：太實用了

你們好。

今天給你們分享 10 個我平時整理很是實用的 Python 開發小技巧，內容目錄以下：

值得一提的是，這 10 個技巧所有收錄在我本身寫的 《Python黑魔法指南》裏

你能夠在按照以下方法，後臺發送『黑魔法』就能夠獲取精美排版的 PDF 電子書。

1. 如何在運行狀態查看源代碼？

查看函數的源代碼，咱們一般會使用 IDE 來完成。

好比在 PyCharm 中，你能夠 Ctrl + 鼠標點擊 進入函數的源代碼。

那若是沒有 IDE 呢？

當咱們想使用一個函數時，如何知道這個函數須要接收哪些參數呢？

當咱們在使用函數時出現問題的時候，如何經過閱讀源代碼來排查問題所在呢？

這時候，咱們可使用 inspect 來代替 IDE 幫助你完成這些事

# demo.py
import inspect


def add(x, y):
    return x + y

print("===================")
print(inspect.getsource(add))

運行結果以下

$ python demo.py
===================
def add(x, y):
    return x + y

2. 如何關閉異常自動關聯上下文？

當你在處理異常時，因爲處理不當或者其餘問題，再次拋出另外一個異常時，往外拋出的異常也會攜帶原始的異常信息。

就像這樣子。

try:
    print(1 / 0)
except Exception as exc:
    raise RuntimeError("Something bad happened")

從輸出能夠看到兩個異常信息

Traceback (most recent call last):
  File "demo.py", line 2, in <module>
    print(1 / 0)
ZeroDivisionError: division by zero

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "demo.py", line 4, in <module>
    raise RuntimeError("Something bad happened")
RuntimeError: Something bad happened

若是在異常處理程序或 finally 塊中引起異常，默認狀況下，異常機制會隱式工做會將先前的異常附加爲新異常的 __context__屬性。這就是 Python 默認開啓的自動關聯異常上下文。

若是你想本身控制這個上下文，能夠加個 from 關鍵字（from 語法會有個限制，就是第二個表達式必須是另外一個異常類或實例。），來代表你的新異常是直接由哪一個異常引發的。

try:
    print(1 / 0)
except Exception as exc:
    raise RuntimeError("Something bad happened") from exc

輸出以下

Traceback (most recent call last):
  File "demo.py", line 2, in <module>
    print(1 / 0)
ZeroDivisionError: division by zero

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "demo.py", line 4, in <module>
    raise RuntimeError("Something bad happened") from exc
RuntimeError: Something bad happened

固然，你也能夠經過with_traceback()方法爲異常設置上下文__context__屬性，這也能在traceback更好的顯示異常信息。

try:
    print(1 / 0)
except Exception as exc:
    raise RuntimeError("bad thing").with_traceback(exc)

最後，若是我想完全關閉這個自動關聯異常上下文的機制？有什麼辦法呢？

可使用 raise...from None，從下面的例子上看，已經沒有了原始異常

$ cat demo.py
try:
    print(1 / 0)
except Exception as exc:
    raise RuntimeError("Something bad happened") from None
$
$ python demo.py
Traceback (most recent call last):
  File "demo.py", line 4, in <module>
    raise RuntimeError("Something bad happened") from None
RuntimeError: Something bad happened
(PythonCodingTime)

03. 最快查看包搜索路徑的方式

當你使用 import 導入一個包或模塊時，Python 會去一些目錄下查找，而這些目錄是有優先級順序的，正常人會使用 sys.path 查看。

>>> import sys
>>> from pprint import pprint   
>>> pprint(sys.path)
['',
 '/usr/local/Python3.7/lib/python37.zip',
 '/usr/local/Python3.7/lib/python3.7',
 '/usr/local/Python3.7/lib/python3.7/lib-dynload',
 '/home/wangbm/.local/lib/python3.7/site-packages',
 '/usr/local/Python3.7/lib/python3.7/site-packages']
>>>

那有沒有更快的方式呢？

我這有一種連 console 模式都不用進入的方法呢？

你可能會想到這種，但這本質上與上面並沒有區別

[wangbm@localhost ~]$ python -c "print('\n'.join(__import__('sys').path))"

/usr/lib/python2.7/site-packages/pip-18.1-py2.7.egg
/usr/lib/python2.7/site-packages/redis-3.0.1-py2.7.egg
/usr/lib64/python27.zip
/usr/lib64/python2.7
/usr/lib64/python2.7/plat-linux2
/usr/lib64/python2.7/lib-tk
/usr/lib64/python2.7/lib-old
/usr/lib64/python2.7/lib-dynload
/home/wangbm/.local/lib/python2.7/site-packages
/usr/lib64/python2.7/site-packages
/usr/lib64/python2.7/site-packages/gtk-2.0
/usr/lib/python2.7/site-packages

這裏我要介紹的是比上面兩種都方便的多的方法，一行命令便可解決

[wangbm@localhost ~]$ python3 -m site
sys.path = [
    '/home/wangbm',
    '/usr/local/Python3.7/lib/python37.zip',
    '/usr/local/Python3.7/lib/python3.7',
    '/usr/local/Python3.7/lib/python3.7/lib-dynload',
    '/home/wangbm/.local/lib/python3.7/site-packages',
    '/usr/local/Python3.7/lib/python3.7/site-packages',
]
USER_BASE: '/home/wangbm/.local' (exists)
USER_SITE: '/home/wangbm/.local/lib/python3.7/site-packages' (exists)
ENABLE_USER_SITE: True

從輸出你能夠發現，這個列的路徑會比 sys.path 更全，它包含了用戶環境的目錄。

4. 將嵌套 for 循環寫成單行

咱們常常會以下這種嵌套的 for 循環代碼

list1 = range(1,3)
list2 = range(4,6)
list3 = range(7,9)
for item1 in list1:
    for item2 in list2:
          for item3 in list3:
              print(item1+item2+item3)

這裏僅僅是三個 for 循環，在實際編碼中，有可能會有更層。

這樣的代碼，可讀性很是的差，不少人不想這麼寫，可又沒有更好的寫法。

這裏介紹一種我經常使用的寫法，使用 itertools 這個庫來實現更優雅易讀的代碼。

from itertools import product
list1 = range(1,3)
list2 = range(4,6)
list3 = range(7,9)
for item1,item2,item3 in product(list1, list2, list3):
    print(item1+item2+item3)

輸出以下

$ python demo.py
12
13
13
14
13
14
14
15

5. 如何使用 print 輸出日誌

初學者喜歡使用 print 來調試代碼，並記錄程序運行過程。

可是 print 只會將內容輸出到終端上，不能持久化到日誌文件中，並不利於問題的排查。

若是你熱衷於使用 print 來調試代碼（雖然這並非最佳作法），記錄程序運行過程，那麼下面介紹的這個 print 用法，可能會對你有用。

Python 3 中的 print 做爲一個函數，因爲能夠接收更多的參數，因此功能變爲更增強大，指定一些參數能夠將 print 的內容輸出到日誌文件中

代碼以下：

>>> with open('test.log', mode='w') as f:
...     print('hello, python', file=f, flush=True)
>>> exit()

$ cat test.log
hello, python

6. 如何快速計算函數運行時間

計算一個函數的運行時間，你可能會這樣子作

import time

start = time.time()

# run the function

end = time.time()
print(end-start)

你看看你爲了計算函數運行時間，寫了幾行代碼了。

有沒有一種方法能夠更方便的計算這個運行時間呢？

有。

有一個內置模塊叫 timeit

使用它，只用一行代碼便可

import time
import timeit

def run_sleep(second):
    print(second)
    time.sleep(second)

# 只用這一行
print(timeit.timeit(lambda :run_sleep(2), number=5))

運行結果以下

2
2
2
2
2
10.020059824

7. 利用自帶的緩存機制提升效率

緩存是一種將定量數據加以保存，以備迎合後續獲取需求的處理方式，旨在加快數據獲取的速度。

數據的生成過程可能須要通過計算，規整，遠程獲取等操做，若是是同一份數據須要屢次使用，每次都從新生成會大大浪費時間。因此，若是將計算或者遠程請求等操做得到的數據緩存下來，會加快後續的數據獲取需求。

爲了實現這個需求，Python 3.2 + 中給咱們提供了一個機制，能夠很方便的實現，而不須要你去寫這樣的邏輯代碼。

這個機制實現於 functool 模塊中的 lru_cache 裝飾器。

@functools.lru_cache(maxsize=None, typed=False)

參數解讀：

• maxsize：最多能夠緩存多少個此函數的調用結果，若是爲None，則無限制，設置爲 2 的冪時，性能最佳
• typed：若爲 True，則不一樣參數類型的調用將分別緩存。

舉個例子

from functools import lru_cache

@lru_cache(None)
def add(x, y):
    print("calculating: %s + %s" % (x, y))
    return x + y

print(add(1, 2))
print(add(1, 2))
print(add(2, 3))

輸出以下，能夠看到第二次調用並無真正的執行函數體，而是直接返回緩存裏的結果

calculating: 1 + 2
3
3
calculating: 2 + 3
5

下面這個是經典的斐波那契數列，當你指定的 n 較大時，會存在大量的重複計算

def fib(n):
    if n < 2:
        return n
    return fib(n - 2) + fib(n - 1)

第六點介紹的 timeit，如今能夠用它來測試一下到底能夠提升多少的效率。

不使用 lru_cache 的狀況下，運行時間 31 秒

import timeit

def fib(n):
    if n < 2:
        return n
    return fib(n - 2) + fib(n - 1)



print(timeit.timeit(lambda :fib(40), number=1))
# output: 31.2725698948

因爲使用了 lru_cache 後，運行速度實在太快了，因此我將 n 值由 30 調到 500，可即便是這樣，運行時間也才 0.0004 秒。提升速度很是顯著。

import timeit
from functools import lru_cache

@lru_cache(None)
def fib(n):
    if n < 2:
        return n
    return fib(n - 2) + fib(n - 1)

print(timeit.timeit(lambda :fib(500), number=1))
# output: 0.0004921059880871326

8. 在程序退出前執行代碼的技巧

使用 atexit 這個內置模塊，能夠很方便的註冊退出函數。

無論你在哪一個地方致使程序崩潰，都會執行那些你註冊過的函數。

示例以下

若是clean()函數有參數，那麼你能夠不用裝飾器，而是直接調用atexit.register(clean_1, 參數1, 參數2, 參數3='xxx')。

可能你有其餘方法能夠處理這種需求，但確定比上不使用 atexit 來得優雅，來得方便，而且它很容易擴展。

可是使用 atexit 仍然有一些侷限性，好比：

• 若是程序是被你沒有處理過的系統信號殺死的，那麼註冊的函數沒法正常執行。
• 若是發生了嚴重的 Python 內部錯誤，你註冊的函數沒法正常執行。
• 若是你手動調用了os._exit()，你註冊的函數沒法正常執行。

9. 實現相似 defer 的延遲調用

在 Golang 中有一種延遲調用的機制，關鍵字是 defer，例以下面的示例

import "fmt"

func myfunc() {
    fmt.Println("B")
}

func main() {
    defer myfunc()
    fmt.Println("A")
}

輸出以下，myfunc 的調用會在函數返回前一步完成，即便你將 myfunc 的調用寫在函數的第一行，這就是延遲調用。

A
B

那麼在 Python 中否有這種機制呢？

固然也有，只不過並無 Golang 這種簡便。

在 Python 可使用 上下文管理器 達到這種效果

import contextlib

def callback():
    print('B')

with contextlib.ExitStack() as stack:
    stack.callback(callback)
    print('A')

輸出以下

A
B

10. 如何流式讀取數G超大文件

使用 with...open... 能夠從一個文件中讀取數據，這是全部 Python 開發者都很是熟悉的操做。

可是若是你使用不當，也會帶來很大的麻煩。

好比當你使用了 read 函數，其實 Python 會將文件的內容一次性的所有載入內存中，若是文件有 10 個G甚至更多，那麼你的電腦就要消耗的內存很是巨大。

# 一次性讀取
with open("big_file.txt", "r") as fp:
    content = fp.read()

對於這個問題，你也許會想到使用 readline 去作一個生成器來逐行返回。

def read_from_file(filename):
    with open(filename, "r") as fp:
        yield fp.readline()

可若是這個文件內容就一行呢，一行就 10個G，其實你仍是會一次性讀取所有內容。

最優雅的解決方法是，在使用 read 方法時，指定每次只讀取固定大小的內容，好比下面的代碼中，每次只讀取 8kb 返回。

def read_from_file(filename, block_size = 1024 * 8):
    with open(filename, "r") as fp:
        while True:
            chunk = fp.read(block_size)
            if not chunk:
                break

            yield chunk

上面的代碼，功能上已經沒有問題了，可是代碼看起來代碼仍是有些臃腫。

藉助偏函數 和 iter 函數能夠優化一下代碼

from functools import partial

def read_from_file(filename, block_size = 1024 * 8):
    with open(filename, "r") as fp:
        for chunk in iter(partial(fp.read, block_size), ""):
            yield chunk

---