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
|
import typing
from typing import Any, Union, Tuple, Dict, List, Mapping, Sequence
from AnyQt.QtCore import QSettings
if typing.TYPE_CHECKING: # pragma: no cover
_T = typing.TypeVar("_T")
#: Specification for an value in the return value of readArray
#: Can be single type or a tuple of (type, defaultValue) where default
#: value is used where a stored entry is missing.
ValueSpec = Union[
typing.Type[_T], Tuple[typing.Type[_T], _T],
]
def QSettings_readArray(settings, key, scheme):
# type: (QSettings, str, Mapping[str, ValueSpec]) -> List[Dict[str, Any]]
"""
Read the whole array from a QSettings instance.
Parameters
----------
settings : QSettings
key : str
scheme : Dict[str, ValueSpec]
Example
-------
>>> s = QSettings("./login.ini")
>>> QSettings_readArray(s, "array", {"username": str, "password": str})
[{"username": "darkhelmet", "password": "1234"}}
>>> QSettings_readArray(
... s, "array", {"username": str, "noexist": (str, "~||~")})
...
[{"username": "darkhelmet", "noexist": "~||~"}}
"""
items = []
count = settings.beginReadArray(key)
def normalize_spec(spec):
if isinstance(spec, tuple):
if len(spec) != 2:
raise ValueError("len(spec) != 2")
type_, default = spec
else:
type_, default = spec, None
return type_, default
specs = {
name: normalize_spec(spec) for name, spec in scheme.items()
}
for i in range(count):
settings.setArrayIndex(i)
item = {}
for key, (type_, default) in specs.items():
value = settings.value(key, type=type_, defaultValue=default)
item[key] = value
items.append(item)
settings.endArray()
return items
def QSettings_writeArray(settings, key, values):
# type: (QSettings, str, Sequence[Mapping[str, Any]]) -> None
"""
Write an array of values to a QSettings instance.
Parameters
----------
settings : QSettings
key : str
values : List[Dict[str, Any]]
Examples
--------
>>> s = QSettings("./login.ini")
>>> QSettings_writeArray(
... s, "array", [{"username": "darkhelmet", "password": "1234"}]
... )
"""
settings.beginWriteArray(key, len(values))
for i in range(len(values)):
settings.setArrayIndex(i)
for key_, val in values[i].items():
settings.setValue(key_, val)
settings.endArray()
def QSettings_writeArrayItem(settings, key, index, item, arraysize):
# type: (QSettings, str, int, Mapping[str, Any], int) -> None
"""
Write/update an array item at index.
Parameters
----------
settings : QSettings
key : str
index : int
item : Dict[str, Any]
arraysize : int
The full array size. Note that the array will be truncated to this
size.
"""
settings.beginWriteArray(key, arraysize)
settings.setArrayIndex(index)
for key_, val in item.items():
settings.setValue(key_, val)
settings.endArray()
|
