From 423a900791d2cd2494a3407e4cfba62623e758cf Mon Sep 17 00:00:00 2001 From: Jordan Borean Date: Tue, 18 Feb 2020 05:31:03 +1000 Subject: [PATCH] Clarify b64encode with Python 2 (#67488) --- docs/docsite/rst/user_guide/playbooks_filters.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/docsite/rst/user_guide/playbooks_filters.rst b/docs/docsite/rst/user_guide/playbooks_filters.rst index 3da2c29d944..967d5185c6c 100644 --- a/docs/docsite/rst/user_guide/playbooks_filters.rst +++ b/docs/docsite/rst/user_guide/playbooks_filters.rst @@ -1512,12 +1512,15 @@ To concatenate a list into a string:: To work with Base64 encoded strings:: {{ encoded | b64decode }} - {{ decoded | b64encode }} + {{ decoded | string | b64encode }} As of version 2.6, you can define the type of encoding to use, the default is ``utf-8``:: {{ encoded | b64decode(encoding='utf-16-le') }} - {{ decoded | b64encode(encoding='utf-16-le') }} + {{ decoded | string | b64encode(encoding='utf-16-le') }} + +.. note:: The ``string`` filter is only required for Python 2 and ensures that text to encode is a unicode string. + Without that filter before b64encode the wrong value will be encoded. .. versionadded:: 2.6