1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
"""
***************************************************************************
qgssettings.py
---------------------
Date : May 2018
Copyright : (C) 2018 by Denis Rouzaud
Email : denis@opengis.ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
from .metaenum import metaEnumFromValue
from qgis.core import QgsSettings
import qgis # required to get base class of enums
def _qgssettings_enum_value(
self, key, enumDefaultValue, section=QgsSettings.Section.NoSection
):
"""
Return the setting value for a setting based on an enum.
This forces the output to be a valid and existing entry of the enum.
Hence if the setting value is incorrect, the given default value is returned.
:param self: the QgsSettings object
:param key: the setting key
:param enumDefaultValue: the default value as an enum value
:param section: optional section
:return: the setting value
.. note:: The enum needs to be declared with Q_ENUM.
"""
meta_enum = metaEnumFromValue(enumDefaultValue)
if meta_enum is None or not meta_enum.isValid():
# this should not happen
raise ValueError(
"could not get the meta enum for given enum default value (type: {})".format(
enumDefaultValue.__class__
)
)
str_val = self.value(key, meta_enum.valueToKey(enumDefaultValue), str, section)
# need a new meta enum as QgsSettings.value is making a copy and leads to seg fault (probably a PyQt issue)
meta_enum_2 = metaEnumFromValue(enumDefaultValue)
(enu_val, ok) = meta_enum_2.keyToValue(str_val)
if not ok:
enu_val = enumDefaultValue
else:
# cast to the enum class
enu_val = enumDefaultValue.__class__(enu_val)
return enu_val
def _qgssettings_set_enum_value(
self, key, enumValue, section=QgsSettings.Section.NoSection
):
"""
Save the setting value for a setting based on an enum.
This forces the output to be a valid and existing entry of the enum.
The entry is saved as a string.
:param self: the QgsSettings object
:param key: the setting key
:param enumValue: the value to be saved
:param section: optional section
:return: the setting value
.. note:: The enum needs to be declared with Q_ENUM.
"""
meta_enum = metaEnumFromValue(enumValue)
if meta_enum is None or not meta_enum.isValid():
# this should not happen
raise ValueError(
f"could not get the meta enum for given enum default value (type: {type(enumValue)})"
)
self.setValue(key, meta_enum.valueToKey(enumValue), section)
def _qgssettings_flag_value(
self, key, flagDefaultValue, section=QgsSettings.Section.NoSection
):
"""
Return the setting value for a setting based on a flag.
This forces the output to be a valid and existing entry of the enum.
Hence if the setting value is incorrect, the given default value is returned.
:param self: the QgsSettings object
:param key: the setting key
:param flagDefaultValue: the default value as a flag value
:param section: optional section
:return: the setting value
.. note:: The flag needs to be declared with Q_FLAG (not Q_FLAGS).
"""
# There is an issue in SIP, flags.__class__ does not return the proper class
# (e.g. Filters instead of Qgis.LayerFilters)
# dirty hack to get the parent class
__import__(flagDefaultValue.__module__)
baseClass = None
exec(
"baseClass={module}.{flag_class}".format(
module=flagDefaultValue.__module__.replace("_", ""),
flag_class=flagDefaultValue.__class__.__name__,
)
)
meta_enum = metaEnumFromValue(flagDefaultValue, baseClass)
if meta_enum is None or not meta_enum.isValid():
# this should not happen
raise ValueError(
f"could not get the meta enum for given enum default value (type: {type(flagDefaultValue)})"
)
str_val = self.value(key, meta_enum.valueToKeys(flagDefaultValue), str, section)
# need a new meta enum as QgsSettings.value is making a copy and leads to seg fault (probably a PyQt issue)
meta_enum_2 = metaEnumFromValue(flagDefaultValue)
(flag_val, ok) = meta_enum_2.keysToValue(str_val)
if not ok:
flag_val = flagDefaultValue
else:
flag_val = flagDefaultValue.__class__(flag_val)
return flag_val
|
