Fixes version hint for non-core modules

Switches to bump-my-version

README.rst

@@ -61,8 +61,18 @@ Latest Release
 Changelog
 ---------
 
+- Raises minimum Ansible version to 6
+  [Daverball]
+
+- Adds Python 3.12 support
+  [Daverball]
+
+- Adds proper support for Ansible 8+
+  [Daverball]
+
 - Adds basic auto-generated stubs and docs for `Api` methods
-  created through hooked Ansible modules
+  created through hooked Ansible modules, for now this only
+  includes collections in the ansible namespace
   [Daverball]
 
 0.19.2 (2024-08-22)

pyproject.toml

@@ -29,6 +29,33 @@ mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
 module = ["suitable._module_types"]
 warn_return_any = false
 
+[tool.bumpversion]
+current_version = "0.21.0"
+commit = true
+message = "Release {new_version}"
+tag = true
+tag_message = "Release {new_version}"
+
+[[tool.bumpversion.files]]
+filename="setup.cfg"
+
+[[tool.bumpversion.files]]
+filename="docs/conf.py"
+
+[[tool.bumpversion.files]]
+filename="README.rst"
+search = """
+Changelog
+---------
+"""
+replace = """
+Changelog
+---------
+
+{new_version} ({now:%Y-%m-%d})
+~~~~~~~~~~~~~~~~~~~
+"""
+
 [tool.tox]
 legacy_tox_ini = """
 [tox]

scripts/generate_module_hints.py

@@ -27,7 +27,8 @@
 C.DEPRECATION_WARNINGS = False
 # Make sure we can load all the collection plugins we want to
 init_plugin_loader([])
-version_hint_above = (2, 13)
+core_version_hint_above = (2, 13)
+ansible_version_hint_above = (6, )
 reference_re = re.compile(r'([MLBIUROCVEP]|RV)\(([^)]+)\)')
 modules_py = StringIO()
 modules_header_py = StringIO()
@@ -294,7 +295,7 @@ def write_function_docstring(options: dict[str, Any] | None) -> None:
 
     if version(added := docs.get('version_added', 0)) > version_hint_above:
         modules_py.write(
-            f'\n        .. note:: Requires ansible-core >= {added}\n'
+            f'\n        .. note:: Requires {version_hint_package} >= {added}\n'
         )
 
     if conflicts := docs.get('conflicts'):
@@ -344,7 +345,7 @@ def write_function_docstring(options: dict[str, Any] | None) -> None:
         added = meta.get('version_added')
         if added and version(added) > version_hint_above:
             modules_py.write(
-                f'            Requires ansible-core >= {added}\n'
+                f'            Requires {version_hint_package} >= {added}\n'
             )
 
 
@@ -417,7 +418,8 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
         added = meta.get('version_added')
         if added and version(added) > version_hint_above:
             types_py.write(
-                f'\n        .. note:: Requires ansible-core >= {added}\n'
+                f'\n        .. note:: Requires {version_hint_package} '
+                f'>= {added}\n'
             )
 
         global exceeded_line_limit
@@ -521,10 +523,18 @@ def type_check_only(f):
         return f
 ''')
 current_collection = ''
+version_hint_above: tuple[int, ...]
 for module_name, (collection, docs, returns) in sorted(
     modules.items(),
     key=lambda i: (i[1][0], i[0])
 ):
+    if collection == 'ansible.builtin':
+        version_hint_above = core_version_hint_above
+        version_hint_package = 'ansible-core'
+    else:
+        version_hint_above = ansible_version_hint_above
+        version_hint_package = 'ansible'
+
     if current_collection != collection:
         modules_py.write('\n    #\n')
         types_py.write('\n\n#\n')

setup.cfg

@@ -43,6 +43,7 @@ install_requires =
 
 [options.extras_require]
 dev =
+    bump-my-version
     bandit[toml]
     flake8
     flake8-bugbear

src/suitable/_modules.py

@@ -6350,8 +6350,6 @@ def cli_backup(
         .. seealso::
             :ref:`ansible.netcommon <ansible_collections.ansible.netcommon.cli_backup_module>`
 
-        .. note:: Requires ansible-core >= 4.2.0
-
         :param defaults:
             The *defaults* argument will influence how the running-config is
             collected from the device. When the value is set to true, the
@@ -6536,7 +6534,7 @@ def cli_restore(
         .. seealso::
             :ref:`ansible.netcommon <ansible_collections.ansible.netcommon.cli_restore_module>`
 
-        .. note:: Requires ansible-core >= 6.1.0
+        .. note:: Requires ansible >= 6.1.0
 
         :param filename:
             Filename of the backup file, present in the appliance where the
@@ -6564,8 +6562,6 @@ def grpc_config(
         .. seealso::
             :ref:`ansible.netcommon <ansible_collections.ansible.netcommon.grpc_config_module>`
 
-        .. note:: Requires ansible-core >= 3.1.0
-
         :param config:
             This option specifies the string which acts as a filter to
             restrict the portions of the data to be retrieved from the target
@@ -6603,8 +6599,6 @@ def grpc_get(
         .. seealso::
             :ref:`ansible.netcommon <ansible_collections.ansible.netcommon.grpc_get_module>`
 
-        .. note:: Requires ansible-core >= 3.1.0
-
         :param section:
             This option specifies the string which acts as a filter to
             restrict the portions of the data to be retrieved from the target