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

背景

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简单传递一个元组（普通情况应该传递Menu对象），如下：

以上程序会把tuple对象封装成Menu对象。但请注意如下setter函数，作者似乎忘记了把tuple转换成Menu对象，直接进行了简单的赋值。

 

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

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

我的Pull request： https://github.com/moses-palmer/pystray/pull/152 

 如果不想修改pystray 的源代码，可以修改成如下：

menu_items=(
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),
)

icon.menu = Menu(*menu_items)

 

总结：

• 作者虽然简化用户的参数传递支持了元组类型，但是setter函数却很容易忘记了封装成合适的对象
• Pull request： https://github.com/moses-palmer/pystray/pull/152