Avoid six. (#177)

felixfontein · web-flow · commit 910567b949d0 · 2025-10-03T21:24:43.000+02:00
diff --git a/changelogs/fragments/177-six.yml b/changelogs/fragments/177-six.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - "Avoid using ``ansible.module_utils.six`` to avoid deprecation warnings with ansible-core 2.20 (https://github.com/ansible-collections/community.hrobot/pull/177)."
diff --git a/plugins/module_utils/api.py b/plugins/module_utils/api.py
@@ -7,10 +7,9 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+import sys
 
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six import PY3
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.urls import fetch_url
 
 import time
@@ -19,6 +18,12 @@
     CheckDoneTimeoutException,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 API_DEFAULT_ARGUMENT_SPEC = dict(
     hetzner_token=dict(type='str', required=True, no_log=True),
@@ -75,7 +80,7 @@ def raw_api_fetch_url_json(
     try:
         # In Python 2, reading from a closed response yields a TypeError.
         # In Python 3, read() simply returns ''
-        if PY3 and resp.closed:
+        if sys.version_info[0] > 2 and resp.closed:
             raise TypeError
         content = resp.read()
     except (AttributeError, TypeError):
diff --git a/plugins/module_utils/failover.py b/plugins/module_utils/failover.py
@@ -7,16 +7,19 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-
 import json
 
-from ansible.module_utils.six.moves.urllib.parse import urlencode
-
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
     fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def get_failover_record(module, ip):
     '''
diff --git a/plugins/module_utils/robot.py b/plugins/module_utils/robot.py
@@ -7,9 +7,9 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+import sys
 
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six import PY3
 from ansible.module_utils.six.moves.urllib.error import HTTPError
 from ansible.module_utils.urls import fetch_url, open_url
 
@@ -151,7 +151,7 @@ def raw_fetch_url_json(module, url, method='GET', timeout=10, data=None, headers
     try:
         # In Python 2, reading from a closed response yields a TypeError.
         # In Python 3, read() simply returns ''
-        if PY3 and resp.closed:
+        if sys.version_info[0] > 2 and resp.closed:
             raise TypeError
         content = resp.read()
     except (AttributeError, TypeError):
diff --git a/plugins/modules/boot.py b/plugins/modules/boot.py
@@ -276,7 +276,6 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -289,6 +288,12 @@
     extract_fingerprint,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 BOOT_CONFIGURATION_DATA = [
     ('rescue', 'rescue', {
diff --git a/plugins/modules/firewall.py b/plugins/modules/firewall.py
@@ -442,7 +442,6 @@
     fetch_url_json,
     fetch_url_json_with_retries,
 )
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.common.text.converters import to_native, to_text
 
 try:
@@ -453,6 +452,12 @@
     IPADDRESS_IMP_ERR = traceback.format_exc()
     HAS_IPADDRESS = False
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 RULE_OPTION_NAMES = [
     'name', 'ip_version', 'dst_ip', 'dst_port', 'src_ip', 'src_port',
diff --git a/plugins/modules/reset.py b/plugins/modules/reset.py
@@ -91,14 +91,19 @@
 RETURN = r"""#"""
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
     ROBOT_DEFAULT_ARGUMENT_SPEC,
     fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def main():
     argument_spec = dict(
diff --git a/plugins/modules/reverse_dns.py b/plugins/modules/reverse_dns.py
@@ -76,14 +76,19 @@
 RETURN = r"""#"""
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
     ROBOT_DEFAULT_ARGUMENT_SPEC,
     fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def main():
     argument_spec = dict(
diff --git a/plugins/modules/server.py b/plugins/modules/server.py
@@ -212,14 +212,19 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
     ROBOT_DEFAULT_ARGUMENT_SPEC,
     fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def main():
     argument_spec = dict(
diff --git a/plugins/modules/ssh_key.py b/plugins/modules/ssh_key.py
@@ -96,7 +96,6 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -111,6 +110,12 @@
     remove_comment,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def main():
     argument_spec = dict(
diff --git a/plugins/modules/storagebox.py b/plugins/modules/storagebox.py
@@ -122,7 +122,6 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -140,6 +139,12 @@
     api_fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 PARAMETERS_LEGACY = {
     'name': ('name', 'storagebox_name'),
diff --git a/plugins/modules/storagebox_info.py b/plugins/modules/storagebox_info.py
@@ -517,7 +517,6 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -534,6 +533,12 @@
     api_fetch_url_json_list,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 _CONVERT = {
     "login": ["username"],
diff --git a/plugins/modules/storagebox_set_password.py b/plugins/modules/storagebox_set_password.py
@@ -81,7 +81,6 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -98,6 +97,12 @@
     api_apply_action,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def main():
     argument_spec = dict(
diff --git a/plugins/modules/storagebox_snapshot.py b/plugins/modules/storagebox_snapshot.py
@@ -104,8 +104,6 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
-
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -123,6 +121,12 @@
     api_fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def legacy_handle_errors(module, error, storagebox_id=None, snapshot_name=None):
     error_messages = {
diff --git a/plugins/modules/storagebox_snapshot_plan.py b/plugins/modules/storagebox_snapshot_plan.py
@@ -167,7 +167,6 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -185,6 +184,12 @@
     api_fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 LEGACY_PARAMETERS = {
     'status': ('status', 'status'),  # according to the API docs 'status' cannot be provided as input to POST, but that's not true
diff --git a/plugins/modules/storagebox_subaccount.py b/plugins/modules/storagebox_subaccount.py
@@ -276,7 +276,6 @@
 
 from copy import deepcopy
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.robot import (
     BASE_URL,
@@ -294,6 +293,12 @@
     api_fetch_url_json,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 
 def legacy_encode_data(data):
     """Converts booleans to lowercase strings and filters out None values."""
diff --git a/plugins/modules/v_switch.py b/plugins/modules/v_switch.py
@@ -240,7 +240,6 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six.moves.urllib.parse import urlencode
 
 from ansible_collections.community.hrobot.plugins.module_utils.common import (
     CheckDoneTimeoutException,
@@ -253,6 +252,12 @@
     fetch_url_json_with_retries,
 )
 
+try:
+    from urllib.parse import urlencode
+except ImportError:
+    # Python 2.x fallback:
+    from urllib import urlencode
+
 V_SWITCH_BASE_URL = '{0}/vswitch'.format(BASE_URL)
 
 
diff --git a/plugins/plugin_utils/unsafe.py b/plugins/plugin_utils/unsafe.py
@@ -6,15 +6,22 @@
 __metaclass__ = type
 
 import re
+import sys
 
-from ansible.module_utils.six import binary_type, text_type
 from collections.abc import Mapping, Set
 from ansible.module_utils.common.collections import is_sequence
 from ansible.utils.unsafe_proxy import (
     AnsibleUnsafe,
     wrap_var as _make_unsafe,
 )
 
+if sys.version_info[0] == 2:
+    binary_type = str
+    text_type = unicode  # noqa: F821, pylint: disable=undefined-variable
+else:
+    binary_type = bytes
+    text_type = str
+
 _RE_TEMPLATE_CHARS = re.compile(u'[{}]')
 _RE_TEMPLATE_CHARS_BYTES = re.compile(b'[{}]')
 
diff --git a/tests/sanity/ignore-2.20.txt b/tests/sanity/ignore-2.20.txt
@@ -1,4 +1 @@
-plugins/module_utils/api.py pylint:ansible-bad-import-from
-plugins/module_utils/robot.py pylint:ansible-bad-import-from
-plugins/plugin_utils/unsafe.py pylint:ansible-bad-import-from
 tests/ee/roles/smoke/library/smoke_ipaddress.py shebang

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+bugfixes:`
	`2`	+ - "Avoid using ``ansible.module_utils.six`` to avoid deprecation warnings with ansible-core 2.20 (https://github.com/ansible-collections/community.hrobot/pull/177)."