Replace deprecated module_utils imports before ansible-core 2.24 removal

ansible-core 2.20 deprecated `ansible.module_utils._text` and
`ansible.module_utils.common._collections_compat`. Both will be removed
in ansible-core 2.24.

Replace all occurrences across plugins, callbacks, and tests:

- `from ansible.module_utils._text import ...`
  → `from ansible.module_utils.common.text.converters import ...`

- `from ansible.module_utils.common._collections_compat import ...`
  → `from collections.abc import ...`

Also remove the now-unnecessary `pylint:ansible-bad-import-from` entries
from the sanity ignore list for the affected files, and add a unit test
that scans for these deprecated patterns to prevent regressions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Kevin Burke 2026-02-15 21:52:07 +09:00
parent 5f44339fa5
commit 736e846008
23 changed files with 92 additions and 29 deletions

View file

@ -21,7 +21,7 @@ __metaclass__ = type
import os
from ansible.errors import AnsibleError, AnsibleAction, _AnsibleActionDone, AnsibleActionFail
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
from ansible.module_utils.parsing.convert_bool import boolean
from ansible.plugins.action import ActionBase

View file

@ -22,8 +22,8 @@ import os.path
from ansible import constants as C
from ansible.module_utils.six import string_types
from ansible.module_utils.six.moves import shlex_quote
from ansible.module_utils._text import to_text
from ansible.module_utils.common._collections_compat import MutableSequence
from ansible.module_utils.common.text.converters import to_text
from collections.abc import MutableSequence
from ansible.module_utils.parsing.convert_bool import boolean
from ansible.plugins.action import ActionBase
from ansible.plugins.loader import connection_loader

View file

@ -141,7 +141,7 @@ from abc import ABCMeta, abstractmethod
from functools import partial
from ansible.module_utils._text import to_bytes, to_text
from ansible.module_utils.common.text.converters import to_bytes, to_text
from ansible.module_utils.six import with_metaclass
from ansible.parsing.ajson import AnsibleJSONEncoder
from ansible.plugins.callback import CallbackBase

View file

@ -48,7 +48,7 @@ import json
from functools import partial
from ansible.inventory.host import Host
from ansible.module_utils._text import to_text
from ansible.module_utils.common.text.converters import to_text
from ansible.parsing.ajson import AnsibleJSONEncoder
from ansible.plugins.callback import CallbackBase

View file

@ -50,7 +50,7 @@ import copy
from functools import partial
from ansible.inventory.host import Host
from ansible.module_utils._text import to_text
from ansible.module_utils.common.text.converters import to_text
from ansible.parsing.ajson import AnsibleJSONEncoder
from ansible.plugins.callback import CallbackBase

View file

@ -147,7 +147,7 @@ import os
import platform
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
def split_entry(entry):

View file

@ -229,7 +229,7 @@ import errno
import traceback
from operator import itemgetter
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
from ansible.module_utils.six.moves.urllib.parse import urlparse

View file

@ -210,7 +210,7 @@ firewalld_info:
'''
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
from ansible_collections.ansible.posix.plugins.module_utils._respawn import respawn_module, HAS_RESPAWN_UTIL
from ansible_collections.ansible.posix.plugins.module_utils.version import StrictVersion

View file

@ -226,7 +226,7 @@ import platform
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.ansible.posix.plugins.module_utils.mount import ismount
from ansible.module_utils.six import iteritems
from ansible.module_utils._text import to_bytes, to_native
from ansible.module_utils.common.text.converters import to_bytes, to_native
from ansible.module_utils.parsing.convert_bool import boolean

View file

@ -106,7 +106,7 @@ import os
import platform
from traceback import format_exc
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
class PatchError(Exception):

View file

@ -73,7 +73,7 @@ import os
import traceback
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
def locally_installed(module, pkgname):

View file

@ -71,7 +71,7 @@ import os
import traceback
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native, to_text
from ansible.module_utils.common.text.converters import to_native, to_text
def rpm_ostree_transaction(module):

View file

@ -73,7 +73,7 @@ except ImportError:
HAVE_SEMANAGE = False
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible.module_utils._text import to_text
from ansible.module_utils.common.text.converters import to_text
from ansible_collections.ansible.posix.plugins.module_utils._respawn import respawn_module, HAS_RESPAWN_UTIL

View file

@ -368,7 +368,7 @@ import os
import errno
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_bytes, to_native
from ansible.module_utils.common.text.converters import to_bytes, to_native
from ansible.module_utils.six.moves import shlex_quote

View file

@ -112,7 +112,7 @@ import tempfile
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.six import string_types
from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE
from ansible.module_utils._text import to_native
from ansible.module_utils.common.text.converters import to_native
class SysctlModule(object):

View file

@ -1,10 +1,4 @@
tests/utils/shippable/timing.py shebang
plugins/action/synchronize.py pylint:ansible-bad-import-from
plugins/callback/cgroup_perf_recap.py pylint:ansible-bad-import-from
plugins/modules/mount.py pylint:ansible-bad-import-from
plugins/modules/sysctl.py pylint:ansible-bad-import-from
plugins/shell/csh.py pylint:ansible-bad-import-from
plugins/shell/fish.py pylint:ansible-bad-import-from
tests/unit/mock/procenv.py pylint:ansible-bad-import-from
tests/unit/mock/yaml_helper.py pylint:ansible-bad-import-from
tests/unit/modules/conftest.py pylint:ansible-bad-import-from

View file

@ -23,7 +23,7 @@ import os
from ansible.errors import AnsibleParserError
from ansible.parsing.dataloader import DataLoader
from ansible.module_utils._text import to_bytes, to_text
from ansible.module_utils.common.text.converters import to_bytes, to_text
class DictDataLoader(DataLoader):

View file

@ -27,7 +27,7 @@ from contextlib import contextmanager
from io import BytesIO, StringIO
from ansible_collections.ansible.posix.tests.unit.compat import unittest
from ansible.module_utils.six import PY3
from ansible.module_utils._text import to_bytes
from ansible.module_utils.common.text.converters import to_bytes
@contextmanager

View file

@ -15,7 +15,7 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible.module_utils._text import to_bytes
from ansible.module_utils.common.text.converters import to_bytes
from ansible.parsing.vault import VaultSecret

View file

@ -10,8 +10,8 @@ import json
import pytest
from ansible.module_utils.six import string_types
from ansible.module_utils._text import to_bytes
from ansible.module_utils.common._collections_compat import MutableMapping
from ansible.module_utils.common.text.converters import to_bytes
from collections.abc import MutableMapping
@pytest.fixture

View file

@ -7,7 +7,7 @@ import tempfile
from ansible_collections.ansible.posix.tests.unit.compat import unittest
from ansible_collections.ansible.posix.tests.unit.compat.mock import MagicMock
from ansible.module_utils._text import to_bytes
from ansible.module_utils.common.text.converters import to_bytes
from ansible_collections.ansible.posix.plugins.modules.mount import (
get_linux_mounts,

View file

@ -7,7 +7,7 @@ import json
from ansible_collections.ansible.posix.tests.unit.compat import unittest
from ansible_collections.ansible.posix.tests.unit.compat.mock import patch
from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes
from ansible.module_utils.common.text.converters import to_bytes
def set_module_args(args):

View file

@ -0,0 +1,69 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import os
import re
from ansible_collections.ansible.posix.tests.unit.compat import unittest
# Deprecated import patterns that trigger warnings on ansible-core >= 2.20
# and will be removed in ansible-core 2.24.
DEPRECATED_PATTERNS = [
(
re.compile(r'from ansible\.module_utils\._text import'),
'from ansible.module_utils.common.text.converters import',
),
(
re.compile(r'from ansible\.module_utils\.common\._collections_compat import'),
'from collections.abc import',
),
]
def _get_collection_root():
"""Return the root directory of this collection."""
# tests/unit/test_deprecated_imports.py -> collection root
return os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
def _find_python_files(root):
"""Yield all .py files under root."""
for dirpath, _dirnames, filenames in os.walk(root):
for filename in filenames:
if filename.endswith('.py'):
yield os.path.join(dirpath, filename)
class TestNoDeprecatedImports(unittest.TestCase):
def test_no_deprecated_module_utils_imports(self):
"""Ensure no files use deprecated ansible.module_utils import paths.
ansible-core 2.20 deprecated ``ansible.module_utils._text`` (use
``ansible.module_utils.common.text.converters``) and
``ansible.module_utils.common._collections_compat`` (use
``collections.abc``). Both will be removed in ansible-core 2.24.
"""
root = _get_collection_root()
violations = []
for filepath in _find_python_files(root):
relpath = os.path.relpath(filepath, root)
with open(filepath, 'r') as f:
for lineno, line in enumerate(f, 1):
for pattern, replacement in DEPRECATED_PATTERNS:
if pattern.search(line):
violations.append(
'%s:%d: deprecated import found:\n'
' %s\n'
' replace with: %s'
% (relpath, lineno, line.rstrip(), replacement)
)
if violations:
self.fail(
'Found deprecated imports that will break on ansible-core 2.24:\n\n'
+ '\n\n'.join(violations)
)