Python 強大的信號庫 blinker 入門詳細教程

Posted on by

1、信號

信號是一種通知或者說通信的方式，信號分為發送方和接收方。發送方發送一種信號，接收方收到信號的進程會跳入信號處理函數，執行完後再跳回原來的位置繼續執行。

常見的 Linux 中的信號，通過鍵盤輸入 Ctrl+C，就是發送給系統一個信號，告訴系統退出當前進程。

信號的特點就是發送端通知訂閱者發生瞭什麼。使用信號分為 3 步：定義信號，監聽信號，發送信號。

Python 中提供瞭信號概念的通信模塊，就是blinker。

Blinker 是一個基於 Python 的強大的信號庫，它既支持簡單的點對點通信，也支持點對多點的組播。Flask 的信號機制就是基於它建立的。Blinker 的內核雖然小巧，但是功能卻非常強大，它支持以下特性：

  • 支持註冊全局命名信號
  • 支持匿名信號
  • 支持自定義命名信號
  • 支持與接收者之間的持久連接與短暫連接
  • 通過弱引用實現與接收者之間的自動斷開連接
  • 支持發送任意大小的數據
  • 支持收集信號接收者的返回值
  • 線程安全

2、blinker 使用

安裝方法：

pip install blinker

2.1 命名信號

from blinker import signal
 
# 定義一個信號
s = signal('king')
def animal(args):
    print('我是小鉆風，大王回來瞭，我要去巡山')
# 信號註冊一個接收者
s.connect(animal)
if "__main__" == __name__:
    # 發送信號
    s.send()

2.2 匿名信號

blinker 也支持匿名信號，就是不需要指定一個具體的信號值。創建的每一個匿名信號都是互相獨立的。

from blinker import Signal
 
s = Signal()
def animal(sender):
    print('我是小鉆風，大王回來瞭，我要去巡山')
s.connect(animal)
if "__main__" == __name__:
    s.send()

2.3 組播信號

組播信號是比較能體現出信號優點的特征。多個接收者註冊到信號上，發送者隻需要發送一次就能傳遞信息到多個接收者。

from blinker import signal
 
s = signal('king')
def animal_one(args):
    print(f'我是小鉆風，今天的口號是: {args}')
def animal_two(args):
    print(f'我是大鉆風，今天的口號是: {args}')
s.connect(animal_one)
s.connect(animal_two)
if "__main__" == __name__:
    s.send('大王叫我來巡山，抓個和尚做晚餐！')

2.4 接收方訂閱主題

接受方支持訂閱指定的主題，隻有當指定的主題發送消息時才發送給接收方。這種方法很好的區分瞭不同的主題。

from blinker import signal
 
s = signal('king')
def animal(args):
    print(f'我是小鉆風，{args} 是我大哥')
s.connect(animal, sender='大象')
if "__main__" == __name__:
    for i in ['獅子', '大象', '大鵬']:
        s.send(i)

2.5 裝飾器用法

除瞭可以函數註冊之外還有更簡單的信號註冊方法，那就是裝飾器。

from blinker import signal
 
s = signal('king')
@s.connect
def animal_one(args):
    print(f'我是小鉆風，今天的口號是: {args}')
def animal_two(args):
    print(f'我是大鉆風，今天的口號是: {args}')
if "__main__" == __name__:
    s.send('大王叫我來巡山，抓個和尚做晚餐！')

2.6 可訂閱主題的裝飾器

connect的註冊方法用著裝飾器時有一個弊端就是不能夠訂閱主題，所以有更高級的connect_via方法支持訂閱主題。

from blinker import signal
s = signal('king')
@s.connect_via('大象')
def animal(args):
    print(f'我是小鉆風，{args} 是我大哥')
if "__main__" == __name__:
    for i in ['獅子', '大象', '大鵬']:
        s.send(i)

2.7 檢查信號是否有接收者

如果對於一個發送者發送消息前要準備的耗時很長，為瞭避免沒有接收者導致浪費性能的情況，所以可以先檢查某一個信號是否有接收者，在確定有接收者的情況下才發送，做到精確。

from blinker import signal
s = signal('king')
q = signal('queue')
def animal(sender):
    print('我是小鉆風，大王回來瞭，我要去巡山')
s.connect(animal)
if "__main__" == __name__:
    
    res = s.receivers
    print(res)
    if res:
        s.send()
    res = q.receivers
        q.send()
    else:
        print("孩兒們都出去巡山瞭")

{4511880240: <weakref at 0x10d02ae80; to 'function' at 0x10cedd430 (animal)>}
我是小鉆風，大王回來瞭，我要去巡山
{}
孩兒們都出去巡山瞭

2.8 檢查訂閱者是否訂閱瞭某個信號

也可以檢查訂閱者是否由某一個信號

from blinker import signal
s = signal('king')
q = signal('queue')
def animal(sender):
    print('我是小鉆風，大王回來瞭，我要去巡山')
s.connect(animal)
if "__main__" == __name__:
    
    res = s.has_receivers_for(animal)
    print(res)
    res = q.has_receivers_for(animal)

True
False

3、基於 blinker 的 Flask 信號

Flask 集成 blinker 作為解耦應用的解決方案。在 Flask 中，信號的使用場景如：請求到來之前，請求結束之後。同時 Flask 也支持自定義信號。

3.1 簡單 Flask demo

from flask import Flask
app = Flask(__name__)
@app.route('/',methods=['GET','POST'],endpoint='index')
def index():
    return 'hello blinker'
 
if __name__ == '__main__':
    app.run()

訪問127.0.0.1:5000時，返回給瀏覽器hello blinker。

3.2 自定義信號

因為 Flask 集成瞭信號，所以在 Flask 中使用信號時從 Flask 中引入。

from flask import Flask
from flask.signals import _signals
 
app = Flask(__name__)
s = _signals.singal('msg')
def QQ(args):
    print('you have msg from QQ')
s.connect(QQ)
@app.route('/',methods=['GET','POST'],endpoint='index')
def index():
    s.send()
    return 'hello blinker'
if __name__ == '__main__':
    app.run()

3.3 Flask自帶信號

在 Flask 中除瞭可以自定義信號，還可以使用自帶信號。Flask 中自帶的信號有很多種，具體如下：

請求
request_started = _signals.signal('request-started')                # 請求到來前執行
request_finished = _signals.signal('request-finished')              # 請求結束後執行
 
模板渲染
before_render_template = _signals.signal('before-render-template')  # 模板渲染前執行
template_rendered = _signals.signal('template-rendered')            # 模板渲染後執行
請求執行
got_request_exception = _signals.signal('got-request-exception')    # 請求執行出現異常時執行
request_tearing_down = _signals.signal('request-tearing-down')      # 請求執行完畢後自動執行（無論成功與否）
appcontext_tearing_down = _signals.signal('appcontext-tearing-down') # 請求上下文執行完畢後自動執行（無論成功與否）
請求上下文中
appcontext_pushed = _signals.signal('appcontext-pushed')            # 請求上下文push時執行
appcontext_popped = _signals.signal('appcontext-popped')            # 請求上下文pop時執行
message_flashed = _signals.signal('message-flashed')                # 調用flask在其中添加數據時，自動觸

下面以請求到來之前為例，看 Flask 中信號如何使用

from flask import Flask
from flask.signals import _signals, request_started
import time
 
app = Flask(__name__)
def wechat(args):
    print('you have msg from wechat')
# 從flask中引入已經定好的信號，註冊一個函數
request_started.connect(wechat)
@app.route('/',methods=['GET','POST'],endpoint='index')
def index():
    return 'hello blinker'
if __name__ == '__main__':
    app.run()

當請求到來時，Flask 會經過request_started 通知接受方，就是函數wechat，這時wechat函數先執行，然後才返回結果給瀏覽器。

但這種使用方法並不是很地道，因為信號並不支持異步方法，所以通常在生產環境中信號的接收者都是配置異步執行的框架，如 Python 中大名鼎鼎的異步框架 celery。

4、總結

信號的優點：

  • 解耦應用：將串行運行的耦合應用分解為多級執行
  • 發佈訂閱者：減少調用者的使用，一次調用通知多個訂閱者

信號的缺點：

  • 不支持異步
  • 支持訂閱主題的能力有限

到此這篇關於Python 強大的信號庫 blinker 入門教程的文章就介紹到這瞭,更多相關Python信號庫 blinker 入門內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：