pystray被隐藏菜单项显示出来的问题

发布时间 2023-11-03 16:11:06作者: pmh905001

背景

pystray可以用来显示托盘,菜单项,以及气泡通知信息。我的程序里面是如下界面,代码参考: https://gitee.com/pmh905001/shouyu/blob/main/shouyu/view/tray.py 。里面有一个功能是点击黄色的小黄鱼托盘图标,默认打开excel的功能。 这是默认的隐藏的菜单项。

由于有开机启动这个复选框,所以这是一个动态菜单,选中和非选中状态都会导致菜单状态发生变化。接着就发现了一个bug,点击开机启动菜单项的时候,会把隐藏的“显示Excel“ 菜单项显示出来,如下图所示:

 实际代码就是

icon.menu=(
MenuItem(text='帮助', action=cls.on_help),
MenuItem(text='设置', action=cls.on_config),
MenuItem(
text='开机启动',
action=cls.on_turn_off_auto_run if is_auto_run else cls.on_turn_on_auto_run,
checked=cls.display_checked,
),
MenuItem(text='重启', action=cls.on_restart),
MenuItem(text='显示Excel', action=cls.on_show, default=True, visible=False),
MenuItem(text='退出', action=cls.on_exit),
)

我的第一感觉是不是pystray的bug?因为我初始化菜单项也是传递一个tuple元组进去,动态菜单也只是修改了菜单的值并且进行了刷新。

pystray.Icon("name", Image.open(Package.get_resource_path('resources/icons/fish.png')), '授渔', cls._menu_items())

分析

经过查找,终于找到了错误的原因,https://github.com/moses-palmer/pystray/blob/master/lib/pystray/_base.py .托盘对象在初始化的时候,作者为了简化用户的传递,允许对menu简单传递一个tuple或者Menu对象,并且把tuple做了转换处理封装成Menu对象。

 setter函数也没有做特殊的声明必须为Menu对象。

 

Menu本身也是可迭代对象,这就是为什么会导致  icon.menu=(item1,item2,)没有出现异常的原因。https://github.com/moses-palmer/pystray/blob/master/lib/pystray/_win32.py。  但是这样会导致隐藏的菜单项会被显示出来,也就是我所遇到的问题。

要解决该问题,实际上需要对setter函数进行修改,能够接受tuple或者Menu对象,就像在构造函数里面一样。 将pull request到pystray 。

 

总结:

为了简化用户的参数传递,通常会简化传递类型,在构造函数里面进行转化。但setter函数不要忘记转化,从而导致bug出现。