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

comparison configmix/config.py @ 539:9546d38cd3f8

Refactor: the parsing of the quoted and dot-separated path string is put into a function that handles also empty inputs properly

author	Franz Glasner <fzglas.hg@dom66.de>
date	Tue, 28 Dec 2021 17:28:19 +0100
parents	be740ed67d16
children	33856ae1cc0b

comparison

equal deleted inserted replaced

-:e85d1eddf539
+:9546d38cd3f8
 else:
 raise ValueError("unknown quote syntax string: {}".format(s))
 return _EMPTY_STR.join(res)
+def pathstr2path(varname):
+"""Parse a dot-separated path string `varname` into a tuple of
+unquoted path items
+:param str varname: The quoted and dot-separated path string
+:return: The unquoted and parsed path items
+:rtype: tuple
+Used e.g. by :meth:`~.Configuration.getvar`,
+:meth:`~.Configuration.getvar_s` and :meth:`~.Configuration.jailed`.
+The returned value is suitable as input for
+:meth:`~.Configuration.getvarl`, :meth:`~.Configuration.getvarl_s` and
+friends.
+An empty `varname` returns an empty tuple.
+"""
+#
+# Because str.split yields a non-empty list for an empty string handle
+# the empty string separately.
+#
+if varname:
+return tuple([unquote(p) for p in varname.split(_HIER_SEPARATOR)])
+else:
+return tuple()
 class Configuration(CoercingMethodsMixin, _AttributeDict):
 """The configuration dictionary with attribute support or
 variable substitution.
 See also :func:`.quote`.
 """
 varns, varname = self._split_ns(varname)
 if not varns:
-if varname:
+return self.getvarl(*pathstr2path(varname), default=default)
-varnameparts = tuple([unquote(vp)
+else:
-for vp in varname.split(_HIER_SEPARATOR)])
+return self.getvarl(varname, namespace=varns, default=default)
-else:
-varnameparts = tuple()
-else:
-varnameparts = (varname,)
-return self.getvarl(*varnameparts, namespace=varns, default=default)
 def getkeys(self, varname):
 """Yield all the keys of a variable value.
 :rtype: A generator
 For more details see chapter :ref:`variable-interpolation`.
 """
 varns, varname = self._split_ns(varname)
-if not varns:
-if varname:
-varnameparts = tuple([unquote(vp)
-for vp in varname.split(_HIER_SEPARATOR)])
-else:
-varnameparts = tuple()
-else:
-varnameparts = (varname,)
 try:
-obj = self.getvarl(*varnameparts, namespace=varns)
+if not varns:
-return self.substitute_variables_in_obj(obj)
+return self.substitute_variables_in_obj(
+self.getvarl(*pathstr2path(varname)))
+else:
+return self.substitute_variables_in_obj(
+self.getvarl(varname, namespace=varns))
 except KeyError:
 if default is _MARKER:
 raise
 else:
 return default
 Currently used by :meth:`~.interpolate_variables`.
 """
 varns, varname = self._split_ns(varname)
 if not varns:
-cacheable = True
+# no namespace -> cacheable
-if varname:
+return (
-varnameparts = tuple([unquote(vp)
+self.substitute_variables_in_obj(
-for vp in varname.split(_HIER_SEPARATOR)])
+self.getvarl(*pathstr2path(varname))),
-else:
+True
-varnameparts = tuple()
+)
 else:
-cacheable = False
+# results from namespaced lookups are currently not cacheable
-varnameparts = (varname,)
+return (
-obj = self.getvarl(*varnameparts, namespace=varns)
+self.substitute_variables_in_obj(
-return (self.substitute_variables_in_obj(obj), cacheable)
+self.getvarl(varname, namespace=varns)),
+False
+)
 def getfirstvar_s(self, *varnames, **kwds):
 """A variant of :meth:`~.getvar_s` that returns the first found
 variable in the list of given variables in `varnames`.
 end = s.find(_ENDTOK, start)
 if end < 0:
 rest = start
 break
 varname, filters = self._split_filters(
-s[start+2:end])
+s[start+2:end])     # noqa: E226
 try:
 varvalue, cacheable = self._getvar_s_with_cache_info(varname)
 except KeyError:
 cacheable = True
 if NONE_FILTER in filters:
 # convert to path
 varns, varname = self._split_ns(root)
 if varns:
 raise ValueError(
 "jailed configurations do not support namespaces")
-if varname:
+rootpath = pathstr2path(root)
-rootpath = tuple([unquote(p)
-for p in root.split(_HIER_SEPARATOR)])
-else:
-rootpath = tuple()
 jc = _JailedConfiguration(*rootpath)
 if bind_root:
 jc.rebind(self)
 return jc
 else:
 raise TypeError("a paths item must be a list or tuple")
 return self._base.getfirstvarl_s(*real_paths, **kwds)
 def getvar(self, varname, **kwds):
-if varname:
+return self._base.getvarl(*(self._path + pathstr2path(varname)),
-varnameparts = self._path \
+**kwds)
-+ tuple([unquote(vp)
-for vp in varname.split(_HIER_SEPARATOR)])
-else:
-varnameparts = self._path
-return self._base.getvarl(*varnameparts, **kwds)
 def getkeys(self, varname):
-if varname:
+for k in self._base.getkeysl(*(self._path + pathstr2path(varname))):
-varnameparts = self._path \
-+ tuple([unquote(vp)
-for vp in varname.split(_HIER_SEPARATOR)])
-else:
-varnameparts = self._path
-for k in self._base.getkeysl(*varnameparts):
 yield k
 def getfirstvar(self, *varnames, **kwds):
 real_varnames = [self._pathstr + vn for vn in varnames]
 return self._base.getfirstvar(*real_varnames, **kwds)
 def getvar_s(self, varname, **kwds):
-if varname:
+return self._base.getvarl_s(*(self._path + pathstr2path(varname)),
-varnameparts = self._path \
+**kwds)
-+ tuple([unquote(vp)
-for vp in varname.split(_HIER_SEPARATOR)])
-else:
-varnameparts = self._path
-return self._base.getvarl_s(*varnameparts, **kwds)
 def getfirstvar_s(self, *varnames, **kwds):
 real_varnames = [self._pathstr + vn for vn in varnames]
 return self._base.getfirstvar_s(*real_varnames, **kwds)
 # convert to path
 varns, varname = self._base._split_ns(root)
 if varns:
 raise ValueError(
 "sub-jails do not support namespaces")
-if varname:
+rootpath = pathstr2path(varname)
-rootpath = tuple([unquote(p)
-for p in varname.split(_HIER_SEPARATOR)])
-else:
-rootpath = tuple()
 if self._path:
 new_rootpath = self._path + tuple(rootpath)
 else:
 new_rootpath = tuple(rootpath)
 sjc = _JailedConfiguration(*new_rootpath)

Mercurial > hgrepos > Python > libs > ConfigMix

comparison configmix/config.py @ 539:9546d38cd3f8