-
Notifications
You must be signed in to change notification settings - Fork 22
/
__init__.py
555 lines (502 loc) · 22.4 KB
/
__init__.py
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
#! /usr/bin/env python -tt
# vim: set fileencoding=utf-8
"""
Hierarchical Yaml Python Config
===============================
A simple python lib allowing hierarchical config files in YAML syntax.
License
-------
(c) 2014 - 2024 Klaus Zerwes zero-sys.net
This package is free software.
This software is licensed under the terms of the
GNU GENERAL PUBLIC LICENSE version 3 or later,
as published by the Free Software Foundation.
See https://www.gnu.org/licenses/gpl.html
"""
from __future__ import unicode_literals
import sys
import os
import logging
import re
import io
import copy
import yaml
from yaml import parser
from jinja2 import Environment, Undefined, DebugUndefined, StrictUndefined, TemplateError
from . import odyldo
__all__ = [
'load',
'dump',
'HiYaPyCo',
'HiYaPyCoInvocationException',
'HiYaPyCoImplementationException',
]
from . import version
__version__ = version.VERSION
logger = logging.getLogger(__name__)
_USEDEFAULTYAMLLOADER = False
class HiYaPyCoInvocationException(Exception):
"""dummy Exception raised on wrong invocation"""
pass
class HiYaPyCoImplementationException(Exception):
"""dummy Exception raised if we are unable to merge some YAML stuff"""
pass
primitiveTypes = (int, str, bool, float)
# pylint: disable=superfluous-parens
strTypes = (str)
listTypes = (list, tuple)
# you may set this to something suitable for you
jinja2env = Environment(undefined=Undefined)
METHODS = { 'METHOD_SIMPLE':0x0001, 'METHOD_MERGE':0x0002, 'METHOD_SUBSTITUTE':0x0003, }
METHOD_SIMPLE = METHODS['METHOD_SIMPLE']
METHOD_MERGE = METHODS['METHOD_MERGE']
METHOD_SUBSTITUTE = METHODS['METHOD_SUBSTITUTE']
class HiYaPyCo:
"""Main class"""
# pylint: disable=too-many-instance-attributes disable=too-many-branches disable=too-many-statements
def __init__(self, *args, **kwargs):
"""
args: YAMLfile(s)
kwargs:
* method: one of
hiyapyco.METHOD_SIMPLE | hiyapyco.METHOD_MERGE | hiyapyco.METHOD_SUBSTITUTE
* mergelists: boolean (default: True) try to merge lists
(only makes sense if hiyapyco.METHOD_MERGE or hiyapyco.METHOD_SUBSTITUTE)
* interpolate: boolean (default: False)
* castinterpolated: boolean (default: False) try to cast values after interpolating
* usedefaultyamlloader: boolean (default: False)
* dereferenceyamlanchors: boolean (default: True)
* encoding: (default: 'utf-8') encoding used to read yaml files
* loglevel: one of the valid levels from the logging module
* failonmissingfiles: boolean (default: True)
* loglevelmissingfiles
Returns a representation of the merged and (if requested) interpolated config.
Will mostly be a OrderedDict (dict if usedefaultyamlloader), but can be of any other type,
depending on the yaml files.
"""
self._data = None
self._files = []
self.method = None
if 'method' in kwargs:
logger.debug('parse kwarg method: %s ...' % kwargs['method'])
if kwargs['method'] not in METHODS.values():
raise HiYaPyCoInvocationException(
'undefined method used, must be one of: %s' %
' '.join(METHODS.keys())
)
self.method = kwargs['method']
del kwargs['method']
if self.method is None:
self.method = METHOD_SIMPLE
self.mergelists = True
if 'mergelists' in kwargs:
if not isinstance(kwargs['mergelists'], bool):
raise HiYaPyCoInvocationException(
'value of "mergelists" must be boolean (got: "%s" as %s)' %
(kwargs['mergelists'], type(kwargs['mergelists']),)
)
self.mergelists = kwargs['mergelists']
del kwargs['mergelists']
self.interpolate = False
self.castinterpolated = False
if 'interpolate' in kwargs:
if not isinstance(kwargs['interpolate'], bool):
raise HiYaPyCoInvocationException(
'value of "interpolate" must be boolean (got: "%s" as %s)' %
(kwargs['interpolate'], type(kwargs['interpolate']),)
)
self.interpolate = kwargs['interpolate']
del kwargs['interpolate']
if 'castinterpolated' in kwargs:
if not isinstance(kwargs['castinterpolated'], bool):
raise HiYaPyCoInvocationException(
'value of "castinterpolated" must be boolean (got: "%s" as %s)' %
(kwargs['castinterpolated'], type(kwargs['castinterpolated']),)
)
self.castinterpolated = kwargs['castinterpolated']
del kwargs['castinterpolated']
if 'usedefaultyamlloader' in kwargs:
if not isinstance(kwargs['usedefaultyamlloader'], bool):
raise HiYaPyCoInvocationException(
'value of "usedefaultyamlloader" must be boolean (got: "%s" as %s)' %
(kwargs['usedefaultyamlloader'], type(kwargs['usedefaultyamlloader']),)
)
global _USEDEFAULTYAMLLOADER
_USEDEFAULTYAMLLOADER = kwargs['usedefaultyamlloader']
del kwargs['usedefaultyamlloader']
self.dereferenceyamlanchors = True
if 'dereferenceyamlanchors' in kwargs:
if not isinstance(kwargs['dereferenceyamlanchors'], bool):
raise HiYaPyCoInvocationException(
'value of "dereferenceyamlanchors" must be boolean (got: "%s" as %s)' %
(kwargs['dereferenceyamlanchors'], type(kwargs['dereferenceyamlanchors']),)
)
self.dereferenceyamlanchors = bool(kwargs['dereferenceyamlanchors'])
del kwargs['dereferenceyamlanchors']
self.failonmissingfiles = True
if 'failonmissingfiles' in kwargs:
if not isinstance(kwargs['failonmissingfiles'], bool):
raise HiYaPyCoInvocationException(
'value of "failonmissingfiles" must be boolean (got: "%s" as %s)' %
(kwargs['failonmissingfiles'], type(kwargs['failonmissingfiles']),)
)
self.failonmissingfiles = bool(kwargs['failonmissingfiles'])
del kwargs['failonmissingfiles']
if 'loglevelmissingfiles' in kwargs:
logging.getLogger('testlevellogger').setLevel(kwargs['loglevelmissingfiles'])
self.loglevelonmissingfiles = logging.getLogger('testlevellogger').getEffectiveLevel()
del kwargs['loglevelmissingfiles']
else:
self.loglevelonmissingfiles = logging.ERROR
if not self.failonmissingfiles:
self.loglevelonmissingfiles = logging.WARN
if 'loglevel' in kwargs:
logger.setLevel(kwargs['loglevel'])
del kwargs['loglevel']
self.encoding = 'utf-8'
if 'encoding' in kwargs:
self.encoding = kwargs['encoding']
del kwargs['encoding']
if kwargs:
raise HiYaPyCoInvocationException('undefined keywords: %s' % ' '.join(kwargs.keys()))
if not args:
raise HiYaPyCoInvocationException('no yaml files defined')
for arg in args:
self._updatefiles(arg)
for yamlfile in self._files[:]:
logger.debug('yamlfile: %s ...' % yamlfile)
try:
if '\n' in yamlfile:
logger.debug('loading yaml doc from str ...')
f = yamlfile
self._load_data(_USEDEFAULTYAMLLOADER, yamlfile)
else:
fn = yamlfile
if not os.path.isabs(yamlfile):
fn = os.path.join(os.getcwd(), yamlfile)
logger.debug('path extended for yamlfile: %s' % fn)
try:
with io.open(fn, 'r', encoding=self.encoding) as f:
logger.debug('open4reading: file %s' % f)
self._load_data(_USEDEFAULTYAMLLOADER, f)
except IOError as e:
logger.log(self.loglevelonmissingfiles, e)
if not fn == yamlfile:
logger.log(self.loglevelonmissingfiles,
'file not found: %s (%s)' % (yamlfile, fn,))
else:
logger.log(self.loglevelonmissingfiles,
'file not found: %s' % yamlfile)
if self.failonmissingfiles:
raise HiYaPyCoInvocationException(
'yaml file not found: \'%s\'' % yamlfile
)
self._files.remove(yamlfile)
continue
except yaml.parser.ParserError as e:
logger.log(self.loglevelonmissingfiles, e)
logger.log(self.loglevelonmissingfiles,
'error while parsing yaml %s' % f)
if self.failonmissingfiles:
raise HiYaPyCoInvocationException(
'error while parsing file: \'%s\'' % f
)
self._files.remove(yamlfile)
continue
if self.interpolate:
self._data = self._interpolate(self._data)
def _load_data(self, _USEDEFAULTYAMLLOADER, f):
if _USEDEFAULTYAMLLOADER:
ydata_generator = yaml.safe_load_all(f)
else:
ydata_generator = odyldo.safe_load_all(f)
for ydata in ydata_generator:
if logger.isEnabledFor(logging.DEBUG):
logger.debug('yaml data: %s' % ydata)
if self._data is None:
self._data = ydata
else:
if self.method == METHOD_SIMPLE:
self._data = self._simplemerge(self._data, ydata)
elif self.method == METHOD_MERGE:
self._data = self._deepmerge(self._data, ydata)
elif self.method == METHOD_SUBSTITUTE:
self._data = self._substmerge(self._data, ydata)
else:
raise HiYaPyCoInvocationException('unknown merge method \'%s\'' % self.method)
logger.debug('merged data: %s' % self._data)
def _updatefiles(self, arg):
if isinstance(arg, strTypes):
if arg in self._files:
logger.warning('ignoring duplicated file %s' % arg)
return
self._files.append(arg)
elif isinstance(arg, listTypes):
for larg in arg:
self._updatefiles(larg)
else:
raise HiYaPyCoInvocationException(
'unable to handle arg %s of type %s' % (arg, type(arg),)
)
def _interpolate(self, d):
logger.debug('interpolate "%s" of type %s ...' % (d, type(d),))
if d is None:
return None
if isinstance(d, strTypes):
return self._interpolatestr(d)
if isinstance(d, primitiveTypes):
return d
if isinstance(d, listTypes):
for k, v in enumerate(d):
d[k] = self._interpolate(v)
return d
if isinstance(d, dict):
for k in d.keys():
d[k] = self._interpolate(d[k])
return d
raise HiYaPyCoImplementationException('can not interpolate "%s" of type %s' % (d, type(d),))
def _interpolatestr(self, s):
try:
si = jinja2env.from_string(s).render(self._data)
except TemplateError as e:
# FIXME: this seems to be broken for unicode str?
raise HiYaPyCoImplementationException('error interpolating string "%s" : %s' % (s, e,))
if not s == si:
if self.castinterpolated:
if not re.match( r'^\d+\.*\d*$', si):
try:
si = bool(strtobool(si))
except ValueError:
pass
else:
try:
if '.' in si:
si = float(si)
else:
si = int(si)
except ValueError:
pass
logger.debug('interpolated "%s" to "%s" (type: %s)' % (s, si, type(si),))
return si
def _simplemerge(self, a, b):
if self.dereferenceyamlanchors:
a = copy.deepcopy(a)
b = copy.deepcopy(b)
logger.debug('simplemerge %s (%s) and %s (%s)' % (a, type(a), b, type(b),))
# FIXME: make None usage configurable
if b is None:
logger.debug('pass as b is None')
pass
elif isinstance(b, primitiveTypes):
logger.debug('simplemerge: primitiveTypes replace a "%s" w/ b "%s"' % (a, b,))
a = b
elif isinstance(b, listTypes):
logger.debug('simplemerge: listTypes a "%s" w/ b "%s"' % (a, b,))
if isinstance(a, listTypes):
# pylint: disable=unused-variable
for k, v in enumerate(b):
try:
a[k] = self._simplemerge(a[k], b[k])
except IndexError:
a[k] = b[k]
else:
logger.debug('simplemerge: replace %s w/ list %s' % (a, b,))
a = b
elif isinstance(b, dict):
if isinstance(a, dict):
logger.debug('simplemerge: update %s:"%s" by %s:"%s"' % (type(a), a, type(b), b,))
a.update(b)
else:
logger.debug('simplemerge: replace %s w/ dict %s' % (a, b,))
a = b
else:
raise HiYaPyCoImplementationException(
'can not (simple)merge %s to %s (@ "%s" try to merge "%s")' %
(type(b), type(a), a, b,)
)
return a
def _substmerge(self, a, b):
if self.dereferenceyamlanchors:
a = copy.deepcopy(a)
b = copy.deepcopy(b)
logger.debug('>' * 30)
logger.debug('substmerge %s and %s' % (a, b,))
# FIXME: make None usage configurable
if b is None:
logger.debug('pass as b is None')
pass
# treat listTypes as primitiveTypes in merge
# subsititues list, don't merge them
if a is None or isinstance(b, primitiveTypes) or isinstance(b, listTypes):
logger.debug('substmerge: replace a "%s" w/ b "%s"' % (a, b,))
a = b
elif isinstance(a, dict):
if isinstance(b, dict):
logger.debug('substmerge: dict ... "%s" and "%s"' % (a, b,))
for k in b:
if k in a:
logger.debug(
'substmerge dict: loop for key "%s": "%s" and "%s"' % (k, a[k], b[k],)
)
a[k] = self._substmerge(a[k], b[k])
else:
logger.debug('substmerge dict: set key %s' % k)
a[k] = b[k]
elif isinstance(b, listTypes):
logger.debug('substmerge: dict <- list ... "%s" <- "%s"' % (a, b,))
for bd in b:
if isinstance(bd, dict):
a = self._substmerge(a, bd)
else:
raise HiYaPyCoImplementationException(
'can not merge element from list of type %s to dict '
'(@ "%s" try to merge "%s")' %
(type(b), a, b,)
)
else:
raise HiYaPyCoImplementationException(
'can not merge %s to %s (@ "%s" try to merge "%s")' %
(type(b), type(a), a, b,)
)
logger.debug('end substmerge part: return: "%s"' % a)
logger.debug('<' * 30)
return a
def _deepmerge(self, a, b):
logger.debug('>'*30)
if self.dereferenceyamlanchors:
a = copy.deepcopy(a)
b = copy.deepcopy(b)
logger.debug('deepmerge %s and %s' % (a, b,))
# FIXME: make None usage configurable
if b is None:
logger.debug('pass as b is None')
pass
if a is None or isinstance(b, primitiveTypes):
logger.debug('deepmerge: replace a "%s" w/ b "%s"' % (a, b,))
a = b
elif isinstance(a, listTypes):
if isinstance(b, listTypes):
logger.debug(
'deepmerge: lists extend %s:"%s" by %s:"%s"' %
(type(a), a, type(b), b,)
)
a.extend(be for be in b if be not in a and
(isinstance(be, primitiveTypes) or isinstance(be, listTypes))
)
srcdicts = {}
for k, bd in enumerate(b):
if isinstance(bd, dict):
srcdicts.update({k:bd})
logger.debug('srcdicts: %s' % srcdicts)
for k, ad in enumerate(a):
logger.debug('deepmerge ad "%s" w/ k "%s" of type %s' % (ad, k, type(ad)))
if isinstance(ad, dict):
if k in srcdicts:
# we merge only if at least one key in dict is matching
merge = False
if self.mergelists:
for ak in ad.keys():
if ak in srcdicts[k].keys():
merge = True
break
if merge:
# pylint: disable=undefined-loop-variable
# FIXME undefined-loop-variable : this is not well readable !!!
logger.debug(
'deepmerge ad: deep merge list dict elem w/ '
'key:%s: "%s" and "%s"' %
(ak, ad, srcdicts[k],)
)
a[k] = self._deepmerge(ad, srcdicts[k])
del srcdicts[k]
logger.debug('deepmerge list: remaining srcdicts elems: %s' % srcdicts)
for k, v in srcdicts.items():
logger.debug('deepmerge list: new dict append %s:%s' % (k, v))
a.append(v)
else:
raise HiYaPyCoImplementationException(
'can not merge %s to %s (@ "%s" try to merge "%s")' %
(type(b), type(a), a, b,)
)
elif isinstance(a, dict):
if isinstance(b, dict):
logger.debug('deepmerge: dict ... "%s" and "%s"' % (a, b,))
for k in b:
if k in a:
logger.debug(
'deepmerge dict: loop for key "%s": "%s" and "%s"' %
(k, a[k], b[k],)
)
a[k] = self._deepmerge(a[k], b[k])
else:
logger.debug('deepmerge dict: set key %s' % k)
a[k] = b[k]
elif isinstance(b, listTypes):
logger.debug('deepmerge: dict <- list ... "%s" <- "%s"' % (a, b,))
for bd in b:
if isinstance(bd, dict):
a = self._deepmerge(a, bd)
else:
raise HiYaPyCoImplementationException(
'can not merge element from list of type %s to dict '
'(@ "%s" try to merge "%s")' %
(type(b), a, b,)
)
else:
raise HiYaPyCoImplementationException(
'can not merge %s to %s (@ "%s" try to merge "%s")' %
(type(b), type(a), a, b,)
)
logger.debug('end deepmerge part: return: "%s"' % a)
logger.debug('<'*30)
return a
def yamlfiles(self):
"""returns the list of parsed yaml files / strings"""
return self._files
def __str__(self):
"""String representation of the class"""
return '%s [%s]' % (__name__, os.pathsep.join(self._files))
def data(self):
"""return the data, merged and interpolated if required"""
return self._data
def dump(self, **kwds):
"""dump the data as YAML"""
return dump(self._data, **kwds)
def dump(data, **kwds):
"""dump the data as YAML"""
if _USEDEFAULTYAMLLOADER:
return yaml.safe_dump(data, **kwds)
return odyldo.safe_dump(data, **kwds)
def load(*args, **kwargs):
"""
Load a Hierarchical Yaml Python Config
--------------------------------------
args: YAMLfile(s)
kwargs:
* method: one of hiyapyco.METHOD_SIMPLE | hiyapyco.METHOD_MERGE | hiyapyco.METHOD_SUBSTITUTE
* mergelists: boolean (default: True) try to merge lists
(only makes sense if hiyapyco.METHOD_MERGE or hiyapyco.METHOD_SUBSTITUTE)
* interpolate: boolean (default: False)
* castinterpolated: boolean (default: False) try to cast values after interpolating
* usedefaultyamlloader: boolean (default: False)
* encoding: (default: 'utf-8') encoding used to read yaml files
* loglevel: one of the valid levels from the logging module
* failonmissingfiles: boolean (default: True)
* loglevelmissingfiles
Returns a representation of the merged and (if requested) interpolated config.
Will mostly be a OrderedDict (dict if usedefaultyamlloader), but can be of any other type,
depending on the yaml files.
"""
hiyapyco = HiYaPyCo(*args, **kwargs)
return hiyapyco.data()
def strtobool(val):
"""
minimal implementation of the strtobool function (replaces deprecated distutils)
"""
val = val.lower()
if val in ("y", "yes", "t", "true", "on", "1"):
return 1
if val in ("n", "no", "f", "false", "off", "0"):
return 0
raise ValueError("invalid truth value %r" % (val,))
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 smartindent nu