Adds support for Ansible 12, Ansible 13 and Python 3.14

Author: Daverball

.github/workflows/python-pr.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, '3.10', '3.11', '3.12', '3.13']
+        python-version: [3.9, '3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/python-tox.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, '3.10', '3.11', '3.12', '3.13']
+        python-version: [3.9, '3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
       - uses: actions/checkout@v4

.pre-commit-config.yaml

@@ -45,5 +45,6 @@ repos:
         exclude: '.*'
         always_run: true
         pass_filenames: false
+        language_version: python3.9
         args: ["-p", "suitable", "-p", "tests"]
 

CHANGELOG.rst

@@ -1,6 +1,9 @@
 Changelog
 ---------
 
+- Adds support for Ansible 12, Ansible 13 and Python 3.14
+  [Daverball]
+
 0.22.0-rc0 (2025-09-04)
 ~~~~~~~~~~~~~~~~~~~~~~~
 

pyproject.toml

@@ -210,6 +210,7 @@ envlist =
   py{310,311,312}-ansible10
   py{311,312,313}-ansible11
   py{311,312,313}-ansible12
+  py{312,313,314}-ansible13
   ruff
   bandit
   mypy
@@ -222,6 +223,7 @@ python =
     3.11: py311,ruff,bandit,mypy
     3.12: py312
     3.13: py313
+    3.14: py314
 
 [testenv]
 usedevelop = true
@@ -242,6 +244,8 @@ deps =
   ansible11: ansible-core==2.18.*
   ansible12: ansible==12.*
   ansible12: ansible-core==2.19.*
+  ansible13: ansible==13.*
+  ansible13: ansible-core==2.20.*
 
 commands = pytest --cov --cov-report= {posargs}
 
@@ -276,6 +280,7 @@ commands =
   mypy -p suitable -p tests --python-version 3.11
   mypy -p suitable -p tests --python-version 3.12
   mypy -p suitable -p tests --python-version 3.13
+  mypy -p suitable -p tests --python-version 3.14
 
 [testenv:report]
 deps =

scripts/generate_module_hints.py

@@ -9,6 +9,7 @@
 
 import os
 import re
+import textwrap
 
 from ansible import constants as C  # type:ignore  # noqa: N812
 from ansible.plugins.loader import fragment_loader  # type:ignore
@@ -81,6 +82,8 @@ def write_function_parameter_list(
             name = 'async_'
         # if the type is not set it appears to always be str
         type_name = type_map.get(meta.get('type', 'string'), 'Incomplete')
+        if not isinstance(type_name, str):
+            raise ValueError(type_name)
         if print_default := (
             type_name not in ('Mapping', 'Sequence', 'Incomplete')
             and 'default' in meta
@@ -90,9 +93,11 @@ def write_function_parameter_list(
                 default = default in ('yes', True)
 
             default_type = type(default).__name__
+            if default_type.startswith('_AnsibleTagged'):
+                default_type = default_type[14:].lower()
             if default_type == 'AnsibleUnicode':
                 default_type = 'str'
-            elif default_type == 'AnsibleSequence':
+            elif default_type in ('AnsibleSequence', 'list'):
                 default_type = 'str'
                 # we don't want to render this
                 default = ' '
@@ -371,11 +376,19 @@ def write_function_docstring(options: dict[str, Any] | None) -> None:
 
 def write_return_type(returns: dict[str, Any] | None) -> None:
     assert RunnerResults.__doc__
+    # NOTE: Starting with Python 3.13 docstrings are automatically
+    #       dedented and stripped like this, so if we want consistent
+    #       output between versions we need to pre-process the docstring
+    doc = textwrap.dedent(RunnerResults.__doc__).strip('\r\n')
     types_py.write(
         '\n\n@type_check_only\n'
         f'class {return_type_name}(RunnerResults):\n'
-        f'    """{RunnerResults.__doc__[:-4]}'
+        f'    """\n'
     )
+    for line in doc.splitlines():
+        types_py.write(f'    {line}\n' if line else '\n')
+    types_py.write('\n')
+
     if not returns:
         comment = (
             'The return values for this module were not '

setup.cfg

@@ -23,6 +23,7 @@ classifiers =
     Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3.12
     Programming Language :: Python :: 3.13
+    Programming Language :: Python :: 3.14
     Programming Language :: Python :: Implementation :: CPython
     Topic :: Software Development :: Libraries :: Python Modules
 

src/suitable/_module_types.py

@@ -255,17 +255,17 @@ def ansible_job_id(self, server: str | None = None) -> str:
         """
         return self.acquire(server, 'ansible_job_id')
 
-    def finished(self, server: str | None = None) -> int:
+    def finished(self, server: str | None = None) -> bool:
         """
-        Whether the asynchronous job has finished (``1``) or not (``0``).
+        Whether the asynchronous job has finished or not.
 
         Returned when: always
         """
         return self.acquire(server, 'finished')
 
-    def started(self, server: str | None = None) -> int:
+    def started(self, server: str | None = None) -> bool:
         """
-        Whether the asynchronous job has started (``1``) or not (``0``).
+        Whether the asynchronous job has started or not.
 
         Returned when: always
         """
@@ -1093,15 +1093,6 @@ def remote_url_changed(self, server: str | None = None) -> bool:
         """
         return self.acquire(server, 'remote_url_changed')
 
-    def warnings(self, server: str | None = None) -> str:
-        """
-        List of warnings if requested features were not available due to a too
-        old git version.
-
-        Returned when: error
-        """
-        return self.acquire(server, 'warnings')
-
     def git_dir_now(self, server: str | None = None) -> str:
         """
         Contains the new path of .git directory if it is changed.
@@ -1262,25 +1253,6 @@ class ImportTasksResults(RunnerResults):
     """
 
 
-@type_check_only
-class IncludeResults(RunnerResults):
-    """
-    Wraps the results of parsed module_runner output.
-
-    The result may be used just like it is in Ansible::
-
-        result['contacted']['server']['rc']
-
-    or it can alternatively be used thusly::
-
-        result.rc('server')
-
-    The return values for this module were not documented when these types
-    were auto-generated, this could mean there are no return values.
-
-    """
-
-
 @type_check_only
 class IncludeRoleResults(RunnerResults):
     """
@@ -2720,25 +2692,6 @@ def elapsed(self, server: str | None = None) -> float:
         return self.acquire(server, 'elapsed')
 
 
-@type_check_only
-class YumResults(RunnerResults):
-    """
-    Wraps the results of parsed module_runner output.
-
-    The result may be used just like it is in Ansible::
-
-        result['contacted']['server']['rc']
-
-    or it can alternatively be used thusly::
-
-        result.rc('server')
-
-    The return values for this module were not documented when these types
-    were auto-generated, this could mean there are no return values.
-
-    """
-
-
 @type_check_only
 class YumRepositoryResults(RunnerResults):
     """
@@ -4411,78 +4364,6 @@ def zone(self, server: str | None = None) -> dict[str, Incomplete]:
         return self.acquire(server, 'zone')
 
 
-@type_check_only
-class WinDomainResults(RunnerResults):
-    """
-    Wraps the results of parsed module_runner output.
-
-    The result may be used just like it is in Ansible::
-
-        result['contacted']['server']['rc']
-
-    or it can alternatively be used thusly::
-
-        result.rc('server')
-
-    """
-
-    def reboot_required(self, server: str | None = None) -> bool:
-        """
-        True if changes were made that require a reboot.
-
-        Returned when: always
-        """
-        return self.acquire(server, 'reboot_required')
-
-
-@type_check_only
-class WinDomainControllerResults(RunnerResults):
-    """
-    Wraps the results of parsed module_runner output.
-
-    The result may be used just like it is in Ansible::
-
-        result['contacted']['server']['rc']
-
-    or it can alternatively be used thusly::
-
-        result.rc('server')
-
-    """
-
-    def reboot_required(self, server: str | None = None) -> bool:
-        """
-        True if changes were made that require a reboot.
-
-        Returned when: always
-        """
-        return self.acquire(server, 'reboot_required')
-
-
-@type_check_only
-class WinDomainMembershipResults(RunnerResults):
-    """
-    Wraps the results of parsed module_runner output.
-
-    The result may be used just like it is in Ansible::
-
-        result['contacted']['server']['rc']
-
-    or it can alternatively be used thusly::
-
-        result.rc('server')
-
-    """
-
-    def reboot_required(self, server: str | None = None) -> bool:
-        """
-        True if changes were made that require a reboot.
-
-        Returned when: always
-        """
-        return self.acquire(server, 'reboot_required')
-
-
 @type_check_only
 class WinDscResults(RunnerResults):
     """
@@ -4565,18 +4446,18 @@ def value(self, server: str | None = None) -> str:
         """
         return self.acquire(server, 'value')
 
-    def values(  # type:ignore[override]
-        self,
-        server: str | None = None
-    ) -> dict[str, Incomplete]:
+    def env_values(self, server: str | None = None) -> dict[str, Incomplete]:
         """
-        dictionary of before and after values; each key is a variable name,
+        Dictionary of before and after values; each key is a variable name,
         each value is another dict with ``before``, ``after``, and ``changed``
         keys.
 
+        This is also returned under the ``values`` key for backward
+        compatibility, but that usage is deprecated.
+
         Returned when: always
         """
-        return self.acquire(server, 'values')
+        return self.acquire(server, 'env_values')
 
 
 @type_check_only
@@ -4684,7 +4565,7 @@ def exitcode(self, server: str | None = None) -> str:
         """
         return self.acquire(server, 'exitcode')
 
-    def feature_result(self, server: str | None = None) -> Incomplete:
+    def feature_result(self, server: str | None = None) -> list[Incomplete]:
         """
         List of features that were installed or removed.
 
@@ -6117,7 +5998,7 @@ def filtered_updates(
         """
         Updates that were found but were filtered based on *blacklist*,
         *whitelist* or *category_names*. The return value is in the same form
-        as *updates*, along with *filtered_reason*.
+        as *updates*.
 
         Returned when: success
         """