config¶

Module Contents¶

`Theme`	主题枚举类
`ConfigValidator`	配置校验器
`RangeValidator`	范围校验器
`OptionsValidator`	选项校验器
`BoolValidator`	布尔校验器
`FolderValidator`	文件夹校验器
`FolderListValidator`	文件夹列表校验器
`ColorValidator`	颜色校验器
`ConfigSerializer`	配置序列化器
`EnumSerializer`	枚举类序列化器
`ColorSerializer`	颜色序列化器
`ConfigItem`	配置项
`RangeConfigItem`	取值范围配置项
`OptionsConfigItem`	选项配置项
`ColorConfigItem`	颜色配置项
`QConfig`	配置类

`isDarkTheme`()	当前的应用主题是否为深色模式
`theme`()	返回当前主题

`ALERT`
`qconfig`

ALERT = Multiline-String¶

Show Value

"""
[1;33m📢 Tips:[0m QFluentWidgets Pro is now released. Click [1;96mhttps://qfluentwidgets.com/pages/pro[0m to learn more about it.
"""

class Theme¶

Bases: enum.Enum

主题枚举类

LIGHT = 'Light'¶

DARK = 'Dark'¶

AUTO = 'Auto'¶

class ConfigValidator¶

配置校验器

validate(value)¶: 验证值是否合法

correct(value)¶: 纠正非法值

class RangeValidator(min, max)¶

Bases: ConfigValidator

范围校验器

min¶

max¶

range¶

validate(value)¶: 验证值是否合法

correct(value)¶: 纠正非法值

class OptionsValidator(options)¶

Bases: ConfigValidator

选项校验器

options¶

validate(value)¶: 验证值是否合法

correct(value)¶: 纠正非法值

class BoolValidator¶

Bases: OptionsValidator

布尔校验器

class FolderValidator¶

Bases: ConfigValidator

文件夹校验器

validate(value)¶: 验证值是否合法

correct(value)¶: 纠正非法值

class FolderListValidator¶

Bases: ConfigValidator

文件夹列表校验器

validate(value)¶: 验证值是否合法

correct(value: List[str])¶: 纠正非法值

class ColorValidator(default)¶

Bases: ConfigValidator

颜色校验器

default¶

validate(color)¶: 验证值是否合法

correct(value)¶: 纠正非法值

class ConfigSerializer¶

配置序列化器

serialize(value)¶: 序列化配置项的值

deserialize(value)¶: 从配置文件中反序列化配置项

class EnumSerializer(enumClass)¶

Bases: ConfigSerializer

枚举类序列化器

enumClass¶

serialize(value)¶: 序列化配置项的值

deserialize(value)¶: 从配置文件中反序列化配置项

class ColorSerializer¶

Bases: ConfigSerializer

颜色序列化器

serialize(value: PyQt5.QtGui.QColor)¶: 序列化配置项的值

deserialize(value)¶: 从配置文件中反序列化配置项

class ConfigItem(group, name, default, validator=None, serializer=None, restart=False)¶

Bases: PyQt5.QtCore.QObject

配置项

valueChanged¶

group¶

name¶

validator¶

serializer¶

property value¶
get the value of config item

restart¶

defaultValue¶

property key¶
get the config key separated by `.`

__str__()¶

serialize()¶

deserializeFrom(value)¶

class RangeConfigItem(group, name, default, validator=None, serializer=None, restart=False)¶

Bases: ConfigItem

取值范围配置项

property range¶
get the available range of config

__str__()¶

class OptionsConfigItem(group, name, default, validator=None, serializer=None, restart=False)¶

Bases: ConfigItem

选项配置项

property options¶

__str__()¶

class ColorConfigItem(group, name, default, restart=False)¶

Bases: ConfigItem

颜色配置项

__str__()¶

class QConfig¶

Bases: PyQt5.QtCore.QObject

配置类

appRestartSig¶

themeChanged¶

themeChangedFinished¶

themeColorChanged¶

themeMode¶

themeColor¶

file¶

get(item)¶: 返回配置项的值

set(item, value, save=True, copy=True)¶

设置配置项的值

参数¶

item: ConfigItem: 配置项
value:: 配置项的新值
save: bool: 是否将当前改变保存到配置文件中
copy: bool: whether to deep copy the new value

toDict(serialize=True)¶: 将配置转换为字典

save()¶: 保存配置

load(file=None, config=None)¶

载入配置

参数¶

file: str or Path: json 配置文件的路径
config: Config: 将被初始化的配置对象

property theme¶
get theme mode, can be `Theme.Light` or `Theme.Dark`

qconfig¶

isDarkTheme()¶: 当前的应用主题是否为深色模式

theme()¶: 返回当前主题