remove deprecated ansible.module_utils._text from documentation (#73211)

According to comment in ansible.module_utils._text it is deprecated and
should not be used. This is now reflected in the documentation.
pull/74354/head
schurzi 4 years ago committed by GitHub
parent 99a2b5f300
commit 5e5bfa8116
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -100,7 +100,7 @@ In the Python example the ``module_util`` in question is called ``qradar`` such
.. code-block:: python .. code-block:: python
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_text from ansible.module_utils.common.text.converters import to_text
from ansible.module_utils.six.moves.urllib.parse import urlencode, quote_plus from ansible.module_utils.six.moves.urllib.parse import urlencode, quote_plus
from ansible.module_utils.six.moves.urllib.error import HTTPError from ansible.module_utils.six.moves.urllib.error import HTTPError

@ -29,7 +29,7 @@ You should return errors encountered during plugin execution by raising ``Ansibl
.. code-block:: python .. code-block:: python
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
try: try:
cause_an_exception() cause_an_exception()
@ -45,7 +45,7 @@ You must convert any strings returned by your plugin into Python's unicode type.
.. code-block:: python .. code-block:: python
from ansible.module_utils._text import to_text from ansible.module_utils.common.text.converters import to_text
result_string = to_text(result_string) result_string = to_text(result_string)
Plugin configuration & documentation standards Plugin configuration & documentation standards

@ -116,7 +116,7 @@ to yield text but instead do the conversion explicitly ourselves. For example:
.. code-block:: python .. code-block:: python
from ansible.module_utils._text import to_text from ansible.module_utils.common.text.converters import to_text
with open('filename-with-utf8-data.txt', 'rb') as my_file: with open('filename-with-utf8-data.txt', 'rb') as my_file:
b_data = my_file.read() b_data = my_file.read()
@ -136,7 +136,7 @@ Writing to files is the opposite process:
.. code-block:: python .. code-block:: python
from ansible.module_utils._text import to_bytes from ansible.module_utils.common.text.converters import to_bytes
with open('filename.txt', 'wb') as my_file: with open('filename.txt', 'wb') as my_file:
my_file.write(to_bytes(some_text_string)) my_file.write(to_bytes(some_text_string))
@ -160,7 +160,7 @@ works on both versions:
import os.path import os.path
from ansible.module_utils._text import to_bytes from ansible.module_utils.common.text.converters import to_bytes
filename = u'/var/tmp/くらとみ.txt' filename = u'/var/tmp/くらとみ.txt'
f = open(to_bytes(filename), 'wb') f = open(to_bytes(filename), 'wb')
@ -246,9 +246,9 @@ In ``module_utils`` code:
* Functions that return strings **must** document whether they return strings of the same type as they were given or native strings. * Functions that return strings **must** document whether they return strings of the same type as they were given or native strings.
Module-utils functions are therefore often very defensive in nature. Module-utils functions are therefore often very defensive in nature.
They convert their string parameters into text (using ``ansible.module_utils._text.to_text``) They convert their string parameters into text (using ``ansible.module_utils.common.text.converters.to_text``)
at the beginning of the function, do their work, and then convert at the beginning of the function, do their work, and then convert
the return values into the native string type (using ``ansible.module_utils._text.to_native``) the return values into the native string type (using ``ansible.module_utils.common.text.converters.to_native``)
or back to the string type that their parameters received. or back to the string type that their parameters received.
Tips, tricks, and idioms for Python 2/Python 3 compatibility Tips, tricks, and idioms for Python 2/Python 3 compatibility

@ -225,7 +225,7 @@ In the Python example the ``module_utils`` is ``helper`` and the :abbr:`FQCN (Fu
.. code-block:: text .. code-block:: text
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_text from ansible.module_utils.common.text.converters import to_text
from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.six.moves.urllib.parse import urlencode
from ansible.module_utils.six.moves.urllib.error import HTTPError from ansible.module_utils.six.moves.urllib.error import HTTPError
from ansible_collections.ansible_example.community.plugins.module_utils.helper import HelperRequest from ansible_collections.ansible_example.community.plugins.module_utils.helper import HelperRequest

@ -7,5 +7,5 @@ from ``ansible.module_utils.six`` and then use ``isinstance(s, string_types)``
or ``isinstance(s, (binary_type, text_type))`` instead. or ``isinstance(s, (binary_type, text_type))`` instead.
If this is part of code to convert a string to a particular type, If this is part of code to convert a string to a particular type,
``ansible.module_utils._text`` contains several functions that may be even ``ansible.module_utils.common.text.converters`` contains several functions
better for you: ``to_text``, ``to_bytes``, and ``to_native``. that may be even better for you: ``to_text``, ``to_bytes``, and ``to_native``.

@ -296,7 +296,7 @@ variable is set it will be treated as if the input came on ``STDIN`` to the modu
import json import json
from units.modules.utils import set_module_args from units.modules.utils import set_module_args
from ansible.module_utils._text import to_bytes from ansible.module_utils.common.text.converters import to_bytes
def test_already_registered(self): def test_already_registered(self):
set_module_args({ set_module_args({
@ -388,7 +388,7 @@ mock for :meth:`Ansible.get_bin_path`::
from units.compat import unittest from units.compat import unittest
from units.compat.mock import patch from units.compat.mock import patch
from ansible.module_utils import basic from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes from ansible.module_utils.common.text.converters import to_bytes
from ansible.modules.namespace import my_module from ansible.modules.namespace import my_module

Loading…
Cancel
Save