Python PyQt4 函数用于保存和恢复 UI 控件值？
在我尝试自己写Python PyQt4模块函数之前，我想问问有没有人愿意分享这样的函数。
在我很多使用PyQt4和qtDesigner构建的Python程序中，我会用QSettings这个方法来保存和恢复用户界面（UI）的状态，以及所有控件在关闭和启动时的值。
这个例子展示了我如何保存和恢复一些文本框、复选框和单选按钮的内容。
有没有人有一个函数，可以遍历整个用户界面，找到所有的控件和它们的状态，并把这些信息保存下来（比如叫做guisave()），还有一个函数可以把它们恢复（比如叫做guirestore()）？
我的关闭事件大概是这样的：
#---------------------------------------------
# close by x OR call to self.close
#---------------------------------------------
def closeEvent(self, event): # user clicked the x or pressed alt-F4...
UI_VERSION = 1 # increment this whenever the UI changes significantly
programname = os.path.basename(__file__)
programbase, ext = os.path.splitext(programname) # extract basename and ext from filename
settings = QtCore.QSettings("company", programbase)
settings.setValue("geometry", self.saveGeometry()) # save window geometry
settings.setValue("state", self.saveState(UI_VERSION)) # save settings (UI_VERSION is a constant you should increment when your UI changes significantly to prevent attempts to restore an invalid state.)
# save ui values, so they can be restored next time
settings.setValue("lineEditUser", self.lineEditUser.text());
settings.setValue("lineEditPass", self.lineEditPass.text());
settings.setValue("checkBoxReplace", self.checkBoxReplace.checkState());
settings.setValue("checkBoxFirst", self.checkBoxFirst.checkState());
settings.setValue("radioButton1", self.radioButton1.isChecked());
sys.exit() # prevents second call
我的主窗口初始化大概是这样的：
def __init__(self, parent = None):
# initialization of the superclass
super(QtDesignerMainWindow, self).__init__(parent)
# setup the GUI --> function generated by pyuic4
self.setupUi(self)
#---------------------------------------------
# restore gui position and restore fields
#---------------------------------------------
UI_VERSION = 1
settings = QtCore.QSettings("company", programbase) # http://pyqt.sourceforge.net/Docs/PyQt4/pyqt_qsettings.html
self.restoreGeometry(settings.value("geometry"))
self.restoreState(settings.value("state"),UI_VERSION)
self.lineEditUser.setText(str(settings.value("lineEditUser"))) # restore lineEditFile
self.lineEditPass.setText(str(settings.value("lineEditPass"))) # restore lineEditFile
if settings.value("checkBoxReplace") != None:
self.checkBoxReplace.setCheckState(settings.value("checkBoxReplace")) # restore checkbox
if settings.value("checkBoxFirst") != None:
self.checkBoxFirst.setCheckState(settings.value("checkBoxFirst")) # restore checkbox
value = settings.value("radioButton1").toBool()
self.ui.radioButton1.setChecked(value)
8 个回答
4
这里有一个更好的代码版本，它使用了QTabWidget，并把所有内容放进一个类里，这样使用起来更方便：
qt_utils.py：
from PyQt5 import QtGui
from PyQt5.QtWidgets import QComboBox, QCheckBox, QLineEdit,\
QRadioButton, QSpinBox, QSlider, QListWidget, QTabWidget
from PyQt5.QtCore import QSettings
from distutils.util import strtobool
import inspect
class QMainWindow(QtGui.QMainWindow):
companie_name = 'CompanieName'
software_name = 'SoftwareName'
settings_ui_name = 'defaultUiwidget'
settings_ui_user_name = 'user'
_names_to_avoid = {}
def __init__(self, parent=None):
super(QMainWindow, self).__init__(parent)
self.settings = QSettings(self.companie_name, self.software_name)
def closeEvent(self, e):
self._gui_save()
@classmethod
def _get_handled_types(cls):
return QComboBox, QLineEdit, QCheckBox, QRadioButton, QSpinBox, QSlider, QListWidget, QTabWidget
@classmethod
def _is_handled_type(cls, widget):
return any(isinstance(widget, t) for t in cls._get_handled_types())
def _gui_save(self):
"""
save "ui" controls and values to registry "setting"
:return:
"""
name_prefix = f"{self.settings_ui_name}/"
self.settings.setValue(name_prefix + "geometry", self.saveGeometry())
for name, obj in inspect.getmembers(self):
if not self._is_handled_type(obj):
continue
name = obj.objectName()
value = None
if isinstance(obj, QComboBox):
index = obj.currentIndex() # get current index from combobox
value = obj.itemText(index) # get the text for current index
elif isinstance(obj, QTabWidget):
value = obj.currentIndex()
elif isinstance(obj, QLineEdit):
value = obj.text()
elif isinstance(obj, QCheckBox):
value = obj.isChecked()
elif isinstance(obj, QRadioButton):
value = obj.isChecked()
elif isinstance(obj, QSpinBox):
value = obj.value()
elif isinstance(obj, QSlider):
value = obj.value()
elif isinstance(obj, QListWidget):
self.settings.beginWriteArray(name)
for i in range(obj.count()):
self.settings.setArrayIndex(i)
self.settings.setValue(name_prefix + name, obj.item(i).text())
self.settings.endArray()
if value is not None:
self.settings.setValue(name_prefix + name, value)
def _gui_restore(self):
"""
restore "ui" controls with values stored in registry "settings"
:return:
"""
name_prefix = f"{self.settings_ui_name}/"
geometry_value = self.settings.value(name_prefix + "geometry")
if geometry_value:
self.restoreGeometry(geometry_value)
for name, obj in inspect.getmembers(self):
if not self._is_handled_type(obj):
continue
if name in self._names_to_avoid:
continue
name = obj.objectName()
value = None
if not isinstance(obj, QListWidget):
value = self.settings.value(name_prefix + name)
if value is None:
continue
if isinstance(obj, QComboBox):
index = obj.findText(value) # get the corresponding index for specified string in combobox
if index == -1: # add to list if not found
obj.insertItems(0, [value])
index = obj.findText(value)
obj.setCurrentIndex(index)
else:
obj.setCurrentIndex(index) # preselect a combobox value by index
elif isinstance(obj, QTabWidget):
try:
value = int(value)
except ValueError:
value = 0
obj.setCurrentIndex(value)
elif isinstance(obj, QLineEdit):
obj.setText(value)
elif isinstance(obj, QCheckBox):
obj.setChecked(strtobool(value))
elif isinstance(obj, QRadioButton):
obj.setChecked(strtobool(value))
elif isinstance(obj, QSlider):
obj.setValue(int(value))
elif isinstance(obj, QSpinBox):
obj.setValue(int(value))
elif isinstance(obj, QListWidget):
size = self.settings.beginReadArray(name_prefix + name)
for i in range(size):
self.settings.setArrayIndex(i)
value = self.settings.value(name_prefix + name)
if value is not None:
obj.addItem(value)
self.settings.endArray()
def _add_setting(self, name, value):
name_prefix = f"{self.settings_ui_user_name}/"
self.settings.setValue(name_prefix + name, value)
def _get_setting(self, name):
name_prefix = f"{self.settings_ui_user_name}/"
return self.settings.value(name_prefix + name)
下面是一个使用的例子：
import qt_utils
class MyMaine(qt_utils.QMainWindow, Ui_MainWindow):
companie_name = 'Name'
software_name = 'softName'
_names_to_avoid = {'my_widget_name_not_to_save'}
def __init__(self, parent=None):
super(MyMaine, self).__init__(parent)
self.setupUi(self)
self._gui_restore()
4
我正在为QListWidget添加更新功能。
在guisave中：
if isinstance(obj, QListWidget):
name = obj.objectName()
settings.beginWriteArray(name)
for i in range(obj.count()):
settings.setArrayIndex(i)
settings.setValue(name, obj.item(i).text())
settings.endArray()
在guirestore中：
if isinstance(obj, QListWidget):
name = obj.objectName()
size = settings.beginReadArray(name)
for i in range(size):
settings.setArrayIndex(i)
value = settings.value(name) # get stored value from registry
if value != None:
obj.addItem(value)
settings.endArray()
5
谢谢你，Panofish，还有大家。
我来更新一下关于QSlider和QSpinBox的内容。
这部分内容很小，也很简单。
在guisave中，你可以添加：
if isinstance(obj, QSpinBox):
name = obj.objectName()
value = obj.value() # get stored value from registry
settings.setValue(name, value)
if isinstance(obj, QSlider):
name = obj.objectName()
value = obj.value() # get stored value from registry
settings.setValue(name, value)
在guirestore中，你可以添加：
if isinstance(obj, QSlider):
name = obj.objectName()
value = settings.value(name) # get stored value from registry
if value != None:
obj. setValue(int(value)) # restore value from registry
if isinstance(obj, QSpinBox):
name = obj.objectName()
value = settings.value(name) # get stored value from registry
if value != None:
obj. setValue(int(value)) # restore value from registry
11
这是一个更新过的代码片段，最初是mr. Panofish分享的。这些很棒的功能是一样的，但现在可以在更新版本的PyQt和Python上使用，只需做一些小改动。感谢mr. Panofish，开源万岁！:)
更新内容：
- 更新为Python3和PyQt5
- 增加了几何形状的保存和恢复功能
- 增加了单选按钮的保存和恢复功能
将SetCheckState()替换为SetChecked()，以避免三态状态
def guisave(self): # Save geometry self.settings.setValue('size', self.size()) self.settings.setValue('pos', self.pos()) for name, obj in inspect.getmembers(ui): # if type(obj) is QComboBox: # this works similar to isinstance, but missed some field... not sure why? if isinstance(obj, QComboBox): name = obj.objectName() # get combobox name index = obj.currentIndex() # get current index from combobox text = obj.itemText(index) # get the text for current index settings.setValue(name, text) # save combobox selection to registry if isinstance(obj, QLineEdit): name = obj.objectName() value = obj.text() settings.setValue(name, value) # save ui values, so they can be restored next time if isinstance(obj, QCheckBox): name = obj.objectName() state = obj.isChecked() settings.setValue(name, state) if isinstance(obj, QRadioButton): name = obj.objectName() value = obj.isChecked() # get stored value from registry settings.setValue(name, value) def guirestore(self): # Restore geometry self.resize(self.settings.value('size', QtCore.QSize(500, 500))) self.move(self.settings.value('pos', QtCore.QPoint(60, 60))) for name, obj in inspect.getmembers(ui): if isinstance(obj, QComboBox): index = obj.currentIndex() # get current region from combobox # text = obj.itemText(index) # get the text for new selected index name = obj.objectName() value = (settings.value(name)) if value == "": continue index = obj.findText(value) # get the corresponding index for specified string in combobox if index == -1: # add to list if not found obj.insertItems(0, [value]) index = obj.findText(value) obj.setCurrentIndex(index) else: obj.setCurrentIndex(index) # preselect a combobox value by index if isinstance(obj, QLineEdit): name = obj.objectName() value = (settings.value(name).decode('utf-8')) # get stored value from registry obj.setText(value) # restore lineEditFile if isinstance(obj, QCheckBox): name = obj.objectName() value = settings.value(name) # get stored value from registry if value != None: obj.setChecked(strtobool(value)) # restore checkbox if isinstance(obj, QRadioButton): name = obj.objectName() value = settings.value(name) # get stored value from registry if value != None: obj.setChecked(strtobool(value))
30
好的，我写了一个模块，里面有两个函数来实现我之前提到的功能。其实并不复杂，一旦我搞明白了，就发现它能节省很多时间，特别是在创建新的pyqt图形界面程序时，想要在不同的使用会话之间保存控件的值。我现在只编写了文本输入框（lineEdit）、复选框（checkBox）和下拉框（combobox）的代码。如果其他人想要添加或改进（比如添加单选按钮等等），我相信包括我在内的其他人都会很感激。
#===================================================================
# Module with functions to save & restore qt widget values
# Written by: Alan Lilly
# Website: http://panofish.net
#===================================================================
import sys
from PyQt4.QtCore import *
from PyQt4.QtGui import *
import inspect
#===================================================================
# save "ui" controls and values to registry "setting"
# currently only handles comboboxes editlines & checkboxes
# ui = qmainwindow object
# settings = qsettings object
#===================================================================
def guisave(ui, settings):
#for child in ui.children(): # works like getmembers, but because it traverses the hierarachy, you would have to call guisave recursively to traverse down the tree
for name, obj in inspect.getmembers(ui):
#if type(obj) is QComboBox: # this works similar to isinstance, but missed some field... not sure why?
if isinstance(obj, QComboBox):
name = obj.objectName() # get combobox name
index = obj.currentIndex() # get current index from combobox
text = obj.itemText(index) # get the text for current index
settings.setValue(name, text) # save combobox selection to registry
if isinstance(obj, QLineEdit):
name = obj.objectName()
value = obj.text()
settings.setValue(name, value) # save ui values, so they can be restored next time
if isinstance(obj, QCheckBox):
name = obj.objectName()
state = obj.checkState()
settings.setValue(name, state)
#===================================================================
# restore "ui" controls with values stored in registry "settings"
# currently only handles comboboxes, editlines &checkboxes
# ui = QMainWindow object
# settings = QSettings object
#===================================================================
def guirestore(ui, settings):
for name, obj in inspect.getmembers(ui):
if isinstance(obj, QComboBox):
index = obj.currentIndex() # get current region from combobox
#text = obj.itemText(index) # get the text for new selected index
name = obj.objectName()
value = unicode(settings.value(name))
if value == "":
continue
index = obj.findText(value) # get the corresponding index for specified string in combobox
if index == -1: # add to list if not found
obj.insertItems(0,[value])
index = obj.findText(value)
obj.setCurrentIndex(index)
else:
obj.setCurrentIndex(index) # preselect a combobox value by index
if isinstance(obj, QLineEdit):
name = obj.objectName()
value = unicode(settings.value(name)) # get stored value from registry
obj.setText(value) # restore lineEditFile
if isinstance(obj, QCheckBox):
name = obj.objectName()
value = settings.value(name) # get stored value from registry
if value != None:
obj.setCheckState(value) # restore checkbox
#if isinstance(obj, QRadioButton):
################################################################
if __name__ == "__main__":
# execute when run directly, but not when called as a module.
# therefore this section allows for testing this module!
#print "running directly, not as a module!"
sys.exit()