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

annotate configmix/config.py @ 542:f71d34dda19f

Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. This is currently for Python 3.5+. It is tested with Python 3.7 and Python3.8 (FreeBSD 12.2 amd64, LLVM 10.0.1). A build for the stable API ("abi3") fails because PyUnicode_New() is currently not in the stable API. Also includes are extended tests for unquote() and pathstr2path().

author	Franz Glasner <fzglas.hg@dom66.de>
date	Fri, 31 Dec 2021 21:24:16 +0100
parents	25b61f0a1958
children	491413368c7c

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
482 8b8ffb74d452 Remove unneeded __future__ import because we are on Python 2.6+ Franz Glasner <f.glasner@feldmann-mg.com> parents: 481 diff changeset	11 from __future__ import division, absolute_import, print_function
16 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
487 d7f6f2afcee2 Instead of using u(str(v)) use specialized functions for PY2 and PY3 Franz Glasner <f.glasner@feldmann-mg.com> parents: 485 diff changeset	31 from .compat import u, uchr, n, str_and_u, PY2
357 dd454e1efea4 Use constants for the names of the "None" and "Empty" filters Franz Glasner <fzglas.hg@dom66.de> parents: 352 diff changeset	32 from .constants import REF_NAMESPACE, NONE_FILTER, EMPTY_FILTER
542 f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	33 try:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	34 from ._speedups import fast_unquote, fast_pathstr2path
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	35 except ImportError:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	36 fast_unquote = None
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	37 fast_pathstr2path = None
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	38
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 _MARKER = object()
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	41 _MISSING = object()
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	42
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	43
17 94b5e94fae44 Make the AttributeDict "private" (-> "_AttributeDict") Franz Glasner <f.glasner@feldmann-mg.com> parents: 16 diff changeset	44 class _AttributeDict(ConfigurationBase):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	45
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	46 def __getattr__(self, name):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	47 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	48 v = self[name]
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	49 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	50 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	51 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	52 # 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	53 if isinstance(v, dict):
29 17af7a78710c FIX: Renaming a class was not really complete Franz Glasner <hg@dom66.de> parents: 25 diff changeset	54 return _AttributeDict(v)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	55 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	56 return v
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	57
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	58
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	59 class CoercingMethodsMixin(object):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	60
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	61 """Mixin to provide some common implementations for retrieval
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	62 methods that convert return values to a fixed type (int, bool,
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	63 float).
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	64
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	65 Both :class:`~.Configuration` and :class:`~._JailedConfiguration` use
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	66 this mixin.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	67
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	68 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	69
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	70 def getintvarl_s(self, path, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	71 """Get a (possibly substituted) variable and coerce text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	72 number.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	73
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	74 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	75 s = self.getvarl_s(path, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	76 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	77 return int(s, 0)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	78 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	79 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	80
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	81 def getfirstintvarl_s(self, paths, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	82 """Get a (possibly substituted) variable and coerce text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	83 number.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	84
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	85 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	86 s = self.getfirstvarl_s(paths, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	87 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	88 return int(s, 0)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	89 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	90 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	91
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	92 def getintvar_s(self, varname, default=_MARKER):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	93 """Get a (possibly substituted) variable and coerce text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	94 number.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	95
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	96 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	97 s = self.getvar_s(varname, default=default)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	98 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	99 return int(s, 0)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	100 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	101 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	102
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	103 def getfirstintvar_s(self, varnames, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	104 """A variant of :meth:`~.getintvar_s` that returns the first found
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	105 variable in the list of given variables in `varnames`.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	106
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	107 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	108 s = self.getfirstvar_s(varnames, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	109 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	110 return int(s, 0)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	111 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	112 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	113
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	114 def getboolvarl_s(self, path, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	115 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	116 boolean
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	117
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	118 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	119 s = self.getvarl_s(path, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	120 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	121 sl = s.strip().lower()
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	122 if sl not in self._BOOL_CVT:
450 12f25ac6a13b Make exception formatting more robuts: pack all %-style formatting args explicitely into tuples Franz Glasner <f.glasner@feldmann-mg.com> parents: 449 diff changeset	123 raise ValueError("Not a boolean: %r" % (s, ))
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	124 return self._BOOL_CVT[sl]
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	125 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	126 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	127
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	128 def getfirstboolvarl_s(self, paths, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	129 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	130 boolean
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	131
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	132 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	133 s = self.getfirstvarl_s(paths, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	134 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	135 sl = s.strip().lower()
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	136 if sl not in self._BOOL_CVT:
450 12f25ac6a13b Make exception formatting more robuts: pack all %-style formatting args explicitely into tuples Franz Glasner <f.glasner@feldmann-mg.com> parents: 449 diff changeset	137 raise ValueError("Not a boolean: %r" % (s, ))
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	138 return self._BOOL_CVT[sl]
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	139 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	140 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	141
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	142 def getboolvar_s(self, varname, default=_MARKER):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	143 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	144 boolean
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	145
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	146 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	147 s = self.getvar_s(varname, default=default)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	148 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	149 sl = s.strip().lower()
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	150 if sl not in self._BOOL_CVT:
450 12f25ac6a13b Make exception formatting more robuts: pack all %-style formatting args explicitely into tuples Franz Glasner <f.glasner@feldmann-mg.com> parents: 449 diff changeset	151 raise ValueError("Not a boolean: %r" % (s, ))
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	152 return self._BOOL_CVT[sl]
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	153 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	154 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	155
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	156 def getfirstboolvar_s(self, varnames, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	157 """A variant of :meth:`~.getboolvar_s` that returns the first found
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	158 variable in the list of given variables in `varnames`.
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	159
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	160 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	161 s = self.getfirstvar_s(varnames, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	162 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	163 sl = s.strip().lower()
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	164 if sl not in self._BOOL_CVT:
450 12f25ac6a13b Make exception formatting more robuts: pack all %-style formatting args explicitely into tuples Franz Glasner <f.glasner@feldmann-mg.com> parents: 449 diff changeset	165 raise ValueError("Not a boolean: %r" % (s, ))
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	166 return self._BOOL_CVT[sl]
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	167 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	168 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	169
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	170 # Conversion of booleans
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	171 _BOOL_CVT = {
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	172 u('1'): True, u('yes'): True, u('true'): True, u('on'): True,
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	173 u('0'): False, u('no'): False, u('false'): False, u('off'): False
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	174 }
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	175
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	176 def getfloatvarl_s(self, path, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	177 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	178 float
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	179
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	180 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	181 s = self.getvarl_s(path, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	182 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	183 return float(s)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	184 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	185 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	186
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	187 def getfirstfloatvarl_s(self, path, *kwds):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	188 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	189 float
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	190
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	191 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	192 s = self.getfirstvarl_s(path, *kwds)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	193 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	194 return float(s)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	195 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	196 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	197
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	198 def getfloatvar_s(self, varname, default=_MARKER):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	199 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	200 float
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	201
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	202 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	203 s = self.getvar_s(varname, default)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	204 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	205 return float(s)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	206 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	207 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	208
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	209 def getfirstfloatvar_s(self, varname, default=_MARKER):
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	210 """Get a (possibly substituted) variable and convert text to a
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	211 float
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	212
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	213 """
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	214 s = self.getfirstvar_s(varname, default)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	215 if isinstance(s, _TEXTTYPE):
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	216 return float(s)
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	217 else:
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	218 return s
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	219
816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	220
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	221 # Speed
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	222 _EMPTY_STR = u("")
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	223 _TEXTTYPE = type(_EMPTY_STR)
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	224 _STARTTOK = u(b"{{")
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	225 _ENDTOK = u(b"}}")
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	226 _HIER_SEPARATOR = u(b'.')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	227 _NS_SEPARATOR = u(b':')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	228 _FILTER_SEPARATOR = u(b'\|')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	229 _STARTTOK_REF = _STARTTOK + REF_NAMESPACE + _NS_SEPARATOR
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	230 _ENDTOK_REF = _ENDTOK
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	231 _DOT = u(b'.')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	232 _QUOTE = u(b'%')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	233 _QUOTE_x = u(b'x')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	234 _QUOTE_u = u(b'u')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	235 _QUOTE_U = u(b'U')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	236 _COMMENT = u(b'#')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	237 _QUOTE_MAP = {
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	238 0x25: u(b'%x25'), # _QUOTE
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	239 0x2e: u(b'%x2e'), # _DOT
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	240 0x3a: u(b'%x3a'), # _NS_SEPARATOR
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	241 0x23: u(b'%x23'), # _COMMENT / anchor
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	242 0x7c: u(b'%x7c'), # _FILTER_SEPARATOR
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	243 0x22: u(b'%x22'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	244 0x27: u(b'%x27'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	245 0x7b: u(b'%x7b'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	246 0x7d: u(b'%x7d'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	247 0x5b: u(b'%x5b'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	248 0x5d: u(b'%x5d'),
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	249 }
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	250 _QUOTE_SAFE = u(b'abcdefghijklmnopqrstuvwxyz'
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	251 b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	252 b'0123456789'
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	253 b'-_@!$&/\\()=?*+~;,<>^')
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	254 """Mostly used configuration key characters that do not need any quoting
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	255
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	256 """
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	257
3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	258
502 4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	259 def quote(s):
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	260 """Replace important special characters in string `s` by replacing
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	261 them with ``%xNN`` where `NN` are the two hexadecimal digits of the
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	262 characters unicode codepoint value.
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	263
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	264 Handled are the important special chars: ``%``, ``.``, ``:``,
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	265 ``#``; ``'``, ``"``, ``\|``, ``{``, ``}``, ``[`` and ``]``.
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	266
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	267 See also the :ref:`quoting` section.
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	268
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	269 """
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	270 # Quick check whether all of the chars are in _QUOTE_SAFE
504 4dbc16ff2670 .lstrip() seems to be a little bit faster than .rstrip() when testing whether quoting is needed Franz Glasner <fzglas.hg@dom66.de> parents: 503 diff changeset	271 if not s.lstrip(_QUOTE_SAFE):
502 4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	272 return s
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	273
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	274 # Slow path
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	275 re_encode = False
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	276 if PY2:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	277 # Use the Unicode translation variant in PY2
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	278 if isinstance(s, str):
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	279 s = s.decode("latin1")
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	280 re_encode = True
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	281 s = s.translate(_QUOTE_MAP)
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	282 if re_encode:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	283 return s.encode("latin1")
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	284 else:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	285 return s
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	286
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	287
542 f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	288 def py_unquote(s):
502 4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	289 """Unquote the content of `s`: handle all patterns ``%xNN``,
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	290 ``%uNNNN`` or ``%UNNNNNNNN``.
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	291
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	292 This is the inverse of :func:`.quote`.
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	293
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	294 """
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	295 if _QUOTE not in s:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	296 return s
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	297 parts = s.split(_QUOTE)
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	298 res = [parts[0]]
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	299 res_append = res.append
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	300 for p in parts[1:]:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	301 try:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	302 qc = p[0]
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	303 except IndexError:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	304 raise ValueError("unknown quote syntax string: {}".format(s))
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	305 if qc == _QUOTE_x:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	306 if len(p) < 3:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	307 raise ValueError("quote syntax: length too small")
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	308 res_append(uchr(int(p[1:3], 16)))
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	309 res_append(p[3:])
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	310 elif qc == _QUOTE_u:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	311 if len(p) < 5:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	312 raise ValueError("quote syntax: length too small")
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	313 res_append(uchr(int(p[1:5], 16)))
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	314 res_append(p[5:])
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	315 elif qc == _QUOTE_U:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	316 if len(p) < 9:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	317 raise ValueError("quote syntax: length too small")
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	318 res_append(uchr(int(p[1:9], 16)))
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	319 res_append(p[9:])
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	320 else:
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	321 raise ValueError("unknown quote syntax string: {}".format(s))
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	322 return _EMPTY_STR.join(res)
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	323
4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	324
542 f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	325 if fast_unquote:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	326 unquote = fast_unquote
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	327 else:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	328 unquote = py_unquote
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	329
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	330
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	331 def py_pathstr2path(varname):
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	332 """Parse a dot-separated path string `varname` into a tuple of
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	333 unquoted path items
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	334
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	335 :param str varname: The quoted and dot-separated path string
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	336 :return: The unquoted and parsed path items
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	337 :rtype: tuple
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	338
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	339 Used e.g. by :meth:`~.Configuration.getvar`,
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	340 :meth:`~.Configuration.getvar_s` and :meth:`~.Configuration.jailed`.
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	341
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	342 The returned value is suitable as input for
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	343 :meth:`~.Configuration.getvarl`, :meth:`~.Configuration.getvarl_s` and
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	344 friends.
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	345
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	346 An empty `varname` returns an empty tuple.
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	347
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	348 """
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	349 #
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	350 # Because str.split yields a non-empty list for an empty string handle
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	351 # the empty string separately.
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	352 #
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	353 if varname:
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	354 return tuple([unquote(p) for p in varname.split(_HIER_SEPARATOR)])
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	355 else:
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	356 return tuple()
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	357
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	358
542 f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	359 if fast_pathstr2path:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	360 pathstr2path = fast_pathstr2path
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	361 else:
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	362 pathstr2path = py_pathstr2path
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	363
f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	364
541 25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	365 def _split_ns(varname):
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	366 """Split the variable name string `varname` into the namespace and
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	367 the namespace-specific name
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	368
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	369 :type varname: str
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	370 :return: A tuple containing the namespace (or `None`) and the
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	371 namespace-specific (variable-)name
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	372 :rtype: tuple(str or None, str)
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	373
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	374 """
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	375 ns, sep, rest = varname.partition(_NS_SEPARATOR)
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	376 if sep:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	377 return (unquote(ns), rest)
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	378 else:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	379 return (None, ns)
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	380
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	381
541 25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	382 def _split_filters(varname):
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	383 """Split off the filter part from the `varname` string
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	384
542 f71d34dda19f Add an optional C-implementation for configmix.config.unquote and configmix.config.pathstr2path. Franz Glasner <fzglas.hg@dom66.de> parents: 541 diff changeset	385 :type varname: str
541 25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	386 :return: The tuple of the variable name without the filters and a list
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	387 of filters
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	388 :rtype: tuple(str, list)
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	389
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	390 """
25b61f0a1958 Docs for _split_ns() and _split_filters() Franz Glasner <fzglas.hg@dom66.de> parents: 540 diff changeset	391 name, sep, filters = varname.partition(_FILTER_SEPARATOR)
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	392 if sep:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	393 filters = filters.strip()
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	394 if filters:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	395 return (name.rstrip(),
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	396 filters.split(_FILTER_SEPARATOR))
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	397 else:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	398 return (name.rstrip(), [])
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	399 else:
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	400 return (name, [])
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	401
33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	402
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	403 class Configuration(CoercingMethodsMixin, _AttributeDict):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	404
18 a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	405 """The configuration dictionary with attribute support or
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	406 variable substitution.
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	407
322 4aa19e04ff65 Comment: typo Franz Glasner <f.glasner@feldmann-mg.com> parents: 321 diff changeset	408 .. note:: When retrieving by attribute names variables will not
18 a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	409 substituted.
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	410
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	411 """
a04fa81e10ae Doc Franz Glasner <f.glasner@feldmann-mg.com> parents: 17 diff changeset	412
404 6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	413 is_jail = False
6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	414 """Flag to show that this is not a jail for another configuration"""
6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	415
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	416 def __init__(self, args, *kwds):
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	417 #
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	418 # PY2.7 compat: must be set before calling the superclass' __init__
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	419 #
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	420 self.__lookup_cache = {}
527 08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	421 self.__interpolation_cache = {}
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	422 super(Configuration, self).__init__(args, *kwds)
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	423
506 dffa692751b1 Implement clear_cache() for the configuration Franz Glasner <fzglas.hg@dom66.de> parents: 504 diff changeset	424 def clear_cache(self):
529 9976ff66c439 Docs Franz Glasner <f.glasner@feldmann-mg.com> parents: 528 diff changeset	425 """Clear the internal lookup cache and the interpolation cache"""
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	426 self.__lookup_cache.clear()
527 08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	427 self.__interpolation_cache.clear()
506 dffa692751b1 Implement clear_cache() for the configuration Franz Glasner <fzglas.hg@dom66.de> parents: 504 diff changeset	428
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	429 def __getitem__(self, key):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	430 """Mapping and list interface that forwards to :meth:`~.getvarl_s`
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	431
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	432 """
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	433 if isinstance(key, (tuple, list)):
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	434 return self.getvarl_s(*key)
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	435 else:
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	436 return self.getvarl_s(key)
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	437
442 94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	438 def get(self, key, default=None):
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	439 """Mapping interface that forwards to :meth:`~.getvarl_s`
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	440
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	441 """
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	442 if isinstance(key, (tuple, list)):
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	443 return self.getvarl_s(*key, default=default)
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	444 else:
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	445 return self.getvarl_s(key, default=default)
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	446
439 bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	447 def __contains__(self, key):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	448 """Containment test"""
439 bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	449 if isinstance(key, (tuple, list)):
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	450 # No namespace and quoting support here
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	451 try:
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	452 self._lookupvar(*key)
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	453 except KeyError:
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	454 return False
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	455 else:
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	456 return True
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	457 else:
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	458 return super(Configuration, self).__contains__(key)
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	459
443 23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	460 def getitem_ns(self, key):
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	461 """Just forward to the original :meth:`dict.__getitem__`.
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	462
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	463 No variable interpolation and key path access.
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	464
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	465 """
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	466 return super(Configuration, self).__getitem__(key)
23941c014130 FIX: Merge properly when the configuration's __getitem__ do now interpolate: prohibit duplicate interpolation and interpolation while merging Franz Glasner <fzglas.hg@dom66.de> parents: 442 diff changeset	467
517 328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	468 def items(self):
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	469 """Items without interpolation"""
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	470 for k in self:
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	471 yield (k, self.getitem_ns(k))
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	472
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	473 def values(self):
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	474 """Values without interpolation"""
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	475 for k in self:
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	476 yield self.getitem_ns(k)
328af767f5f8 Implement Configuration.items() and Configuration.values() without interpolating the values Franz Glasner <fzglas.hg@dom66.de> parents: 516 diff changeset	477
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	478 def getvarl(self, path, *kwds):
24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	479 """Get a variable where the hierarchy is given in `path` as sequence
380 bb4a90fb58e0 Docu: "namespace" in getvarl() is a keyword argument Franz Glasner <fzglas.hg@dom66.de> parents: 374 diff changeset	480 and the namespace is given in the `namespace` keyword argument.
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	481
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	482 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	483
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	484 Quoting of `path` and `namespace` is not needed and wrong.
333 5ec0ae3bb8db Docs: quoting Franz Glasner <fzglas.hg@dom66.de> parents: 329 diff changeset	485
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	486 """
321 7a0f3c256cf4 FIX: Python2 compatibility: keyword arguments after args not allowed: use kwds and manual retrieval with .pop() instead Franz Glasner <f.glasner@feldmann-mg.com>* parents: 320 diff changeset	487 default = kwds.pop("default", _MARKER)
7a0f3c256cf4 FIX: Python2 compatibility: keyword arguments after args not allowed: use kwds and manual retrieval with .pop() instead Franz Glasner <f.glasner@feldmann-mg.com>* parents: 320 diff changeset	488 namespace = kwds.pop("namespace", None)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	489 try:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	490 if not namespace:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	491 lookupfn = self._lookupvar
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	492 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	493 if namespace == REF_NAMESPACE:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	494 lookupfn = self._lookupref
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	495 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	496 lookupfn = lookup_varns(namespace)
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	497 varvalue = lookupfn(*path)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	498 except KeyError:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	499 if default is _MARKER:
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	500 raise KeyError("Variable %r not found" % (path,))
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	501 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	502 return default
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	503 else:
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	504 return varvalue
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	505
418 bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	506 def getkeysl(self, path, *kwds):
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	507 """Yield the keys of a variable value.
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	508
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	509 :rtype: A generator
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	510 :raise KeyError:
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	511
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	512 .. note:: Dictionary keys are not subject to interpolation.
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	513
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	514 """
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	515 if "default" in kwds:
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	516 raise TypeError("got unexpected keyword argument: default")
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	517 for k in self.getvarl(path, *kwds).keys():
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	518 yield k
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	519
381 fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	520 def getfirstvarl(self, paths, *kwds):
385 4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	521 """A variant of :meth:`~.getvarl` that returns the first found
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	522 variable in the `paths` list.
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	523
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	524 Every item in `paths` is either a `tuple` or `list` or a `dict`.
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	525 If the path item is a `dict` then it must have two keys "namespace"
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	526 and "path".
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	527 If the path item is a `list` or `tuple` then the namespace is assumed
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	528 to be `None`.
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	529
389 44ef854da70a Docs Franz Glasner <fzglas.hg@dom66.de> parents: 388 diff changeset	530 Note that a caller that wants to use variables from a non-default
44ef854da70a Docs Franz Glasner <fzglas.hg@dom66.de> parents: 388 diff changeset	531 namespace must use a sequence of dicts.
44ef854da70a Docs Franz Glasner <fzglas.hg@dom66.de> parents: 388 diff changeset	532
385 4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	533 No variable interpolation is done and no filters are applied.
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	534
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	535 Quoting of anything in `paths` is not needed and wrong.
4beeb291926d First documentation of getfirstvarl() Franz Glasner <fzglas.hg@dom66.de> parents: 384 diff changeset	536
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	537 """
381 fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	538 default = kwds.pop("default", _MARKER)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	539 for path in paths:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	540 if isinstance(path, (list, tuple)):
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	541 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	542 varvalue = self.getvarl(*path)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	543 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	544 pass
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	545 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	546 return varvalue
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	547 elif isinstance(path, dict):
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	548 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	549 namespace = path["namespace"]
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	550 p = path["path"]
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	551 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	552 raise TypeError("a paths dict item must have a `path'"
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	553 " and a `namespace' key")
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	554 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	555 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	556 varvalue = self.getvarl(*p, namespace=namespace)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	557 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	558 pass
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	559 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	560 return varvalue
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	561 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	562 raise TypeError("a paths item must be a dict, list or tuple")
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	563 if default is _MARKER:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	564 raise KeyError(
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	565 "none of the given variables found: %r" % (paths,))
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	566 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	567 return default
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	568
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	569 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	570 """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	571 variables from other namespaces.
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	572
202 2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	573 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	574
333 5ec0ae3bb8db Docs: quoting Franz Glasner <fzglas.hg@dom66.de> parents: 329 diff changeset	575 Special characters (e.g. ``:`` and ``.``) must be quoted when using
5ec0ae3bb8db Docs: quoting Franz Glasner <fzglas.hg@dom66.de> parents: 329 diff changeset	576 the default namespace.
5ec0ae3bb8db Docs: quoting Franz Glasner <fzglas.hg@dom66.de> parents: 329 diff changeset	577
502 4f90e1eb7af8 Make quote() and unquote() module globals and also export from configmix Franz Glasner <fzglas.hg@dom66.de> parents: 500 diff changeset	578 See also :func:`.quote`.
333 5ec0ae3bb8db Docs: quoting Franz Glasner <fzglas.hg@dom66.de> parents: 329 diff changeset	579
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	580 """
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	581 varns, varname = _split_ns(varname)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	582 if not varns:
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	583 return self.getvarl(*pathstr2path(varname), default=default)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	584 else:
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	585 return self.getvarl(varname, namespace=varns, default=default)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	586
418 bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	587 def getkeys(self, varname):
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	588 """Yield all the keys of a variable value.
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	589
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	590 :rtype: A generator
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	591 :raise KeyError:
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	592
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	593 .. note:: Dictionary keys are not subject to interpolation.
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	594
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	595 """
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	596 for k in self.getvar(varname).keys():
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	597 yield k
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	598
368 4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	599 def getfirstvar(self, varnames, *kwds):
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	600 """A variant of :meth:`~.getvar` that returns the first found variable
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	601 in the list of given variables in `varnames`.
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	602
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	603 """
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	604 default = kwds.pop("default", _MARKER)
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	605 for varname in varnames:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	606 try:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	607 varvalue = self.getvar(varname)
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	608 except KeyError:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	609 pass
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	610 else:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	611 return varvalue
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	612 if default is _MARKER:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	613 raise KeyError(
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	614 "none of the given variables found: %r" % (varnames,))
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	615 else:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	616 return default
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	617
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	618 def getvarl_s(self, path, *kwds):
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	619 """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	620
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	621 `path` and `namespace` are interpreted as in
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	622 :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	623 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	624 applied.
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	625
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	626 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	627
043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	628 """
321 7a0f3c256cf4 FIX: Python2 compatibility: keyword arguments after args not allowed: use kwds and manual retrieval with .pop() instead Franz Glasner <f.glasner@feldmann-mg.com>* parents: 320 diff changeset	629 default = kwds.pop("default", _MARKER)
7a0f3c256cf4 FIX: Python2 compatibility: keyword arguments after args not allowed: use kwds and manual retrieval with .pop() instead Franz Glasner <f.glasner@feldmann-mg.com>* parents: 320 diff changeset	630 namespace = kwds.pop("namespace", None)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	631 try:
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	632 obj = self.getvarl(*path, namespace=namespace)
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	633 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	634 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	635 if default is _MARKER:
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	636 raise
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	637 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	638 return default
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	639
381 fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	640 def getfirstvarl_s(self, paths, *kwds):
388 13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	641 """A variant of :meth:`~.getfirstvarl` that does variable
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	642 interpolation.
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	643
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	644 `paths` and `kwds` are interpreted as in :meth:`.getfirstvarl`.
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	645 But variables will be interpolated
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	646 recursively within the variable values and filters are
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	647 applied.
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	648
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	649 For more details see chapter :ref:`variable-interpolation`.
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	650
13427f37abab Docs: document Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 385 diff changeset	651 """
381 fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	652 default = kwds.pop("default", _MARKER)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	653 for path in paths:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	654 if isinstance(path, (list, tuple)):
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	655 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	656 obj = self.getvarl(*path)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	657 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	658 pass
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	659 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	660 return self.substitute_variables_in_obj(obj)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	661
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	662 elif isinstance(path, dict):
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	663 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	664 namespace = path["namespace"]
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	665 p = path["path"]
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	666 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	667 raise TypeError("a paths dict item must have a `path'"
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	668 " and a `namespace' key")
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	669 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	670 try:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	671 obj = self.getvarl(*p, namespace=namespace)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	672 except KeyError:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	673 pass
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	674 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	675 return self.substitute_variables_in_obj(obj)
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	676 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	677 raise TypeError("a paths item must be a dict, list or tuple")
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	678 if default is _MARKER:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	679 raise KeyError(
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	680 "none of the given variables found: %r" % (paths,))
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	681 else:
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	682 return default
fe3dfd687621 Implemented Configuration.getfirstvarl() and Configuration.getfirstvarl_s() Franz Glasner <fzglas.hg@dom66.de> parents: 380 diff changeset	683
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	684 def getvar_s(self, varname, default=_MARKER):
24 fa65adab0b71 FIX: Typo in comment Franz Glasner <f.glasner@feldmann-mg.com> parents: 23 diff changeset	685 """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	686
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	687 `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	688 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	689 and filters are applied.
115 a5339d39af5c Begin the documentation of variables and its expansion Franz Glasner <hg@dom66.de> parents: 104 diff changeset	690
202 2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	691 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	692
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	693 """
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	694 varns, varname = _split_ns(varname)
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	695 try:
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	696 if not varns:
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	697 return self.substitute_variables_in_obj(
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	698 self.getvarl(*pathstr2path(varname)))
524 09b8e28b7a44 Implement Configuration.getvar_s() by using Configuration.getvarl() instead of Configuration.getvar(). Franz Glasner <fzglas.hg@dom66.de> parents: 523 diff changeset	699 else:
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	700 return self.substitute_variables_in_obj(
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	701 self.getvarl(varname, namespace=varns))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	702 except KeyError:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	703 if default is _MARKER:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	704 raise
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	705 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	706 return default
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	707
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	708 def _getvar_s_with_cache_info(self, varname):
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	709 """Internal variant of :meth:`~.getvar_s` that returns some information
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	710 whether caching of interpolated values is allowed
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	711
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	712 Caching is currently not allowed when namespaces are used.
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	713
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	714 Currently used by :meth:`~.interpolate_variables`.
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	715
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	716 """
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	717 varns, varname = _split_ns(varname)
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	718 if not varns:
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	719 # no namespace -> cacheable
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	720 return (
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	721 self.substitute_variables_in_obj(
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	722 self.getvarl(*pathstr2path(varname))),
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	723 True
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	724 )
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	725 else:
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	726 # results from namespaced lookups are currently not cacheable
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	727 return (
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	728 self.substitute_variables_in_obj(
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	729 self.getvarl(varname, namespace=varns)),
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	730 False
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	731 )
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	732
368 4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	733 def getfirstvar_s(self, varnames, *kwds):
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	734 """A variant of :meth:`~.getvar_s` that returns the first found
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	735 variable in the list of given variables in `varnames`.
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	736
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	737 """
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	738 default = kwds.pop("default", _MARKER)
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	739 for varname in varnames:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	740 try:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	741 obj = self.getvar(varname)
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	742 except KeyError:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	743 pass
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	744 else:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	745 return self.substitute_variables_in_obj(obj)
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	746 if default is _MARKER:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	747 raise KeyError(
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	748 "none of the given variables found: %r" % (varnames,))
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	749 else:
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	750 return default
4ee53f6fcac1 Implement ".getfirstvar()" and ".getfirstvar_s()". Franz Glasner <fzglas.hg@dom66.de> parents: 364 diff changeset	751
489 b49164db1273 Remove unused keyword params for ._lookupvar(). Franz Glasner <f.glasner@feldmann-mg.com> parents: 488 diff changeset	752 def _lookupvar(self, *path):
314 043a6412be3c Implemented new access methods .getvarl() and .getvarl_s Franz Glasner <fzglas.hg@dom66.de> parents: 311 diff changeset	753 """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	754
489 b49164db1273 Remove unused keyword params for ._lookupvar(). Franz Glasner <f.glasner@feldmann-mg.com> parents: 488 diff changeset	755 :raise KeyError: An unexisting `path` raises a `KeyError`
b49164db1273 Remove unused keyword params for ._lookupvar(). Franz Glasner <f.glasner@feldmann-mg.com> parents: 488 diff changeset	756
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	757 """
419 079a82129110 Allow the empty variable name to retrieve the root configuration object Franz Glasner <fzglas.hg@dom66.de> parents: 418 diff changeset	758 if not path:
079a82129110 Allow the empty variable name to retrieve the root configuration object Franz Glasner <fzglas.hg@dom66.de> parents: 418 diff changeset	759 return self
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	760 v = self.__lookup_cache.get(path, _MARKER)
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	761 if v is not _MARKER:
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	762 if v is _MISSING:
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	763 raise KeyError(
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	764 "Configuration variable %r not found"
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	765 " (negative internal cache value)" % (path,))
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	766 else:
f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	767 return v
493 6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	768 eiref = self.expand_if_reference
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	769 try:
493 6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	770 v = eiref(super(Configuration, self).__getitem__(path[0]))
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	771 for p in path[1:]:
493 6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	772 v = eiref(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	773 except TypeError:
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	774 self.__lookup_cache[path] = _MISSING
207 b3b5ed34d180 Handle most flake8 errors and warnings. Franz Glasner <fzglas.hg@dom66.de> parents: 202 diff changeset	775 raise KeyError(
b3b5ed34d180 Handle most flake8 errors and warnings. Franz Glasner <fzglas.hg@dom66.de> parents: 202 diff changeset	776 "Configuration variable %r not found"
382 24db29162d09 Renamed "names" arguments into the more proper "path" Franz Glasner <fzglas.hg@dom66.de> parents: 381 diff changeset	777 "(missing intermediate keys?)" % (path,))
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	778 except KeyError:
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	779 self.__lookup_cache[path] = _MISSING
499 f46932e8a84c Configuration._lookupvar() now uses an internal cache (positive and negative). Franz Glasner <fzglas.hg@dom66.de> parents: 497 diff changeset	780 raise
526 48990863b905 Rename internal cache from __cache to __lookup_cache Franz Glasner <f.glasner@feldmann-mg.com> parents: 525 diff changeset	781 self.__lookup_cache[path] = v
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	782 return v
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	783
518 55b8aed70f7d Remove unneeded "default" keyword argument for Configuration._lookupref() and Configuration.expand_ref_uri() Franz Glasner <fzglas.hg@dom66.de> parents: 517 diff changeset	784 def _lookupref(self, key):
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	785 """
311 035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	786
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	787 `key` must be a configuration reference URI without any
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	788 (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	789
519 df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	790 :raise KeyError: If the reference is not found
df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	791
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	792 """
518 55b8aed70f7d Remove unneeded "default" keyword argument for Configuration._lookupref() and Configuration.expand_ref_uri() Franz Glasner <fzglas.hg@dom66.de> parents: 517 diff changeset	793 return self.expand_ref_uri(key)
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	794
493 6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	795 def expand_if_reference(self, v):
311 035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	796 """Check whether `v` is a configuration reference and -- if true --
035b42a224ed Docu Franz Glasner <fzglas.hg@dom66.de> parents: 310 diff changeset	797 then expand it.
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	798
310 801cd16223e4 FIX: Docu Franz Glasner <fzglas.hg@dom66.de> parents: 305 diff changeset	799 `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	800
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	801 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	802 unchanged.
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	803
493 6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	804 :raise KeyError: If the reverence cannot found
6a0f761ff35b Remove default (i.e. all keyword arguments) from .expand_if_reference() because no-one uses it Franz Glasner <f.glasner@feldmann-mg.com> parents: 491 diff changeset	805
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	806 """
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	807 if not isinstance(v, _TEXTTYPE):
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	808 return v
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	809 if v.startswith(_STARTTOK_REF) and v.endswith(_ENDTOK_REF):
488 298510ec8171 Simplify logic by not using many negations Franz Glasner <f.glasner@feldmann-mg.com> parents: 487 diff changeset	810 return self.expand_ref_uri(
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	811 v[len(_STARTTOK_REF):-len(_ENDTOK_REF)])
488 298510ec8171 Simplify logic by not using many negations Franz Glasner <f.glasner@feldmann-mg.com> parents: 487 diff changeset	812 else:
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	813 return v
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	814
518 55b8aed70f7d Remove unneeded "default" keyword argument for Configuration._lookupref() and Configuration.expand_ref_uri() Franz Glasner <fzglas.hg@dom66.de> parents: 517 diff changeset	815 def expand_ref_uri(self, uri):
519 df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	816 """
df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	817
df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	818 :raises KeyError: If the reference URI is not found
df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	819
df0bb39617d6 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 518 diff changeset	820 """
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	821 pu = urlsplit(uri)
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	822 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	823 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	824 if not pu.fragment:
f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	825 return self
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	826 if pu.fragment.startswith(_DOT):
305 f529ca46dd50 Implemented the "ref" namespace to get configuration tree references. Franz Glasner <fzglas.hg@dom66.de> parents: 304 diff changeset	827 raise ValueError("relative refs not supported")
518 55b8aed70f7d Remove unneeded "default" keyword argument for Configuration._lookupref() and Configuration.expand_ref_uri() Franz Glasner <fzglas.hg@dom66.de> parents: 517 diff changeset	828 return self.getvar(pu.fragment)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	829
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	830 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	831 """Recursively expand variables in the object tree `obj`."""
491 de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	832 ty = type(obj)
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	833 if issubclass(ty, _TEXTTYPE):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	834 # a string - really replace the value
525 be6ef72c55d5 Change Configuration.expand_variable() to Configuration.interpolate_variables() Franz Glasner <f.glasner@feldmann-mg.com> parents: 524 diff changeset	835 return self.interpolate_variables(obj)
491 de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	836 elif issubclass(ty, dict):
de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	837 newdict = ty()
497 8e516f17cf95 Optimize .substitute_variables_in_obj: use dict.items() to avoid one dict lookup Franz Glasner <fzglas.hg@dom66.de> parents: 495 diff changeset	838 for k, v in obj.items():
8e516f17cf95 Optimize .substitute_variables_in_obj: use dict.items() to avoid one dict lookup Franz Glasner <fzglas.hg@dom66.de> parents: 495 diff changeset	839 newdict[k] = self.substitute_variables_in_obj(v)
490 ea4b7fac02d6 Reorder type comparisons by usage Franz Glasner <f.glasner@feldmann-mg.com> parents: 489 diff changeset	840 return newdict
491 de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	841 elif issubclass(ty, list):
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	842 return [self.substitute_variables_in_obj(i) for i in obj]
491 de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	843 elif issubclass(ty, tuple):
512 bf8a1b1498db Remove a temporary variable usage Franz Glasner <fzglas.hg@dom66.de> parents: 511 diff changeset	844 return ty([self.substitute_variables_in_obj(i) for i in obj])
491 de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	845 elif issubclass(ty, set):
de776953337b Remove repeated type(obj) calls Franz Glasner <f.glasner@feldmann-mg.com> parents: 490 diff changeset	846 newset = ty()
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	847 for i in obj:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	848 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	849 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	850 return obj
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	851
525 be6ef72c55d5 Change Configuration.expand_variable() to Configuration.interpolate_variables() Franz Glasner <f.glasner@feldmann-mg.com> parents: 524 diff changeset	852 def interpolate_variables(self, s):
be6ef72c55d5 Change Configuration.expand_variable() to Configuration.interpolate_variables() Franz Glasner <f.glasner@feldmann-mg.com> parents: 524 diff changeset	853 """Expand all variables in the single string `s`"""
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	854 start = s.find(_STARTTOK, 0)
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	855 if start < 0:
0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	856 return s
527 08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	857 res = self.__interpolation_cache.get(s, _MARKER)
08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	858 if res is not _MARKER:
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	859 if res is _MISSING:
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	860 warnings.warn("Cannot interpolate variables in string "
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	861 "%r (cached)" % (s, ),
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	862 UserWarning,
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	863 stacklevel=1)
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	864 raise KeyError("Cannot interpolate variables in string "
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	865 "%r (cached)" % (s, ))
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	866 else:
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	867 return res
515 3387a9d5fb12 Performance: compute the length of the constant input strinc only once and compute the new rest earlier and use the computed value also in comparisons Franz Glasner <fzglas.hg@dom66.de> parents: 513 diff changeset	868 len_s = len(s)
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	869 res = []
0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	870 res_append = res.append
0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	871 rest = 0
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	872 use_cache = True
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	873 while start != -1:
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	874 res_append(s[rest:start])
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	875 end = s.find(_ENDTOK, start)
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	876 if end < 0:
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	877 rest = start
0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	878 break
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	879 varname, filters = _split_filters(
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	880 s[start+2:end]) # noqa: E226
39 8715e5cc59ac Print a warning if a variable cannot be expanded. Franz Glasner <hg@dom66.de> parents: 36 diff changeset	881 try:
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	882 varvalue, cacheable = self._getvar_s_with_cache_info(varname)
528 54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	883 except KeyError:
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	884 cacheable = True
528 54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	885 if NONE_FILTER in filters:
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	886 varvalue = None
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	887 elif EMPTY_FILTER in filters:
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	888 varvalue = _EMPTY_STR
349 83f76a41cf7c Implement a special filter named "None" that suppresses "KeyErrors" from interpolation lookups and returns a Python "None" instead Franz Glasner <fzglas.hg@dom66.de> parents: 334 diff changeset	889 else:
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	890 self.__interpolation_cache[s] = _MISSING
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	891 warnings.warn("Cannot interpolate variable %r in string "
528 54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	892 "%r" % (varname, s, ),
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	893 UserWarning,
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	894 stacklevel=1)
54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	895 raise
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	896 if not cacheable:
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	897 use_cache = False
528 54a8d020f5d5 Apply None and Empty interpolation filters only on KeyErrors Franz Glasner <f.glasner@feldmann-mg.com> parents: 527 diff changeset	898 varvalue = self._apply_filters(filters, varvalue)
515 3387a9d5fb12 Performance: compute the length of the constant input strinc only once and compute the new rest earlier and use the computed value also in comparisons Franz Glasner <fzglas.hg@dom66.de> parents: 513 diff changeset	899 rest = end + 2
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	900 #
350 9d729c479dc2 FIX: Do not apply the type convertion None -> "" if the expansions comprises the whole expression Franz Glasner <f.glasner@feldmann-mg.com> parents: 349 diff changeset	901 # Dont apply and type conversions to the variable value if
9d729c479dc2 FIX: Do not apply the type convertion None -> "" if the expansions comprises the whole expression Franz Glasner <f.glasner@feldmann-mg.com> parents: 349 diff changeset	902 # the whole `s` is just one expansion
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	903 #
515 3387a9d5fb12 Performance: compute the length of the constant input strinc only once and compute the new rest earlier and use the computed value also in comparisons Franz Glasner <fzglas.hg@dom66.de> parents: 513 diff changeset	904 if (start == 0) and (rest == len_s):
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	905 if use_cache:
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	906 self.__interpolation_cache[s] = varvalue
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	907 return varvalue
516 ad1e630ba736 FIX: Do not filter-out all False values then interpolating (zero int, boolean False) Franz Glasner <fzglas.hg@dom66.de> parents: 515 diff changeset	908 if varvalue is None:
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	909 pass
0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	910 else:
487 d7f6f2afcee2 Instead of using u(str(v)) use specialized functions for PY2 and PY3 Franz Glasner <f.glasner@feldmann-mg.com> parents: 485 diff changeset	911 res_append(str_and_u(varvalue))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	912 # don't re-evaluate because `self.getvar_s()` expands already
495 3f0c932588fc Performance: module-level variable lookup is much faster (similar to local) than class-level (either via CLASS.VARIABLE or self.VARIABLE). Franz Glasner <f.glasner@feldmann-mg.com> parents: 493 diff changeset	913 start = s.find(_STARTTOK, rest)
484 0259bd521729 Avoid repeaded string concatenations in .expand_variable(): use a list of string parts and proper indexes into the source string Franz Glasner <f.glasner@feldmann-mg.com> parents: 483 diff changeset	914 res_append(s[rest:])
527 08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	915 res = _EMPTY_STR.join(res)
530 28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	916 if use_cache:
28191d61b042 FIX: Handle non-cacheable interpolations properly. Franz Glasner <f.glasner@feldmann-mg.com> parents: 529 diff changeset	917 self.__interpolation_cache[s] = res
527 08924499db3c Implement a simple interpolation cache for text types Franz Glasner <f.glasner@feldmann-mg.com> parents: 526 diff changeset	918 return res
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	919
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	920 def _apply_filters(self, filters, value):
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	921 for name in filters:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	922 try:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	923 filterfn = lookup_filter(name)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	924 except KeyError:
40 8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	925 #
8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	926 # 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	927 # a very serious error.
8d66aef2f7fb Comment about exceptions when filters are missing. Franz Glasner <hg@dom66.de> parents: 39 diff changeset	928 #
521 1001701be682 Formatting of NameErrors in ._apply_filters(): put "name" into a tuple explicitely Franz Glasner <fzglas.hg@dom66.de> parents: 519 diff changeset	929 raise NameError("Filter %r not found" % (name, ))
16 f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	930 else:
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	931 value = filterfn(self, value)
f85dc4677c01 Implemented the real configuration dictionary with attribute access or Franz Glasner <hg@dom66.de> parents: diff changeset	932 return value
320 98490375d90c Allow variable name quoting to be used in .getvar() and .getvar_s() and references Franz Glasner <fzglas.hg@dom66.de> parents: 314 diff changeset	933
411 3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	934 def jailed(self, rootpath=None, root=None, bind_root=True):
399 b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	935 """Return a "jailed" configuration of the current configuration.
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	936
399 b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	937 :param rootpath: a sequence of strings that shall emcompass
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	938 the chroot-like jail of the returned
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	939 configuration
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	940 :type rootpath: list or tuple
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	941 :param str root: a string path expression that shall encompass
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	942 the chroot-like jail of the returned configuration
411 3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	943 :param bool bind_root: if you do a :meth:`~.rebind` just after
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	944 creation of a jailed config you can set
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	945 `bind_root` to `False`; otherwise use
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	946 the default
397 88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	947 :return: a jailed (aka restricted) configuration
88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	948 :rtype: _JailedConfiguration
88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	949
399 b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	950 Exactly one of `rootpath` or `root` must be given.
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	951
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	952 """
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	953 if rootpath is not None and root is not None:
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	954 raise ValueError("only one of `rootpath' or `root' can be given")
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	955 if rootpath is None and root is None:
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	956 raise ValueError("one of `rootpath' or `root' must be given")
416 2abde0d3c735 FIX: Handle .jailed() with an empty "root" properly Franz Glasner <fzglas.hg@dom66.de> parents: 412 diff changeset	957 if rootpath is not None and not isinstance(rootpath, (list, tuple)):
2abde0d3c735 FIX: Handle .jailed() with an empty "root" properly Franz Glasner <fzglas.hg@dom66.de> parents: 412 diff changeset	958 raise TypeError("`rootpath' must be a list or a tuple")
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	959 if root is not None:
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	960 # convert to path
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	961 varns, varname = _split_ns(root)
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	962 if varns:
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	963 raise ValueError(
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	964 "jailed configurations do not support namespaces")
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	965 rootpath = pathstr2path(root)
411 3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	966 jc = _JailedConfiguration(*rootpath)
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	967 if bind_root:
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	968 jc.rebind(self)
3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	969 return jc
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	970
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	971
412 816327e178b0 Provide coercing methods for the jailed configuration: getintXXX(), getboolXXX(), getfloatXXX() and friends. Franz Glasner <fzglas.hg@dom66.de> parents: 411 diff changeset	972 class _JailedConfiguration(CoercingMethodsMixin):
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	973
397 88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	974 """A jailed and restricted variant of :class:`Configuration`.
88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	975
399 b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	976 Restriction is two-fold:
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	977
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	978 - The access to configuration variables in `config` is restricted
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	979 to the configuration sub-tree that is configured in `path`.
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	980
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	981 - Not all access-methods of :class:`Configuration` are implemented
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	982 yet.
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	983
400 727ec2fc8e7e Docs Franz Glasner <fzglas.hg@dom66.de> parents: 399 diff changeset	984 .. seealso:: :ref:`jailed-configuration`
727ec2fc8e7e Docs Franz Glasner <fzglas.hg@dom66.de> parents: 399 diff changeset	985
399 b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	986 .. note:: There is no namespace support.
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	987
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	988 .. note:: Do not call the constructor directly. Instantiate a jailed
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	989 configuration from the parent configuration's
b45403d175a0 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 398 diff changeset	990 :meth:`~.Configuration.jailed` factory method.
397 88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	991
88239f28415c Docs Franz Glasner <fzglas.hg@dom66.de> parents: 396 diff changeset	992 """
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	993
503 a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	994 __slots__ = ("_base", "_path", "_path_string")
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	995
404 6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	996 is_jail = True
6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	997 """Flag to show that this is a jail for another configuration"""
6a5aea02f3d0 Implement a ".is_jail" flag for configuration objects: to test/assert whether we expect a jail configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 400 diff changeset	998
411 3c95faa91dad Optimize the creation of a jailed config. Franz Glasner <f.glasner@feldmann-mg.com> parents: 406 diff changeset	999 def __init__(self, *path):
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1000 super(_JailedConfiguration, self).__init__()
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1001 self._path = path
503 a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1002 self._path_string = None
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1003
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1004 @property
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1005 def _pathstr(self):
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1006 v = self._path_string
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1007 if v is None:
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1008 if self._path:
513 599e8ade567c str.join(): use a list comprehension instead of a generator expression for performance reasons Franz Glasner <fzglas.hg@dom66.de> parents: 512 diff changeset	1009 v = _HIER_SEPARATOR.join([quote(p) for p in self._path]) \
503 a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1010 + _HIER_SEPARATOR
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1011 else:
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1012 v = _EMPTY_STR
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1013 self._path_string = v
a56f1d97a3f3 Use generator comprehensions where possible instead of list comprehensions that are converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 502 diff changeset	1014 return v
405 af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1015
406 5286df5aeefe Allow a jailed configuration to return its base configuration via a property Franz Glasner <f.glasner@feldmann-mg.com> parents: 405 diff changeset	1016 @property
5286df5aeefe Allow a jailed configuration to return its base configuration via a property Franz Glasner <f.glasner@feldmann-mg.com> parents: 405 diff changeset	1017 def base(self):
426 84d4f82ffe59 Docs: more on jails and sub-jails Franz Glasner <fzglas.hg@dom66.de> parents: 419 diff changeset	1018 """Ask for the base (aka parent) configuration".
84d4f82ffe59 Docs: more on jails and sub-jails Franz Glasner <fzglas.hg@dom66.de> parents: 419 diff changeset	1019
84d4f82ffe59 Docs: more on jails and sub-jails Franz Glasner <fzglas.hg@dom66.de> parents: 419 diff changeset	1020 This configuration is always unjailed.
84d4f82ffe59 Docs: more on jails and sub-jails Franz Glasner <fzglas.hg@dom66.de> parents: 419 diff changeset	1021
84d4f82ffe59 Docs: more on jails and sub-jails Franz Glasner <fzglas.hg@dom66.de> parents: 419 diff changeset	1022 """
406 5286df5aeefe Allow a jailed configuration to return its base configuration via a property Franz Glasner <f.glasner@feldmann-mg.com> parents: 405 diff changeset	1023 return self._base
5286df5aeefe Allow a jailed configuration to return its base configuration via a property Franz Glasner <f.glasner@feldmann-mg.com> parents: 405 diff changeset	1024
405 af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1025 def rebind(self, new_base):
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1026 """Bind the jail to a new unjailed configuration `new_base`.
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1027
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1028 The new configuration base also must have an existing path to
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1029 the root.
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1030
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1031 :param Configuration new_base: the new base
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1032
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1033 """
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1034 if new_base.is_jail:
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1035 raise TypeError("can only bind to an unjailed configuration")
af367e1d0950 Allow to rebind a jailed configuration to another "similar" base Franz Glasner <f.glasner@feldmann-mg.com> parents: 404 diff changeset	1036 self._base = new_base
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1037 #
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1038 # Early error out if the chroot does not exist but allow
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1039 # degenerated case if `self._path` is empty.
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1040 #
449 5864977bb44f FIX: KeyError formatting. Franz Glasner <f.glasner@feldmann-mg.com> parents: 448 diff changeset	1041 if self._path and self._path not in new_base:
5864977bb44f FIX: KeyError formatting. Franz Glasner <f.glasner@feldmann-mg.com> parents: 448 diff changeset	1042 raise KeyError(
5864977bb44f FIX: KeyError formatting. Franz Glasner <f.glasner@feldmann-mg.com> parents: 448 diff changeset	1043 "base key path %r not available in the new base"
5864977bb44f FIX: KeyError formatting. Franz Glasner <f.glasner@feldmann-mg.com> parents: 448 diff changeset	1044 % (self._path, ))
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1045
448 b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1046 def __getattr__(self, name):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1047 """Attribute-style access.
02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1048
02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1049 Result values are interpolated (i.e. forwarded to
02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1050 :meth:`~.getvarl_s`)
02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1051
02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1052 """
448 b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1053 try:
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1054 v = self._base.getvarl_s(*(self._path + (name, )))
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1055 except KeyError:
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1056 raise AttributeError("%s has no attribute %r" % (type(self), name))
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1057 else:
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1058 # Wrap a dict into another dict with attribute access support
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1059 if isinstance(v, dict):
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1060 return _AttributeDict(v)
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1061 else:
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1062 return v
b95c12781497 Attribute-style access for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 443 diff changeset	1063
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	1064 def __getitem__(self, key):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1065 """Mapping and list interface that forwards to :meth:`~.getvarl_s`
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	1066
bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	1067 """
441 9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1068 if isinstance(key, tuple):
440 f297c23f78f0 Optimize __getitem__() in jailed configurations: call base directly Franz Glasner <fzglas.hg@dom66.de> parents: 439 diff changeset	1069 return self._base.getvarl_s(*(self._path + key))
441 9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1070 elif isinstance(key, list):
9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1071 return self._base.getvarl_s(*(self._path + tuple(key)))
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	1072 else:
468 95df1a10259a Index list-access for jailed configurations: be more generic by calling also __getitem__ in the base Franz Glasner <fzglas.hg@dom66.de> parents: 467 diff changeset	1073 return self._base.getvarl_s(*self._path)[key]
437 bbc5b64e137a - Dict-level access to a configuration key now does variable interpolation. Franz Glasner <fzglas.hg@dom66.de> parents: 432 diff changeset	1074
442 94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1075 def get(self, key, default=None):
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1076 if isinstance(key, tuple):
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1077 return self._base.get(self._path + key, default=default)
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1078 elif isinstance(key, list):
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1079 return self._base.get(self._path + tuple(key), default=default)
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1080 else:
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1081 return self._base.get(self._path + (key, ), default=default)
94cf5a8722d6 Add proper .get() support for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 441 diff changeset	1082
439 bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	1083 def __contains__(self, key):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1084 """Containment support for containers"""
441 9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1085 if isinstance(key, tuple):
439 bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	1086 return (self._path + key) in self._base
441 9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1087 elif isinstance(key, list):
9d20fab53a19 FIX: Handle "list"-type keys in __contains__ and __getitem__ properly: convert to tuples for contatenation with tuple Franz Glasner <fzglas.hg@dom66.de> parents: 440 diff changeset	1088 return (self._path + tuple(key)) in self._base
439 bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	1089 else:
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	1090 return (self._path + (key, )) in self._base
bd27da55483a Optimized __contains__() implementation for jailed and unjailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 438 diff changeset	1091
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1092 def getvarl(self, path, *kwds):
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1093 return self._base.getvarl((self._path + path), *kwds)
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1094
418 bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1095 def getkeysl(self, path, *kwds):
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1096 for k in self._base.getkeysl((self._path + path), *kwds):
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1097 yield k
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1098
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1099 def getfirstvarl(self, paths, *kwds):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1100 real_paths = []
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1101 for path in paths:
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1102 if isinstance(path, (list, tuple)):
509 4c2517e18af0 FIX: Convert a list ito a tuple before appending it to another tuple Franz Glasner <fzglas.hg@dom66.de> parents: 507 diff changeset	1103 real_paths.append(self._path + tuple(path))
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1104 elif isinstance(path, dict):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1105 raise TypeError(
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1106 "a `dict' is not supported in a jailed configuration")
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1107 else:
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1108 raise TypeError("a paths item must be a list or tuple")
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1109 return self._base.getfirstvarl(real_paths, *kwds)
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1110
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1111 def getvarl_s(self, path, *kwds):
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1112 return self._base.getvarl_s((self._path + path), *kwds)
0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1113
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1114 def getfirstvarl_s(self, paths, *kwds):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1115 real_paths = []
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1116 for path in paths:
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1117 if isinstance(path, (list, tuple)):
510 acf1e8696d68 FIX: Some other lists that need to converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 509 diff changeset	1118 real_paths.append(self._path + tuple(path))
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1119 elif isinstance(path, dict):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1120 raise TypeError(
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1121 "a `dict' is not supported in a jailed configuration")
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1122 else:
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1123 raise TypeError("a paths item must be a list or tuple")
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1124 return self._base.getfirstvarl_s(real_paths, *kwds)
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1125
428 090a25f36a3d FIX: Allow jailed configurations to use correctly use base configurations that use a different "default" marker object. Franz Glasner <f.glasner@feldmann-mg.com> parents: 426 diff changeset	1126 def getvar(self, varname, **kwds):
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1127 return self._base.getvarl(*(self._path + pathstr2path(varname)),
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1128 **kwds)
395 0b3ffc34fa5c Begin a jailed configuration with access to a sub-tree of the original configuration Franz Glasner <f.glasner@feldmann-mg.com> parents: 389 diff changeset	1129
418 bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1130 def getkeys(self, varname):
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1131 for k in self._base.getkeysl(*(self._path + pathstr2path(varname))):
418 bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1132 yield k
bb5f11abd12a Implement .getkeysl() and .getkeys() for configuration objects that iterate over all the keys of a configuration value Franz Glasner <fzglas.hg@dom66.de> parents: 417 diff changeset	1133
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1134 def getfirstvar(self, varnames, *kwds):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1135 real_varnames = [self._pathstr + vn for vn in varnames]
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1136 return self._base.getfirstvar(real_varnames, *kwds)
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1137
428 090a25f36a3d FIX: Allow jailed configurations to use correctly use base configurations that use a different "default" marker object. Franz Glasner <f.glasner@feldmann-mg.com> parents: 426 diff changeset	1138 def getvar_s(self, varname, **kwds):
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1139 return self._base.getvarl_s(*(self._path + pathstr2path(varname)),
9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1140 **kwds)
398 b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1141
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1142 def getfirstvar_s(self, varnames, *kwds):
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1143 real_varnames = [self._pathstr + vn for vn in varnames]
b1f82b853290 Jailed configuration: implement more methods: getfirstvarl, getfirstvarl_s, getfirstvar and getfirstvar_s Franz Glasner <fzglas.hg@dom66.de> parents: 397 diff changeset	1144 return self._base.getfirstvar_s(real_varnames, *kwds)
417 83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1145
459 9dc9cef1b9cd Implement proper iteration support for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 455 diff changeset	1146 def __iter__(self):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1147 """Iteration support for containers"""
459 9dc9cef1b9cd Implement proper iteration support for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 455 diff changeset	1148 return iter(self._base.getvarl_s(*self._path))
9dc9cef1b9cd Implement proper iteration support for jailed configurations Franz Glasner <fzglas.hg@dom66.de> parents: 455 diff changeset	1149
467 9fcdc42a0457 len-support for jailed configurations: implement a proper __len__() method Franz Glasner <fzglas.hg@dom66.de> parents: 460 diff changeset	1150 def __len__(self):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1151 """Length support for containers"""
467 9fcdc42a0457 len-support for jailed configurations: implement a proper __len__() method Franz Glasner <fzglas.hg@dom66.de> parents: 460 diff changeset	1152 return len(self._base.getvarl(*self._path))
9fcdc42a0457 len-support for jailed configurations: implement a proper __len__() method Franz Glasner <fzglas.hg@dom66.de> parents: 460 diff changeset	1153
460 d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1154 if PY2:
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1155
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1156 def __nonzero__(self):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1157 """Map- and list-style evaluation in boolean context"""
460 d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1158 return bool(self._base.getvarl_s(*self._path))
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1159
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1160 else:
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1161
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1162 def __bool__(self):
469 02b210a2b022 Docs Franz Glasner <fzglas.hg@dom66.de> parents: 468 diff changeset	1163 """Map- and list-style evaluation in boolean context"""
460 d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1164 return bool(self._base.getvarl_s(*self._path))
d22985d6806e Proper boolean context for jailed configurations: __bool__()/__nonzero__() Franz Glasner <fzglas.hg@dom66.de> parents: 459 diff changeset	1165
417 83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1166 def jailed(self, rootpath=None, root=None, bind_root=True):
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1167 """Return a "jailed" configuration that effectively is a
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1168 subjail of the current jail
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1169
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1170 For a more complete description see :meth:`.Configuration.jailed`.
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1171
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1172 """
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1173 if rootpath is not None and root is not None:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1174 raise ValueError("only one of `rootpath' or `root' can be given")
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1175 if rootpath is None and root is None:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1176 raise ValueError("one of `rootpath' or `root' must be given")
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1177 if rootpath is not None and not isinstance(rootpath, (list, tuple)):
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1178 raise TypeError("`rootpath' must be a list or a tuple")
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1179 if root is not None:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1180 # convert to path
540 33856ae1cc0b _split_ns() and _split_filters() are now module-globals Franz Glasner <fzglas.hg@dom66.de> parents: 539 diff changeset	1181 varns, varname = _split_ns(root)
417 83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1182 if varns:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1183 raise ValueError(
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1184 "sub-jails do not support namespaces")
539 9546d38cd3f8 Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly Franz Glasner <fzglas.hg@dom66.de> parents: 531 diff changeset	1185 rootpath = pathstr2path(varname)
417 83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1186 if self._path:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1187 new_rootpath = self._path + tuple(rootpath)
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1188 else:
510 acf1e8696d68 FIX: Some other lists that need to converted to tuples Franz Glasner <fzglas.hg@dom66.de> parents: 509 diff changeset	1189 new_rootpath = tuple(rootpath)
417 83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1190 sjc = _JailedConfiguration(*new_rootpath)
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1191 if bind_root:
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1192 sjc.rebind(self._base)
83d537f1dfbb Implement sub-jails: allow to get a jailed configuration from a jail Franz Glasner <fzglas.hg@dom66.de> parents: 416 diff changeset	1193 return sjc
432 b96f49c9c76b Proper "repr()" for a jailed configuration: put the root path into the output Franz Glasner <fzglas.hg@dom66.de> parents: 428 diff changeset	1194
b96f49c9c76b Proper "repr()" for a jailed configuration: put the root path into the output Franz Glasner <fzglas.hg@dom66.de> parents: 428 diff changeset	1195 def __repr__(self):
b96f49c9c76b Proper "repr()" for a jailed configuration: put the root path into the output Franz Glasner <fzglas.hg@dom66.de> parents: 428 diff changeset	1196 r = "_JailedConfiguration(rootpath=%s)" % n(repr(self._path))
b96f49c9c76b Proper "repr()" for a jailed configuration: put the root path into the output Franz Glasner <fzglas.hg@dom66.de> parents: 428 diff changeset	1197 return r

Mercurial > hgrepos > Python > libs > ConfigMix

annotate configmix/config.py @ 542:f71d34dda19f