cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

enchance yaml filter documentation (#46629)

Browse source 
* update to_*_yaml filter documentation

* update to*_yaml filter documentation
This commit is contained in:
Rushan 2018-11-08 04:23:47 +03:00 committed by ansibot
parent 58ae93d273
commit cc5b9c5fe1
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/docsite/rst/user_guide/playbooks_filters.rst
View file

@ -33,6 +33,17 @@ It's also possible to change the indentation of both (new in version 2.2)::
{{ some_variable | to_nice_json(indent=2) }}
{{ some_variable | to_nice_yaml(indent=8) }}
``to_yaml`` and ``to_nice_yaml`` filters use `PyYAML library`_ which has a default 80 symbol string length limit. That causes unexpected line break after 80th symbol (if there is a space after 80th symbol)
To avoid such behaviour and generate long lines it is possible to use ``width`` option::
{{ some_variable | to_yaml(indent=8, width=1337) }}
{{ some_variable | to_nice_yaml(indent=8, width=1337) }}
While it would be nicer to use a construction like ``float("inf")`` instead of hardcoded number, unfortunately the filter doesn't support proxying python functions.
Note that it also supports passing through other YAML parameters. Full list can be found in `PyYAML documentation`_.
Alternatively, you may be reading in some already formatted data::
{{ some_variable | from_json }}
@ -1250,6 +1261,11 @@ to be added to core so everyone can make use of them.
.. _builtin filters: http://jinja.pocoo.org/docs/templates/#builtin-filters
.. _PyYAML library: https://pyyaml.org/
.. _PyYAML documentation: https://pyyaml.org/wiki/PyYAMLDocumentation
.. seealso::
:doc:`playbooks`