Python/libs/ConfigMix: configmix/config.py annotate

annotate configmix/config.py @ 316:fe2e28e5fd08

Docu: first short notes about configuration tree references

author	Franz Glasner <fzglas.hg@dom66.de>
date	Wed, 05 May 2021 09:22:00 +0200
parents	043a6412be3c
children	98490375d90c

rev	line source
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	1 # -- coding: utf-8 --
208 bbe8513ea649 Handle flake8 E265 "block comment should start with '# ': use '# :-' instead of '#-' to mark copyright and license comments Franz Glasner <fzglas.hg@dom66.de> parents: 207 diff changeset	2 # :-
302 063099b188cd Docu Franz Glasner <fzglas.hg@dom66.de> parents: 296 diff changeset	3 # :Copyright: (c) 2015-2021, Franz Glasner. All rights reserved.
296 eed16a1ec8f3 Use SPDX license identifiers (either full or short) all over the package Franz Glasner <fzglas.hg@dom66.de> parents: 251 diff changeset	4 # :License: BSD-3-Clause. See LICENSE.txt for details.
208 bbe8513ea649 Handle flake8 E265 "block comment should start with '# ': use '# :-' instead of '#-' to mark copyright and license comments Franz Glasner <fzglas.hg@dom66.de> parents: 207 diff changeset	5 # :-
82 218807d7d883 Remove header markup from the Python files and put them into the doc .rst files Franz Glasner <hg@dom66.de> parents: 79 diff changeset	6 """The unified configuration dictionary with attribute support or
54 aa8345dae995 Generate readable HTML documentation and an API documentation Franz Glasner <hg@dom66.de> parents: 40 diff changeset	7 variable substitution.
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	8
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	9 """
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	10
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	11 from __future__ import division, absolute_import, print_function
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	12
250 ff964825a75a Style: placement of "__all__" Franz Glasner <fzglas.hg@dom66.de> parents: 249 diff changeset	13
ff964825a75a Style: placement of "__all__" Franz Glasner <fzglas.hg@dom66.de> parents: 249 diff changeset	14 __all__ = ["Configuration"]
ff964825a75a Style: placement of "__all__" Franz Glasner <fzglas.hg@dom66.de> parents: 249 diff changeset	15
ff964825a75a Style: placement of "__all__" Franz Glasner <fzglas.hg@dom66.de> parents: 249 diff changeset	16
39 8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	17 import warnings
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	18 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	19 from collections import OrderedDict as ConfigurationBase
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	20 except ImportError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	21 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	22 from ordereddict import OrderedDict as ConfigurationBase
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	23 except ImportError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	24 ConfigurationBase = dict
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	25 try:
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	26 from urllib.parse import urlsplit
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	27 except ImportError:
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	28 from urlparse import urlsplit
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	29
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	30 from .variables import lookup_varns, lookup_filter
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	31 from .compat import u
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	32 from .constants import REF_NAMESPACE
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	33
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	34
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	35 _MARKER = object()
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	36
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	37
17 94b5e94fae44 Make the AttributeDict "private" (-> "_AttributeDict") Franz Glasner <f.glasner@feldmann-mg.com> parents: 16 diff changeset	38 class _AttributeDict(ConfigurationBase):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	39
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	40 def __getattr__(self, name):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	41 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	42 v = self[name]
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	43 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	44 raise AttributeError("%s has no attribute %r" % (type(self), name))
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	45 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	46 # Wrap a dict into another dict with attribute access support
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	47 if isinstance(v, dict):
29 17af7a78710c FIX: Renaming a class was not really complete Franz Glasner <hg@dom66.de> parents: 25 diff changeset	48 return _AttributeDict(v)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	49 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	50 return v
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	51
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	52
17 94b5e94fae44 Make the AttributeDict "private" (-> "_AttributeDict") Franz Glasner <f.glasner@feldmann-mg.com> parents: 16 diff changeset	53 class Configuration(_AttributeDict):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	54
18 a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	55 """The configuration dictionary with attribute support or
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	56 variable substitution.
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	57
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	58 .. note:: When retriving by attribute names variables will not
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	59 substituted.
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	60
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	61 """
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	62
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	63 # Speed
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	64 _TEXTTYPE = type(u(""))
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	65 _STARTTOK = u(b"{{")
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	66 _ENDTOK = u(b"}}")
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	67 _HIER_SEPARATOR = u(b'.')
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	68 _NS_SEPARATOR = u(b':')
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	69 _FILTER_SEPARATOR = u(b'\|')
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	70 _STARTTOK_REF = _STARTTOK + REF_NAMESPACE + _NS_SEPARATOR
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	71 _ENDTOK_REF = _ENDTOK
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	72 _DOT = u(b'.')
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	73
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	74 def getvarl(self, *names, default=_MARKER, namespace=None):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	75 """Get a variable where the hierarchy is given in `names` as sequence
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	76 and the namespace is given in `namespace`.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	77
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	78 No variable interpolation is done and no filters are applied.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	79
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	80 """
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	81 try:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	82 if not namespace:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	83 lookupfn = self._lookupvar
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	84 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	85 if namespace == REF_NAMESPACE:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	86 lookupfn = self._lookupref
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	87 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	88 lookupfn = lookup_varns(namespace)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	89 varvalue = lookupfn(*names)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	90 except KeyError:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	91 if default is _MARKER:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	92 raise KeyError("Variable %r not found" % (names,))
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	93 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	94 return default
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	95 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	96 return varvalue
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	97
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	98 def getvar(self, varname, default=_MARKER):
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	99 """Get a variable of the form ``[ns:][[key1.]key2.]name`` - including
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	100 variables from other namespaces.
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	101
202 2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	102 No variable interpolation is done and no filters are applied.
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	103
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	104 """
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	105 varns, varname = self._split_ns(varname)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	106 if not varns:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	107 varnameparts = varname.split(self._HIER_SEPARATOR)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	108 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	109 varnameparts = (varname,)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	110 return self.getvarl(*varnameparts, namespace=varns)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	111
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	112 def getvarl_s(self, *names, default=_MARKER, namespace=None):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	113 """Get a variable - including variables from other namespaces.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	114
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	115 `names` and `namespace` are interpreted as in
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	116 :meth:`.getvarl`. But variables will be interpolated
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	117 recursively within the variable values and filters are
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	118 applied.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	119
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	120 For more details see chapter :ref:`variable-interpolation`.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	121
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	122 """
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	123 try:
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	124 obj = self.getvarl(*names, namespace=namespace)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	125 return self.substitute_variables_in_obj(obj)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	126 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	127 if default is _MARKER:
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	128 raise
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	129 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	130 return default
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	131
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	132 def getvar_s(self, varname, default=_MARKER):
24 fa65adab0b71 FIX: Typo in comment Franz Glasner <f.glasner@feldmann-mg.com> parents: 23 diff changeset	133 """Get a variable - including variables from other namespaces.
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	134
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	135 `varname` is interpreted as in :meth:`.getvar`. But variables
202 2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	136 will be interpolated recursively within the variable values
2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	137 and filters are applied.
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	138
202 2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	139 For more details see chapter :ref:`variable-interpolation`.
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	140
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	141 """
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	142 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	143 obj = self.getvar(varname)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	144 return self.substitute_variables_in_obj(obj)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	145 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	146 if default is _MARKER:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	147 raise
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	148 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	149 return default
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	150
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	151 def getintvarl_s(self, *names, default=_MARKER, namespace=None):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	152 """Get a (possibly substituted) variable and coerce text to a
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	153 number.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	154
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	155 """
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	156 s = self.getvarl_s(*names, default=default, namespace=namespace)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	157 if isinstance(s, self._TEXTTYPE):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	158 return int(s, 0)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	159 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	160 return s
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	161
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	162 def getintvar_s(self, varname, default=_MARKER):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	163 """Get a (possibly substituted) variable and coerce text to a
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	164 number.
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	165
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	166 """
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	167 s = self.getvar_s(varname, default=default)
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	168 if isinstance(s, self._TEXTTYPE):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	169 return int(s, 0)
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	170 else:
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	171 return s
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	172
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	173 def getboolvarl_s(self, *names, default=_MARKER, namespace=None):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	174 """Get a (possibly substituted) variable and convert text to a
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	175 boolean
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	176
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	177 """
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	178 s = self.getvarl_s(*names, default=default, namespace=namespace)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	179 if isinstance(s, self._TEXTTYPE):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	180 sl = s.strip().lower()
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	181 if sl not in self._BOOL_CVT:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	182 raise ValueError("Not a boolean: %r" % s)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	183 return self._BOOL_CVT[sl]
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	184 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	185 return s
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	186
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	187 def getboolvar_s(self, varname, default=_MARKER):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	188 """Get a (possibly substituted) variable and convert text to a
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	189 boolean
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	190
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	191 """
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	192 s = self.getvar_s(varname, default=default)
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	193 if isinstance(s, self._TEXTTYPE):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	194 sl = s.strip().lower()
207 b3b5ed34d180 Handle most flake8 errors and warnings. Franz Glasner <fzglas.hg@dom66.de> parents: 202 diff changeset	195 if sl not in self._BOOL_CVT:
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	196 raise ValueError("Not a boolean: %r" % s)
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	197 return self._BOOL_CVT[sl]
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	198 else:
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	199 return s
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	200
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	201 # Conversion of booleans
304 d8361dd70d2d FIX: Map unicode strings to boolean values because this is the canonical texttype in confixmmix Franz Glasner <fzglas.hg@dom66.de> parents: 302 diff changeset	202 _BOOL_CVT = {
d8361dd70d2d FIX: Map unicode strings to boolean values because this is the canonical texttype in confixmmix Franz Glasner <fzglas.hg@dom66.de> parents: 302 diff changeset	203 u('1'): True, u('yes'): True, u('true'): True, u('on'): True,
d8361dd70d2d FIX: Map unicode strings to boolean values because this is the canonical texttype in confixmmix Franz Glasner <fzglas.hg@dom66.de> parents: 302 diff changeset	204 u('0'): False, u('no'): False, u('false'): False, u('off'): False
d8361dd70d2d FIX: Map unicode strings to boolean values because this is the canonical texttype in confixmmix Franz Glasner <fzglas.hg@dom66.de> parents: 302 diff changeset	205 }
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	206
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	207 def getfloatvarl_s(self, *names, default=_MARKER, namespace=None):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	208 """Get a (possibly substituted) variable and convert text to a
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	209 float
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	210
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	211 """
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	212 s = self.getvarl_s(*names, default=default, namespace=namespace)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	213 if isinstance(s, self._TEXTTYPE):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	214 return float(s)
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	215 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	216 return s
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	217
36 b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	218 def getfloatvar_s(self, varname, default=_MARKER):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	219 """Get a (possibly substituted) variable and convert text to a
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	220 float
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	221
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	222 """
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	223 s = self.getvar_s(varname, default)
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	224 if isinstance(s, self._TEXTTYPE):
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	225 return float(s)
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	226 else:
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	227 return s
b04a350f894b Implement methods to convert text to other types when getting configuration variables. Franz Glasner <hg@dom66.de> parents: 29 diff changeset	228
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	229 def _split_ns(self, s):
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	230 nameparts = s.split(self._NS_SEPARATOR, 1)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	231 if len(nameparts) == 1:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	232 return (None, s, )
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	233 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	234 return (nameparts[0], nameparts[1], )
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	235
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	236 def _split_filters(self, s):
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	237 nameparts = s.split(self._FILTER_SEPARATOR)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	238 if len(nameparts) == 1:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	239 return (s, [], )
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	240 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	241 return (nameparts[0].rstrip(), nameparts[1:], )
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	242
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	243 def _lookupvar(self, *names, default=_MARKER):
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	244 """Lookup a variable within a hierarchy.
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	245
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	246 If no default is given an unexisting `name` raises a `KeyError`
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	247 else `default` is returned.
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	248 """
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	249 try:
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	250 v = self.expand_if_reference(self[names[0]])
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	251 for p in names[1:]:
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	252 v = self.expand_if_reference(v[p])
104 d9f9a06e0c49 Make a better error message for "TypeError" exceptions when looking up variables. Franz Glasner <f.glasner@feldmann-mg.com> parents: 82 diff changeset	253 except TypeError:
207 b3b5ed34d180 Handle most flake8 errors and warnings. Franz Glasner <fzglas.hg@dom66.de> parents: 202 diff changeset	254 raise KeyError(
b3b5ed34d180 Handle most flake8 errors and warnings. Franz Glasner <fzglas.hg@dom66.de> parents: 202 diff changeset	255 "Configuration variable %r not found"
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	256 "(missing intermediate keys?)" % (names,))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	257 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	258 if default is _MARKER:
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	259 raise KeyError(
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	260 "Configuration variable %r not found" % (names,))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	261 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	262 return default
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	263 return v
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	264
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	265 def _lookupref(self, key, default=_MARKER):
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	266 """
311 035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	267
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	268 `key` must be a configuration reference URI without any
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	269 (namespace) prefixes and suffixes
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	270
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	271 """
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	272 return self.expand_ref_uri(key, default=default)
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	273
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	274 def expand_if_reference(self, v, default=_MARKER):
311 035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	275 """Check whether `v` is a configuration reference and -- if true --
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	276 then expand it.
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	277
310 801cd16223e4 FIX: Docu Franz Glasner <fzglas.hg@dom66.de> parents: 305 diff changeset	278 `v` must match the pattern ``{{ref:<REFERENCE>}}``
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	279
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	280 All non-matching texttypes and all non-texttypes are returned
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	281 unchanged.
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	282
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	283 """
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	284 if not isinstance(v, self._TEXTTYPE):
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	285 return v
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	286 if not v.startswith(self._STARTTOK_REF) \
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	287 or not v.endswith(self._ENDTOK_REF):
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	288 return v
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	289 return self.expand_ref_uri(
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	290 v[len(self._STARTTOK_REF):-len(self._ENDTOK_REF)],
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	291 default=default)
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	292
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	293 def expand_ref_uri(self, uri, default=_MARKER):
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	294 pu = urlsplit(uri)
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	295 if pu.scheme or pu.netloc or pu.path or pu.query:
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	296 raise ValueError("only fragment-only URIs are supported")
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	297 if not pu.fragment:
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	298 return self
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	299 if pu.fragment.startswith(self._DOT):
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	300 raise ValueError("relative refs not supported")
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	301 return self.getvar(pu.fragment, default=default)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	302
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	303 def substitute_variables_in_obj(self, obj):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	304 """Recursively expand variables in the object tree `obj`."""
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	305 if isinstance(obj, self._TEXTTYPE):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	306 # a string - really replace the value
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	307 return self.expand_variable(obj)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	308 elif isinstance(obj, list):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	309 return [self.substitute_variables_in_obj(i) for i in obj]
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	310 elif isinstance(obj, tuple):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	311 tmp = [self.substitute_variables_in_obj(i) for i in obj]
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	312 return type(obj)(tmp)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	313 elif isinstance(obj, dict):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	314 newdict = type(obj)()
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	315 for k in obj:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	316 newdict[k] = self.substitute_variables_in_obj(obj[k])
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	317 return newdict
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	318 elif isinstance(obj, set):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	319 newset = type(obj)()
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	320 for i in obj:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	321 newset.add(self.substitute_variables_in_obj(i))
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	322 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	323 return obj
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	324
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	325 def expand_variable(self, s):
302 063099b188cd Docu Franz Glasner <fzglas.hg@dom66.de> parents: 296 diff changeset	326 """Expand variables in the single string `s`"""
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	327 start = s.find(self._STARTTOK, 0)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	328 while start != -1:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	329 end = s.find(self._ENDTOK, start)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	330 if end < 0:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	331 return s
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	332 varname, filters = self._split_filters(s[start+2:end])
39 8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	333 try:
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	334 varvalue = self._apply_filters(filters, self.getvar_s(varname))
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	335 except KeyError:
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	336 warnings.warn("Cannot expand variable %r in string "
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	337 "%r" % (varname, s, ),
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	338 UserWarning,
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	339 stacklevel=1)
8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	340 raise
25 baf862cb4860 Handle "None" variable values when substituting Franz Glasner <f.glasner@feldmann-mg.com> parents: 24 diff changeset	341 if varvalue is None:
baf862cb4860 Handle "None" variable values when substituting Franz Glasner <f.glasner@feldmann-mg.com> parents: 24 diff changeset	342 varvalue = u("")
251 2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	343 #
2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	344 # Dont apply and type conversions to str if the whole `s` is
2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	345 # just one expansion
2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	346 #
2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	347 if (start == 0) and (end + 2 == len(s)):
2a8dcab2de8c Do not implicitely convert a configuration value to text if the value is the result of just a variable expansion. Franz Glasner <fzglas.hg@dom66.de> parents: 250 diff changeset	348 return varvalue
249 1e38ccfba3de Use explicit type conversion instead of an implicit one. Franz Glasner <fzglas.hg@dom66.de> parents: 248 diff changeset	349 replaced = s[:start] + u(str(varvalue))
248 13283057a21e Do not use ".format()" but string concatenation or (when conversion to Unicode is needed) the faster %s method Franz Glasner <fzglas.hg@dom66.de> parents: 237 diff changeset	350 s = replaced + s[end+2:]
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	351 # don't re-evaluate because `self.getvar_s()` expands already
23 c77cb6bc8eeb FIX: Handle non-str types in variable substitutions properly Franz Glasner <f.glasner@feldmann-mg.com> parents: 18 diff changeset	352 start = s.find(self._STARTTOK, len(replaced))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	353 return s
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	354
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	355 def _apply_filters(self, filters, value):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	356 for name in filters:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	357 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	358 filterfn = lookup_filter(name)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	359 except KeyError:
40 8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	360 #
8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	361 # Convert to NameError because we find a missing filters
8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	362 # a very serious error.
8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	363 #
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	364 raise NameError("Filter %r not found" % name)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	365 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	366 value = filterfn(self, value)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	367 return value

Mercurial > hgrepos > Python > libs > ConfigMix

annotate configmix/config.py @ 316:fe2e28e5fd08