使用 PySimpleGUI 轻松为程序和脚本添加 GUI

在五分钟内创建一个自定义 GUI。
335 位读者喜欢此文。

很少有人像运行 .exe 文件那样,通过双击 .py 文件来运行 Python 程序。当典型用户(非程序员类型)双击 .exe 文件时,他们希望弹出一个窗口,他们可以与之交互。虽然可以使用标准 Python 安装使用 tkinter 创建 GUI,但很少有程序这样做。

如果将 Python 程序打开到 GUI 中如此简单,以至于完全的初学者都可以做到呢?有人会在乎吗?有人会使用它吗?很难回答,因为到目前为止,构建自定义 GUI 并不容易

在为 Python 程序/脚本添加 GUI 的能力方面似乎存在差距。完全的初学者只能使用命令行,而许多高级程序员不想花时间编写 tkinter GUI。

GUI 框架

Python 并不缺少 GUI 框架。 Tkinter、WxPython、Qt 和 Kivy 是几个主要的软件包。此外,还有许多“包装”主要软件包的简化 GUI 软件包,包括 EasyGUI、PyGUI 和 Pyforms。

问题在于,初学者(经验不足六周的人)甚至无法学习最简单的主要软件包。这使得包装器软件包成为一个潜在的选择,但对于大多数新用户来说,构建自定义 GUI 布局仍然很困难或不可能。即使有可能,包装器仍然需要大量的代码。

PySimpleGUI 试图通过提供一个超级简单、易于理解的 GUI 接口来解决这些 GUI 挑战,该接口可以轻松定制。即使是许多复杂的 GUI,使用 PySimpleGUI 也只需要不到 20 行代码。

秘密

PySimpleGUI 对新手来说更胜一筹的原因在于,该软件包包含用户通常需要编写的大部分代码。按钮回调由 PySimpleGUI 处理,而不是用户的代码。初学者很难掌握函数的概念,期望他们在最初几周内理解回调函数是一个挑战。

对于大多数 GUI 来说,排列 GUI 小部件通常需要几行代码……每个小部件至少需要一两行代码。 PySimpleGUI 使用“自动打包器”自动创建布局。无需 pack 或 grid 系统即可布局 GUI 窗口。

最后,PySimpleGUI 以巧妙的方式利用 Python 语言结构来缩短代码量,并以直接的方式返回 GUI 数据。当在表单布局中创建一个小部件时,它会在原地配置,而不是在几行代码之外。

什么是 GUI?

大多数 GUI 做一件事:从用户那里收集信息并返回它。从程序员的角度来看,这可以概括为一个如下所示的函数调用

button, values = GUI_Display(gui_layout)

大多数 GUI 期望的是单击的按钮(例如,确定、取消、保存、是、否等)和用户输入的值。 GUI 的本质可以归结为一行代码。

这正是 PySimpleGUI 的工作方式(对于简单的 GUI)。调用显示 GUI 时,除非单击关闭表单的按钮,否则不会执行任何操作。

还有更复杂的 GUI,例如那些在单击按钮后不会关闭的 GUI。示例包括机器人的远程控制界面和聊天窗口。这些复杂的表单也可以使用 PySimpleGUI 创建。

快速创建一个 GUI

PySimpleGUI 何时有用? 立即,只要你需要一个 GUI。创建和尝试 GUI 需要不到五分钟的时间。创建 GUI 最快的方法是从 PySimpleGUI Cookbook 复制一个。按照以下步骤操作

  • 找到一个看起来类似于你要创建的 GUI
  • 从 Cookbook 中复制代码
  • 将其粘贴到你的 IDE 中并运行它

让我们看看本书中的第一个配方。

import PySimpleGUI as sg

# Very basic form.  Return values as a list
form = sg.FlexForm('Simple data entry form')  # begin with a blank form

layout = [
          [sg.Text('Please enter your Name, Address, Phone')],
          [sg.Text('Name', size=(15, 1)), sg.InputText('name')],
          [sg.Text('Address', size=(15, 1)), sg.InputText('address')],
          [sg.Text('Phone', size=(15, 1)), sg.InputText('phone')],
          [sg.Submit(), sg.Cancel()]
         ]

button, values = form.LayoutAndRead(layout)

print(button, values[0], values[1], values[2])

这是一个相当大的表单。

PySimpleGUI data entry form

如果你只需要收集几个值,并且它们基本上都是字符串,你可以复制这个配方并修改它以满足你的需求。

你甚至可以在五行代码中创建一个自定义 GUI 布局。

import PySimpleGUI as sg

form = sg.FlexForm('My first GUI')

layout = [ [sg.Text('Enter your name'), sg.InputText()],
           [sg.OK()] ]

button, (name,) = form.LayoutAndRead(layout)

PySimpleGUI form from 5 lines of code

在五分钟内创建一个自定义 GUI

如果你有一个简单的布局,你应该能够在不到五分钟的时间内通过修改 Cookbook 中的代码,在 PySimpleGUI 中创建一个自定义布局。

在 PySimpleGUI 中,小部件被称为元素。 这些元素的拼写与你在 Python 代码中键入它们的方式完全相同。

核心元素

Text
InputText
Multiline
InputCombo
Listbox
Radio
Checkbox
Spin
Output
SimpleButton
RealtimeButton
ReadFormButton
ProgressBar
Image
Slider
Column

快捷方式列表

PySimpleGUI 也有两种类型的元素快捷方式。 一种类型只是相同元素的其他名称(例如,T 而不是 Text)。 第二种类型使用特定设置配置元素,从而无需指定所有参数(例如,Submit 是一个文本为“Submit”的按钮)

T = Text
Txt = Text
In = InputText
Input = IntputText
Combo = InputCombo
DropDown = InputCombo
Drop = InputCombo

按钮快捷方式

许多常用按钮已实现为快捷方式。 这些包括

FolderBrowse
FileBrowse
FileSaveAs
Save
Submit
OK
Ok
Cancel
Quit
Exit
Yes
No

还有更多通用按钮功能的快捷方式。

SimpleButton
ReadFormButton
RealtimeButton

这些是你可以从 PySimpleGUI 中选择的所有 GUI 小部件。 如果其中一个不在这些列表中,它就不会出现在你的表单布局中。

GUI 设计模式

在 GUI 中往往不会改变的是设置和显示窗口的调用。元素的布局是因程序而异的。

这是上面示例中的代码,移除了布局

import PySimpleGUI as sg

form = sg.FlexForm('Simple data entry form')
# Define your form here (it's a list of lists)
button, values = form.LayoutAndRead(layout)

大多数 GUI 的流程是

  • 创建表单对象
  • 将 GUI 定义为列表的列表
  • 显示 GUI 并获取结果

这些是你在 PySimpleGUI 的设计模式中逐行看到的内容。

GUI 布局

要创建你的自定义 GUI,首先将你的表单分解为行,因为表单是一次定义一行。 然后,一个接一个地放置元素,从左到右工作。

结果是一个“列表的列表”,如下所示

layout = [  [Text('Row 1')],
            [Text('Row 2'), Checkbox('Checkbox 1', OK()), Checkbox('Checkbox 2'), OK()] ]

此布局生成此窗口

PySimpleGUI custom data entry form

显示 GUI

一旦你完成了布局,并且复制了设置和显示表单的代码行,就该显示表单并从用户那里获取值了。

这是显示表单并提供结果的代码行

button, values = form.LayoutAndRead(layout)

表单返回两个值:单击的按钮的文本和用户输入到表单中的值列表。

如果显示示例表单,并且用户除了单击确定按钮之外什么也不做,则结果将是

button == 'OK'
values == [False, False]

复选框元素返回 True 或 False 的值。 由于复选框默认为未选中,因此返回的两个值均为 False。

显示结果

一旦你从 GUI 中获得了这些值,最好检查一下变量中的值。与其使用 print 语句打印出来,不如坚持 GUI 的想法并将数据输出到窗口。

PySimpleGUI 有许多消息框可供选择。 传递给消息框的数据显示在窗口中。 该函数接受任意数量的参数。 你可以简单地指示你想在调用中看到的所有变量。

PySimpleGUI 中最常用的消息框是 MsgBox。 要显示前面示例中的结果,请编写

MsgBox('The GUI returned:', button, values)

将它们放在一起

现在你已经了解了基础知识,让我们将包含尽可能多的 PySimpleGUI 元素的表单放在一起。 此外,为了使其外观更好,我们将“外观”更改为绿色和棕褐色配色方案。

import PySimpleGUI as sg

sg.ChangeLookAndFeel('GreenTan')

form = sg.FlexForm('Everything bagel', default_element_size=(40, 1))

column1 = [[sg.Text('Column 1', background_color='#d3dfda', justification='center', size=(10,1))],
           [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 1')],
           [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 2')],
           [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 3')]]
layout = [
    [sg.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25))],
    [sg.Text('Here is some text.... and a place to enter text')],
    [sg.InputText('This is my text')],
    [sg.Checkbox('My first checkbox!'), sg.Checkbox('My second checkbox!', default=True)],
    [sg.Radio('My first Radio!     ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")],
    [sg.Multiline(default_text='This is the default Text should you decide not to type anything', size=(35, 3)),
     sg.Multiline(default_text='A second multi-line', size=(35, 3))],
    [sg.InputCombo(('Combobox 1', 'Combobox 2'), size=(20, 3)),
     sg.Slider(range=(1, 100), orientation='h', size=(34, 20), default_value=85)],
    [sg.Listbox(values=('Listbox 1', 'Listbox 2', 'Listbox 3'), size=(30, 3)),
     sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=25),
     sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=75),
     sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=10),
     sg.Column(column1, background_color='#d3dfda')],
    [sg.Text('_'  * 80)],
    [sg.Text('Choose A Folder', size=(35, 1))],
    [sg.Text('Your Folder', size=(15, 1), auto_size_text=False, justification='right'),
     sg.InputText('Default Folder'), sg.FolderBrowse()],
    [sg.Submit(), sg.Cancel()]
     ]

button, values = form.LayoutAndRead(layout)
sg.MsgBox(button, values)

这似乎有很多代码,但是尝试直接在 tkinter 中编写相同的 GUI 布局,你很快就会意识到它是多么的小。

PySimpleGUI advanced custom data entry form

最后一行代码打开一个消息框。 它是这样的

PySimpleGUI custom message box

消息框调用的每个参数都显示在新的一行上。 消息框中有两行文本; 第二行很长,并且换行多次

花点时间将结果值与 GUI 配对,以了解如何创建和返回结果。

将 GUI 添加到你的程序或脚本

如果你的脚本使用命令行,则不必为了添加 GUI 而放弃它。 一个简单的解决方案是,如果在命令行上没有给出任何参数,则运行 GUI。 否则,像今天一样执行命令行。

只需要这种逻辑

if len(sys.argv) == 1:
	# collect arguments from GUI
else:
    # collect arguements from sys.argv

快速启动并运行 GUI 的最简单方法是从 PySimpleGUI Cookbook 中复制和修改一个配方。

玩得开心!为你厌倦的手动运行脚本增添乐趣。花 5 或 10 分钟时间玩玩示例脚本。你可能会发现已经存在一个完全符合你需求的脚本。如果没有,你会发现创建自己的脚本非常简单。即使你真的迷失了,也只投入了 10 分钟。

资源

安装

PySimpleGUI 可以在运行 tkinter 的所有系统上运行,包括 Raspberry Pi,并且需要 Python 3

pip install PySimpleGUI

文档

标签

24 条评论

感谢你写了这篇文章。我永远都是一个初学者,因为我对严肃的编程不感兴趣。只是喜欢涂鸦。在过去的几周里,我一直在考虑尝试运行一些 Windows 下提供的非常简单的“编程”/创意包。

甚至 HTA 也出现在我的脑海中。一直在考虑在 WINE 或虚拟化下这样做。Linux 根本不迎合简单... 即使 bash 也可能被过度设计。PySimpleGUI 看起来很完美(对于某些解决方案)。这可能会帮助我更认真地使用 python。

这是对一个一直困扰我的问题的绝佳解决方案的介绍。我的代码只有两个小问题。

1. 由于该库需要 Python 3,所以第一行必须是

#! /usr/bin/python3

2. 同样,对于 Python 3,你必须使用 pip3 进行安装。否则它最终会进入 Python2 的库集合中。

现在,将此与 psycopg2 结合以在数据库中插入和更新记录的最有效方法是什么?还要考虑到表已被某种程度地规范化,因此每条记录可能分布在两个或三个不同的表中,并且某些字段的值列表必须从静态数据表中获取。

如果问题/应用程序有一个 GUI 或可以从 GUI 中受益,那么 PySimpleGUI 是一个不错的起点。如果不合适,你可以快速排除它并继续前进。

如果项目看起来可能是一个候选者,花 2 分钟浏览示例集以寻找大致匹配的项。复制、粘贴并运行示例代码。然后就是修改代码以匹配你的应用程序的问题。

目标是使向软件添加一个像样的外观的 GUI 变得轻而易举。如果在教育中更早地向学生介绍 GUI,并且使其足够简单以供初学者使用,那就太好了。

我对你的建议是投入并尝试各种东西。让某个东西运行起来。让任何东西运行起来。然后修改它,甚至重新开始。关键是你有一个工作环境,一张空白的画布。

看了看,它不适合我。虽然从静态表中检索 id 和显示文本非常容易,但我只需要在列表框中显示文本,但返回与选择匹配的 id,因为这将存储在新记录中。也许这可以作为未来版本的有用增强功能?

回复 by PySimpleGUI

如果“表格”是你需要交互的基本内容,那么 PySimpleGUI 还无法提供一种以交互方式执行此操作的方法。

显示表格相对容易,结果也很好
https://user-images.githubusercontent.com/13696193/44960497-c667fd80-ae…

这是如果你想尝试的代码

layout = [[sg.T('表格测试')]]
for i in range(20)
row = [sg.T(f'行 {i} ', size=(10,1))]
layout.append([sg.T(f'{i}{j}', size=(4,1), background_color='white', pad=(1,1)) for j in range(10)])
sg.FlexForm('表格').LayoutAndRead(layout)

有两个缺失的功能使得此软件包不是数据库类型操作的最佳选择
1. 表格
2. 可滚动窗口

我所知道的 tkinter 中没有“表格”小部件。我研究了一些提议的解决方案,但还没有一个脱颖而出。第一步是使 Column Element 可滚动。

应该注意的是,PySimpleGUI 的主要任务是实现“简单的 GUI”。

回复 by Robert McConnell (未验证)

如果您有功能创意或发现限制,我建议您编写一个问题并将其发布在 GitHub 站点上。

我对您在 Listbox 上尝试的操作感到困惑。在这些事情上进行沟通的最佳方式是通过 GitHub。

回复 by Robert McConnell (未验证)

这个过程很简单。我有一个铁路表,它永远不会改变。它包括一个键 (id)、长名称和短名称。因此,我的两个最重要的 CSV 格式的记录将是

1, 宾夕法尼亚铁路, PRR
2, 库德斯波特和波特艾勒格尼铁路, CPA

我做一个 SQL 选择来获取 id 和短名称以获得一个选择列表,然后将其显示在列表框中。一旦用户选择,我需要返回 id 以存储在新记录中。

我无法接受 GitHub 的服务条款,所以这甚至不是一个遥远的可能性。

回复 by PySimpleGUI

明白了。刚刚完成创建可滚动的 Column Elements,这为表格和您描述的应用程序铺平了道路。

是什么 GitHub 服务条款阻止了您?也许它的陈述不正确。

回复 by Robert McConnell (未验证)

哪些条款?我几乎不知道从哪里开始。但让我给你前三个。

1 Q 节。赔偿:如果某个白痴决定因为感觉受到轻视或因为他想窃取我的工作而起诉我,我将不得不卖掉我拥有的一切,以支付任何可以回应该投诉的律师的预留费。在这种情况下,我无法赔偿任何人。如果您认为这种情况不太可能发生,请阅读 JMRI 的历史。

此外,根据 B3 段,他们希望青少年也遵守这一要求,尽管我认为法院不会允许这样做,但孩子们的父母要了解这一点仍然非常昂贵。

2. B4 段说,当网站被黑客入侵时,用户仍然对违规行为负责,即使他们无法控制后端安全性。这对于没有实际谈判的标准商业合同来说太典型了。它变成了一个单方面的文件,所有的风险都倾倒在用户身上。这给我带来了一个接受或放弃的决定,我选择放弃它。

3. R 节未能以任何有意义的方式定义“重大变更”,只列出了一个微弱的例子。这为律师留下了太多的回旋余地,他们完全有可能决定出售所有收集到的客户信息,在半夜完成对网页的更改,并在太阳升起之前将钱存入银行。既然他们被微软拥有,我不得不认为这是一个非常真实的可能性。

回复 by PySimpleGUI

它能在 KDE/Plasma 环境中工作吗?只是尝试将一个示例 + PySimpleGUI.py 复制到一个目录中并运行,但我只看到一个非常小的“十字”,像鼠标指针一样,没有更多了...

我将在 GitHub 上打开一个 issue。请访问并输入更多信息以便进行调试(Python 版本、Linux 版本等)。

回复 by Barlafuss (未验证)

已访问。
问题主要按照 Robert McConnell 的建议(谢谢!)解决了。

回复 by PySimpleGUI 上打开一个 issue

PySimpleGUI 似乎非常适合我需要构建的小型 GUI 应用程序,但它_必须_基于 Python 2.7。下面的代码是我必须添加到 PySimpleGUI.py 顶部的所有代码,再加上(如评论中所述)在 *() 中添加一个函数调用,对于每个 super() 调用(未经 Python 3 测试!)。但是,让我感到困惑的一个“陷阱”是,我不得不将方法调用中的每个 (args) 移动到命名(“关键字 args”)参数之后的位置。这绝对不符合 Python 的惯例,但它可以修复错误...

import platform

sVsn = platform.python_version()[0]

if sVsn == '2'
__metaclass__ = type # Python v.2.X 所需

def fSuprArgs(self)
return () if sVsn != '2' else (self.__class__, self)

# 将 *(fSuprArgs(self)) 作为参数放置在每个 super() 的调用中

你是说你设法让 PySimpleGUI 与 Python 2.7 一起工作了????!

所以,请将文件发布到 GitHub(或您选择的任何其他位置)。这个请求不时出现。本周早些时候我收到一个。

回复 by Noah F San (未验证)

是的,这是我的项目的要求。只需将上面的代码附加到 PySmpleGUI.py 的顶部,在每个 super() 中插入函数调用,如下所示:super(*(fSuprArgs(self))),将所有 *args 移动到出现它的任何参数列表的最后位置,你就完成了。

注意:此网页上的缩进可能会错乱...

我已经以CC-BY-SA协议授权了这些更改,不管这意味着什么,所以请随意使用。

请注意:仅使用 Python 2.7.12 测试过,并且未在 Python 3 上测试!

另外,我发现很多小部件会混淆,因为它们期望第一个参数是颜色值元组,所以我总是填充 (1, 1),这可以防止其他错误。

回复 的评论,作者是 PySimpleGUI

回复我自己:看起来我误解了参数类型基数。下面的链接显示“formal”关键字参数 _可以_ 在 *args 之前,但 *args 绝对不能在 **kwargs 之前,当一起使用时。所以,防止错误的更改仍然是合法的 Python 代码,但当然我不知道它为什么有效。

http://www.network-theory.co.uk/docs/pytut/KeywordArguments.html

回复 by Noah F San (未验证)

我做了所有这些更改,并将 *args 移动到所有函数的末尾。

而且,它奏效了!至少在我尝试的一个简单的表单上是这样。还有更多工作要做。这个结果让我震惊!我非常感谢你!!

回复 by Noah F San (未验证)

最后一条消息...

感谢您的鼓励和编码帮助,我刚刚将 PySimpleGUI27 发布到 PyPI

我进行了大量测试,但我无法测试 PyPI 版本。它应该可以正常工作。你做了一件了不起的事情!

回复 by Noah F San (未验证)

很抱歉我没有更清楚地说明 v.2.7 的更改应该如何工作。虽然我没有使用 v.3.x 进行测试,但相同的 PySimpleGUI 代码 _应该_ 在任何版本下都可以工作。这就是为什么当 version != 2.x 时函数返回一个空元组的原因,因为在 v.3.x 下 super() 调用不需要任何参数。

回复 的评论,作者是 PySimpleGUI

如何添加覆盖应用程序整个窗口的背景图像?我没有在任何地方看到这个功能。只能更改颜色。

主题也不起作用。

sg.ChangeLookAndFeel('BluePurple')
没有任何反应。尝试更改颜色变量也是如此。

如果您使用的是 Mac,您将看不到任何变化。您会看到打印出这条消息
*** 在 Mac 平台上不支持更改外观 ***'

请确保在布局定义之前调用 ChangeLookAndFeel。布局需要知道颜色。

您还可以使用您想要的各个颜色选项调用 SetOptions。Mac 不会阻止调用它。阻止调用 Look and Feel 的原因是按钮颜色在 Mac 上不起作用。

如果问题仍然存在,请随时在 github 上记录一个问题。

回复 的评论,作者是 Mike Kell (未验证)

有没有办法防止多行输入框扩展到操作系统
如果用户按下回车键?
Raspbian Raspberry Pi

既然您没有提到任何崩溃,听起来您的 Read 正常返回并且您只是退出了程序。可能发生的情况是您正在使用 Submit() 或 OK() 按钮。默认情况下,这些按钮有一个名为 bind_return_key 的参数设置为 true。如果您使用的是内置按钮,则尝试添加参数 ... bind_return_key=False... 到调用。或者您可以切换到通过调用类似 Button("Submit") 来创建自己的按钮。像这样的普通按钮不像内置按钮那样将回车键绑定到它们。如果您有其他问题,请访问 github 网站 (www.PySimpleGUI.com) 记录一个问题

回复 的评论,作者是 Curt Wuollet (未验证)

Creative Commons License此作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。
© . All rights reserved.