5 年 Python ，總結的 10 條 Python 使用技巧

今天給大家分享 10 個我平時整理非常實用的 Python 開發小技巧，內容目錄如下：

值得一提的是，這 10 個技巧全部收錄在我自己寫的 《Python黑魔法指南》里，

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)

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

當你使用 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