使用timeout-decorator為python函式任務設定超時時間
阿新 • • 發佈：2021-02-03
# 需求背景
在python程式碼的實現中，假如我們有一個需要執行時間跨度非常大的for迴圈，如果在中間的某處我們需要定時停止這個函式，而不停止整個程式。那麼初步的就可以想到兩種方案：第一種方案是我們先預估for迴圈或者while中的每一步所需要的執行時間，然後設定在到達某一個迭代次數之後就自動退出迴圈;第二種方案是，在需要設定超時任務的前方引入超時的裝飾器，使得超過指定時間之後自動退出函式執行。這裡我們將針對第二種方案，進行展開介紹。
# timeout-decorator的安裝
在pypi的標準庫中也包含有`timeout-decorator`模組，因此可以通過`pip`來直接安裝：
```bash
[dechin@dechin-manjaro timeout]$ python3 -m pip install timeout_decorator
Collecting timeout_decorator
Downloading timeout-decorator-0.5.0.tar.gz (4.8 kB)
Building wheels for collected packages: timeout-decorator
Building wheel for timeout-decorator (setup.py) ... done
Created wheel for timeout-decorator: filename=timeout_decorator-0.5.0-py3-none-any.whl size=5029 sha256=279f8585a08d5e5c87de887492169d1a81e02060c8ea3b62fdd6f062b7f83601
Stored in directory: /home/dechin/.cache/pip/wheels/38/05/4e/161d1463ca145ec1023bd4e5e1f31cbf9239aa8f39a2a2b643
Successfully built timeout-decorator
Installing collected packages: timeout-decorator
Successfully installed timeout-decorator-0.5.0
```
# 配置一個超時任務
這裡我們先展示示例程式碼，再展開介紹其中各個模組的含義：
```python
# timeout_test1.py
from tqdm import trange
import sys
import time
import timeout_decorator
@timeout_decorator.timeout(int(sys.argv[2]))
def test():
if sys.argv[1] == '--timeout':
for i in trange(3):
time.sleep(1)
print ('>>> {} seconds passed.'.format(i+1))
return 0
if __name__ == '__main__':
try:
test()
except Exception as e:
print ('Timeout Error Catched!')
print (e)
print ("Timeout Task Ended!")
```
## timeout-decorator裝飾器的使用
該超時模組採用裝飾器的形式來進行呼叫，使用時先`import`該模組，然後在需要設定定時任務的函式前新增`@timeout_decorator.timeout(3)`即可，這裡括號中的3表示超時時間設定為3s，也就是3s後該函式就會停止執行。前面寫過一篇部落格介紹[如何自定義一個裝飾器](https://www.cnblogs.com/dechinphy/p/decoretor.html)，感興趣的讀者可以自行閱讀。在上述的用例中，為了使得超時時間的定義更加靈活，我們採取了從使用者輸入獲取引數的方案，具體內容參考下一章節的介紹。
## 通過sys獲取timeout引數
在上述用例的裝飾器中，我們看到了`int(sys.argv[2])`這樣的一個引數，這個引數的意思是使用者輸入命令列的`第三個`用空格隔開的引數。舉例子說，如果使用者執行了`python3 test.py -t 1`，那麼這裡就會產生三個輸入引數：`argv[0]`就是`test.py`，`argv[1]`就是`-t`，`argv[2]`就是`1`，是一個數組的格式。需要注意的是，`argv`陣列的每一個元素都是字串格式，如果需要使用數字需要先進行格式轉換。這裡針對於超時任務的處理，我們指定的執行策略為類似`python3 task.py --timeout 5`的格式，`--timeout`後面的數字表示任務執行超時的秒數。如果輸入變數格式不正確，或者不滿足3個以上的變數輸入要求，或者第二個引數不是`--timeout`，都有可能執行報錯。
## 異常捕獲
在定義好超時任務之後，如果達到了設定好的超時時間，系統會給出`timeout_decorator.timeout_decorator.TimeoutError`報錯並結束程式執行。但是我們這裡配置超時任務的目的其實是希望在超時任務的函式到達指定時間之後退出，但是不影響其他模組程式的執行，因此這裡我們需要對程式給出的報錯進行異常捕獲，並且通報與抑制該異常。比較簡單的方案就是採用`except Exception as e`的方式，一般`Exception`最好可以指向指定的報錯型別，而不是通用的`Exception`處理，這有可能帶來其他的一些風險。
# 用例測試
以下按照輸入引數的不同，我們先劃分為幾個模組來分析輸出結果以及原因。
## 超時任務為2s
```bash
[dechin@dechin-manjaro timeout]$ python3 timeout_test.py --timeout 2
0%| | 0/3 [00:00