Mercurial > libervia-backend

comparison sat/tools/common/data_format.py @ 2562:26edcf3a30eb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/tools/common/data_format.py@0046283a285d
children 56f94936df1e
comparison
equal deleted inserted replaced
2561:bd30dc3ffe5a 2562:26edcf3a30eb
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT: a jabber client
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 """ tools common to backend and frontends """
21 # FIXME: json may be more appropriate than manual serialising like done here
22
23 from sat.core import exceptions
24
25 def dict2iter(name, dict_, pop=False):
26 """iterate into a list serialised in a dict
27
28 name is the name of the key.
29 Serialisation is done with [name] [name#1] [name#2] and so on
30 e.g.: if name is 'group', keys are group, group#1, group#2, ...
31 iteration stop at first missing increment
32 Empty values are possible
33 @param name(unicode): name of the key
34 @param dict_(dict): dictionary with the serialised list
35 @param pop(bool): if True, remove the value from dict
36 @return iter: iterate through the deserialised list
37 """
38 if pop:
39 get=lambda d,k: d.pop(k)
40 else:
41 get=lambda d,k: d[k]
42
43 try:
44 yield get(dict_,name)
45 except KeyError:
46 return
47 else:
48 idx = 1
49 while True:
50 try:
51 yield get(dict_,u'{}#{}'.format(name, idx))
52 except KeyError:
53 return
54 else:
55 idx += 1
56
57 def dict2iterdict(name, dict_, extra_keys, pop=False):
58 """like dict2iter but yield dictionaries
59
60 params are like in [dict2iter], extra_keys is used for extra dict keys.
61 e.g. dict2iterdict(comments, mb_data, ('node', 'service')) will yield dicts like:
62 {u'comments': u'value1', u'node': u'value2', u'service': u'value3'}
63 """
64 # FIXME: this format seem overcomplicated, it may be more appropriate to use json here
65 if pop:
66 get=lambda d,k: d.pop(k)
67 else:
68 get=lambda d,k: d[k]
69 for idx, main_value in enumerate(dict2iter(name, dict_, pop=pop)):
70 ret = {name: main_value}
71 for k in extra_keys:
72 ret[k] = get(dict_, u'{}{}_{}'.format(name, (u'#' + unicode(idx)) if idx else u'', k))
73 yield ret
74
75 def iter2dict(name, iter_, dict_=None, check_conflict=True):
76 """Fill a dict with values from an iterable
77
78 name is used to serialise iter_, in the same way as in [dict2iter]
79 Build from the tags a dict using the microblog data format.
80
81 @param name(unicode): key to use for serialisation
82 e.g. "group" to have keys "group", "group#1", "group#2", ...
83 @param iter_(iterable): values to store
84 @param dict_(None, dict): dictionary to fill, or None to create one
85 @param check_conflict(bool): if True, raise an exception in case of existing key
86 @return (dict): filled dict, or newly created one
87 @raise exceptions.ConflictError: a needed key already exists
88 """
89 if dict_ is None:
90 dict_ = {}
91 for idx, value in enumerate(iter_):
92 if idx == 0:
93 key = name
94 else:
95 key = u'{}#{}'.format(name, idx)
96 if check_conflict and key in dict_:
97 raise exceptions.ConflictError
98 dict_[key] = value
99 return dict
100
101 def getSubDict(name, dict_, sep=u'_'):
102 """get a sub dictionary from a serialised dictionary
103
104 look for keys starting with name, and create a dict with it
105 eg.: if "key" is looked for, {'html': 1, 'key_toto': 2, 'key_titi': 3} will return:
106 {None: 1, toto: 2, titi: 3}
107 @param name(unicode): name of the key
108 @param dict_(dict): dictionary with the serialised list
109 @param sep(unicode): separator used between name and subkey
110 @return iter: iterate through the deserialised items
111 """
112 for k,v in dict_.iteritems():
113 if k.startswith(name):
114 if k == name:
115 yield None, v
116 else:
117 if k[len(name)] != sep:
118 continue
119 else:
120 yield k[len(name)+1:], v