jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow overriding ensure_ascii in the "to_json" template filter (#20218)

Browse Source 
* to_json: add ensure_ascii

* Update source/_docs/configuration/templating.markdown

Co-authored-by: Erik Montnemery <erik@montnemery.com>

* lint

Co-authored-by: Erik Montnemery <erik@montnemery.com>
This commit is contained in:
Chris Browet 2021-11-08 17:27:45 +01:00 committed by GitHub
parent e32c562346
commit eab53f8c2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_docs/configuration/templating.markdown
View File

@ -357,6 +357,8 @@ To fix it, enforce the ISO conversion via `isoformat()`:
The `to_json` filter serializes an object to a JSON string. In some cases, it may be necessary to format a JSON string for use with a webhook, as a parameter for command-line utilities or any number of other applications. This can be complicated in a template, especially when dealing with escaping special characters. Using the `to_json` filter, this is handled automatically.
Similarly to the Python equivalent, the filter accepts an `ensure_ascii` parameter, defaulting to `True`. If `ensure_ascii` is `True`, the output is guaranteed to have all incoming non-ASCII characters escaped. If `ensure_ascii` is false, these characters will be output as-is.
The `from_json` filter operates similarly, but in the other direction, de-serializing a JSON string back into an object.
### To/From JSON examples
@ -370,7 +372,7 @@ In this example, the special character '°' will be automatically escaped in ord
```text
{% set temp = {'temperature': 25, 'unit': '°C'} %}
stringified object: {{ temp }}
object|to_json: {{ temp|to_json }}
object|to_json: {{ temp|to_json(ensure_ascii=False) }}
```
{% endraw %}