Adds support for Ansible 11 and Python 3.13

Author: Daverball

.github/workflows/python-pr.yaml

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

.github/workflows/python-tox.yaml

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

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
         exclude: '^(.bumpversion.cfg)$'
@@ -18,30 +18,31 @@ repos:
     hooks:
       - id: nocheckin
         exclude: .pre-commit-config.yaml
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.13
     hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear
-        files: '^(src/.*|tests/.*)\.py$'
+      - id: ruff
+        args: [ "--fix" ]
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.9
+    rev: 1.8.3
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml", "--quiet"]
         additional_dependencies: [ "bandit[toml]" ]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.1
+    rev: v1.16.0
     hooks:
       - id: mypy
         additional_dependencies:
           - ansible
           - ansible-core
           - ansible-base
           - mitogen
+          - port_for
+          - pytest
+          - types-paramiko
         exclude: '.*'
         always_run: true
         pass_filenames: false
-        args: ["src"]
+        args: ["-p", "suitable", "-p", "tests"]
 

CHANGELOG.rst

@@ -1,6 +1,9 @@
 Changelog
 ---------
 
+- Adds support for Ansible 11 and Python 3.13
+  [Daverball]
+
 0.20.3 (2024-09-04)
 ~~~~~~~~~~~~~~~~~~~
 

pyproject.toml

@@ -19,7 +19,11 @@ omit = [
 ]
 
 [tool.bandit]
-exclude_dirs = ["tests"]
+exclude_dirs = [
+  "tests",
+  "src/suitable/_module_types.py",
+  "src/suitable/_modules.py",
+]
 skips = ["B101"]
 
 [tool.mypy]
@@ -34,6 +38,123 @@ mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
 module = ["suitable._module_types"]
 warn_return_any = false
 
+[tool.ruff]
+exclude = [
+  ".bzr",
+  ".direnv",
+  ".eggs",
+  ".git",
+  ".git-rewrite",
+  ".hg",
+  ".ipynb_checkpoints",
+  ".mypy_cache",
+  ".nox",
+  ".pants.d",
+  ".pyenv",
+  ".pytest_cache",
+  ".pytype",
+  ".ruff_cache",
+  ".svn",
+  ".tox",
+  ".venv",
+  ".vscode",
+  "__pypackages__",
+  "_build",
+  "buck-out",
+  "build",
+  "dist",
+  "node_modules",
+  "site-packages",
+  "venv",
+]
+src = ["scripts", "src", "test"]
+include = [
+  "pyproject.toml",
+  "scripts/**/*.py",
+  "src/**/*.py",
+  "tests/**/*.py",
+]
+line-length = 80
+indent-width = 4
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+  "A005",
+  "ASYNC",
+  "B0",
+  "B904",
+  "B909",
+  "C4",
+  "COM818",
+  "E",
+  "F",
+  "FLY002",
+  "FURB",
+  "G010",
+  "G2",
+  "I002",
+  "ISC",
+  "LOG",
+  "N",
+  "PERF",
+  "PGH004",
+  "PGH005",
+  "PIE",
+  "PYI",
+  "Q",
+  "RUF",
+  "SIM",
+  "SLOT",
+  "T",
+  "UP",
+  "W",
+]
+ignore = [
+  "FURB103",
+  "SIM105",
+  "SIM118",
+]
+unfixable = []
+preview = true
+
+[tool.ruff.lint.extend-per-file-ignores]
+"scripts/**/*.py" = [
+  "T",
+]
+"tests/**/*.py" = [
+  "RUF012",
+  "SIM108",
+]
+"src/suitable/_module*s.py" = [
+  "PYI041",
+  "RUF100",
+]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.lint.pep8-naming]
+extend-ignore-names = []
+classmethod-decorators = []
+
+[tool.ruff.lint.flake8-quotes]
+avoid-escape = true
+docstring-quotes = "double"
+inline-quotes = "single"
+multiline-quotes = "double"
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "lf"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
 [tool.bumpversion]
 current_version = "0.20.3"
 commit = true
@@ -70,7 +191,8 @@ envlist =
   py{39,310,311}-ansible8
   py{310,311,312}-ansible9
   py{310,311,312}-ansible10
-  flake8
+  py{311,312,313}-ansible11
+  ruff
   bandit
   mypy
   report
@@ -79,14 +201,15 @@ envlist =
 python =
     3.8: py38
     3.9: py39
-    3.10: py310,flake8,bandit,mypy
-    3.11: py311
+    3.10: py310
+    3.11: py311,ruff,bandit,mypy
     3.12: py312
+    3.13: py313
 
 [testenv]
 usedevelop = true
 setenv =
-  py{38,39,310,311,312}: COVERAGE_FILE = .coverage.{envname}
+  py{38,39,310,311,312,313}: COVERAGE_FILE = .coverage.{envname}
 deps =
   -e{toxinidir}[tests]
   ansible6: ansible==6.*
@@ -99,38 +222,41 @@ deps =
   ansible9: ansible-core==2.16.*
   ansible10: ansible==10.*
   ansible10: ansible-core==2.17.*
+  ansible11: ansible==11.*
+  ansible11: ansible-core==2.18.*
 
 commands = pytest --cov --cov-report= {posargs}
 
 passenv = *
 
-[testenv:flake8]
-basepython = python3.10
+[testenv:ruff]
+basepython = python3.11
 skip_install = true
 deps =
-  flake8
-  flake8-bugbear
-commands = flake8 src/ tests/
+  ruff
+commands = ruff check
 
 [testenv:bandit]
-basepython = python3.10
+basepython = python3.11
 skip_install = true
 deps =
   bandit[toml]
 commands = bandit -q -c pyproject.toml -r src
 
 [testenv:mypy]
-basepython = python3.10
+basepython = python3.11
 deps =
     -e{toxinidir}
     mypy
     mitogen
+    types-paramiko
 commands =
-  mypy -p suitable --python-version 3.8
-  mypy -p suitable --python-version 3.9
-  mypy -p suitable --python-version 3.10
-  mypy -p suitable --python-version 3.11
-  mypy -p suitable --python-version 3.12
+  mypy -p suitable -p tests --python-version 3.8
+  mypy -p suitable -p tests --python-version 3.9
+  mypy -p suitable -p tests --python-version 3.10
+  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
 
 [testenv:report]
 deps =

scripts/generate_module_hints.py

@@ -10,7 +10,7 @@
 import os
 import re
 
-from ansible import constants as C  # type:ignore
+from ansible import constants as C  # type:ignore  # noqa: N812
 from ansible.plugins.loader import fragment_loader  # type:ignore
 from ansible.plugins.loader import init_plugin_loader
 from ansible.plugins.loader import module_loader
@@ -87,7 +87,7 @@ def write_function_parameter_list(
             and (default := meta['default']) is not None
         ):
             if type_name == 'bool':
-                default = True if default in ('yes', True) else False
+                default = default in ('yes', True)
 
             default_type = type(default).__name__
             if default_type == 'AnsibleUnicode':
@@ -435,7 +435,7 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
         condition = prepare_docstring_line(
             meta.get('returned', 'unspecified')
         )
-        if condition.startswith('When') or condition.startswith('when'):
+        if condition.startswith(('When', 'when')):
             condition = condition[5:]
         types_py.write('\n')
         for line in split_docstring_lines(f'Returned when: {condition}'):
@@ -455,7 +455,7 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
         else:
             types_py.write('        """\n')
         types_py.write(
-            f'        return self.acquire(server, \'{name}\')\n'
+            f"        return self.acquire(server, '{name}')\n"
         )
 
 
@@ -507,7 +507,7 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
             conflicts.append(collection)
 
 
-modules_header_py.write('''\
+modules_header_py.write("""\
 # This is an auto-generated file. Please don't manually edit.
 # Instead call `scripts/generate_module_hints.py`
 
@@ -519,8 +519,8 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
     from _typeshed import StrPath
     from collections.abc import Mapping, Sequence
     from suitable._module_types import (
-''')
-modules_py.write('''\
+""")
+modules_py.write("""\
     )
     from suitable.types import Incomplete
 
@@ -531,8 +531,8 @@ def write_return_type(returns: dict[str, Any] | None) -> None:
 
 
 class AnsibleModules:
-''')
-types_py.write('''\
+""")
+types_py.write("""\
 # This is an auto-generated file. Please don't manually edit.
 # Instead call `scripts/generate_module_hints.py`
 
@@ -547,7 +547,7 @@ class AnsibleModules:
 else:
     def type_check_only(f):
         return f
-''')
+""")
 current_collection = ''
 version_hint_above: tuple[int, ...]
 for module_name, (collection, docs, returns) in sorted(