flare.viur.formatString¶
Module Contents¶
Functions¶
|
Central entryPoint |
|
|
|
Parses a string given by format and substitutes placeholders using values specified by data. |
|
|
|
- flare.viur.formatString.formatString(format: str, data: Dict, structure=None, language=None)¶
Central entryPoint
if string contains $( we use old formatstrings else we use evalStrings (core 3.0 draft)
displayStrings actually only used in relations and records. This handler can be used with display param
- flare.viur.formatString.formatOneEntry(key, format, data, structure=None, prefix=None, language=None, context=None, _rec=0)¶
- flare.viur.formatString.formatStringHandler(format, data, structure=None, prefix=None, language=None, context=None, _rec=0)¶
Parses a string given by format and substitutes placeholders using values specified by data. The syntax for the placeholders is $(%s). Its possible to traverse to sub-dictionarys by using a dot as seperator. If data is a list, the result each element from this list applied to the given string; joined by “, “. Example: ——-
data = {“name”: “Test”,”subdict”: {“a”:”1”,”b”:”2”}} formatString = “Name: $(name), subdict.a: $(subdict.a)”
“Name: Test, subdict.a: 1” :param format: String containing the format. :type format: str :param data: Data applied to the format String :type data: list | dict :param structure: Parses along the structure of the given skeleton. :type structure: dict :return: The traversed string with the replaced values. :rtype: str
- flare.viur.formatString.displayStringHandler(display: str, value: Dict, structure: Dict, language: str = 'de') [flare.html5.Widget]¶
- flare.viur.formatString.evalStringHandler(format, data, structure, language)¶