函数内部定义Matplotlib Button点击处理器失效问题排查

哈哈，这个坑我之前也踩过！这是Matplotlib事件处理里一个很容易忽略的问题——局部创建的按钮对象被Python垃圾回收机制销毁了，导致点击事件绑定失效。

问题原因拆解 #

当testfn()函数执行完毕后，函数内部的局部变量（比如b1）就失去了外部引用，Python的垃圾回收器会把这些“没人用”的对象清理掉。虽然f1这个画布实例还被Matplotlib全局管理着，但绑定在它上面的按钮b1已经被销毁了，所以点击自然没反应。

至于f2的按钮能工作，其实是个巧合：在某些Python环境下，最后创建的局部变量可能暂时还没被回收，但这绝对不是可靠的行为，换个环境或者复杂点的代码就会失效。

两种可靠的解决方案 #

方法一：用容器保存按钮引用

在函数里创建一个列表（或其他容器），把每个按钮都加进去，只要这个容器的引用存在，按钮就不会被垃圾回收：

from matplotlib import pyplot as plt
from matplotlib.widgets import Button

def handler(*args, **kwargs):
    print('handled')

def testfn():
    # 用列表存储按钮引用，避免被GC回收
    button_refs = []
    
    f1 = plt.figure('f1')
    b1 = Button(f1.add_axes([0.4, 0.3, 0.1, 0.04]), 'Click!')
    b1.on_clicked(handler)
    button_refs.append(b1)
    
    f2 = plt.figure('f2')
    b2 = Button(f2.add_axes([0.4, 0.3, 0.1, 0.04]), 'Click!')
    b2.on_clicked(handler)
    button_refs.append(b2)
    
    # 返回引用列表，确保外部能持有它
    return button_refs

# 保存返回的引用，别让它被销毁
refs = testfn()
plt.show()

方法二：把按钮绑定到画布对象上

另一种更直观的方式是把按钮作为画布的属性存起来，这样只要画布存在，按钮就不会被回收：

from matplotlib import pyplot as plt
from matplotlib.widgets import Button

def handler(*args, **kwargs):
    print('handled')

def testfn():
    f1 = plt.figure('f1')
    b1 = Button(f1.add_axes([0.4, 0.3, 0.1, 0.04]), 'Click!')
    b1.on_clicked(handler)
    f1.my_button = b1  # 将按钮绑定为画布的属性
    
    f2 = plt.figure('f2')
    b2 = Button(f2.add_axes([0.4, 0.3, 0.1, 0.04]), 'Click!')
    b2.on_clicked(handler)
    f2.my_button = b2  # 将按钮绑定为画布的属性

testfn()
plt.show()

核心总结 #

本质上就是要给按钮对象留一个“活”的引用，不让Python把它当成无用对象回收。所有Matplotlib的交互式组件（Slider、Checkbox等）都有这个要求，一定要记住哦！

内容的提问来源于stack exchange，提问作者Gleb