blinker，一个神奇的 Python 库！

大家好，今天为大家分享一个神奇的 Python 库 - blinker。

Github地址：https://github.com/pallets-eco/blinker

---

在Python开发中，信号（signals）和槽（slots）模式是一种强大的模式，用于在组件之间进行解耦通信。blinker库提供了一种高效的方式来实现这种模式。本文将详细介绍blinker库的安装、特性、基础和高级功能，并结合实际应用场景展示其使用方法和优势。

安装

安装blinker非常简单，可以直接通过pip命令进行安装：

pip install blinker

这将从Python包索引（PyPI）下载并安装最新版本的blinker库。

特性

• 简洁的API：blinker提供了一个易于使用的API来连接信号与槽。
• 灵活的信号定义：可以自定义信号，使得组件间的通信更为灵活。
• 线程安全：blinker保证了信号的发送和接收是线程安全的。

基本功能

定义和发送信号

使用blinker，可以很容易地定义信号并连接到槽函数上。

from blinker import signal

# 定义一个信号
completed = signal('completed')

# 定义接收信号的函数
def on_completed(sender):
    print(f"Received a signal from {sender}")

# 连接信号与槽函数
completed.connect(on_completed)

# 发送信号
completed.send('Process A')

在此示例中，创建了一个名为completed的信号，并将其与on_completed函数连接。然后，从'Process A'发送信号，槽函数接收到信号并执行。

断开信号连接

blinker也允许断开已经建立的连接。

# 断开信号与槽函数的连接
completed.disconnect(on_completed)

# 再次发送信号，此时不会有输出
completed.send('Process A')

高级功能

弱引用

默认情况下，Blinker使用弱引用来连接信号和接收者。这意味着如果没有其他地方引用接收者，连接不会阻止接收者被垃圾回收。

from blinker import signal

def receiver(sender):
    print("Signal received from:", sender)

sig = signal('test_signal')
sig.connect(receiver, weak=False)

# 因为设置了weak=False，receiver不会因为没有其他引用而被垃圾回收

信号的调试

Blinker提供了便捷的方式来调试信号，例如通过signal.receivers可以查看所有连接到信号的接收者。

from blinker import signal

sig = signal('test_signal')

def receiver(sender):
    print("Signal received from:", sender)

sig.connect(receiver)

# 打印所有接收者
for receiver in sig.receivers:
    print(receiver)

处理连接结果

使用Blinker，可以处理由信号接收者返回的结果，这可以用于聚合数据或决策。

from blinker import signal

sig = signal('test_signal')

def receiver_one(sender):
    return "Result from Receiver One"

def receiver_two(sender):
    return "Result from Receiver Two"

sig.connect(receiver_one)
sig.connect(receiver_two)

# 发送信号并处理所有接收者的返回结果
results = sig.send('some_sender')
print("Received results:")
for receiver, result in results:
    print(result)

信号的过滤和修改

可以在接收信号时对数据进行过滤或修改。

from blinker import signal

sig = signal('test_signal')

def modify_data(sender, **kwargs):
    kwargs['data'] *= 10
    return kwargs

sig.connect(modify_data)

# 发送带参数的信号
result = sig.send('source', data=5)
print("Modified data:", result[0][1])

优先级设置

Blinker支持为连接设置优先级，较高优先级的接收者会先接收到信号。

from blinker import signal

sig = signal('test_signal')

def first_receiver(sender):
    print("First receiver processed")

def second_receiver(sender):
    print("Second receiver processed")

# 使用priority参数设置接收顺序
sig.connect(first_receiver, priority=2)
sig.connect(second_receiver, priority=1)

# 发送信号
sig.send('some_sender')

实际应用场景

应用组件间的通信

在复杂的应用中，各个组件可能需要在不直接引用对方的情况下通信。Blinker通过信号和槽机制提供了这种能力。

模块间发送状态更新：

from blinker import signal

status_updated = signal('status_updated')

# 定义接收函数
def status_listener(sender, **kwargs):
    print(f"Received status update from {sender}: {kwargs['status']}")

# 连接信号
status_updated.connect(status_listener)

# 在应用的另一部分发送更新
status_updated.send('module_A', status="Module A completed its task")

Web框架中的动态事件处理

在Web框架中，Blinker常被用来处理来自不同部分的事件，如用户动作或系统事件。

Flask应用中追踪用户登录：

from flask import Flask
from flask_login import user_logged_in
from blinker import signal

app = Flask(__name__)
user_login_signal = signal('user_logged_in')

@user_login_signal.connect
def track_user_login(sender, user, **extra):
    print(f"User {user.username} logged in.")

# 假设user_logged_in是Flask-Login发出的信号
user_logged_in.connect(track_user_login)

# 在其他地方，当用户登录成功时，Flask-Login库会触发user_logged_in信号

跨系统的异步任务触发

在大型系统中，某些操作可能需要触发跨系统的任务，Blinker可以用来在不同系统间异步地触发这些任务。

异步执行后台任务：

from blinker import signal

task_signal = signal('start_background_task')

def background_task_handler(sender, **kwargs):
    task_id = kwargs.get('task_id', None)
    print(f"Starting background task {task_id}...")

task_signal.connect(background_task_handler)

# 在系统的某个地方发送信号以启动后台任务
task_signal.send('system_controller', task_id=123)

总结

Blinker库为Python应用提供了强大的信号派发系统，它通过简单的API支持复杂的信号和槽机制，使得应用组件之间能够以松耦合的方式进行有效的通信。通过使用Blinker，开发者可以在不同的应用模块或系统之间发送和接收信号，而无需直接相互引用，这极大地增强了代码的可维护性和可扩展性。本文详细介绍了Blinker的安装、基本和高级用法，并通过实际的代码示例展示了其在Web开发、模块间通信和异步任务处理等方面的应用。