[PR #11926/c0d3464f backport][stable-12] crypttab: fix option parsing when value contains multiple equal signs (#11929)

crypttab: fix option parsing when value contains multiple equal signs (#11926)

* fix(crypttab): preserve option values containing multiple equal signs

Fixes #4963



* fix(crypttab): add changelog fragment for PR 11926



---------


(cherry picked from commit c0d3464fa7)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

.azure-pipelines/azure-pipelines.yml

@@ -70,6 +70,19 @@ stages:
             - test: 2
             - test: 3
             - test: 4
+  - stage: Sanity_2_21
+    displayName: Sanity 2.21
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.21/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
   - stage: Sanity_2_20
     displayName: Sanity 2.20
     dependsOn: []
@@ -96,19 +109,6 @@ stages:
             - test: 2
             - test: 3
             - test: 4
-  - stage: Sanity_2_18
-    displayName: Sanity 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.18/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
 ### Units
   - stage: Units_devel
     displayName: Units devel
@@ -125,6 +125,19 @@ stages:
             - test: '3.12'
             - test: '3.13'
             - test: '3.14'
+            - test: '3.15'
+  - stage: Units_2_21
+    displayName: Units 2.21
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.21/units/{0}/1
+          targets:
+            - test: 3.9
+            - test: "3.12"
+            - test: "3.14"
   - stage: Units_2_20
     displayName: Units 2.20
     dependsOn: []
@@ -149,18 +162,6 @@ stages:
             - test: 3.8
             - test: "3.11"
             - test: "3.13"
-  - stage: Units_2_18
-    displayName: Units 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.18/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: "3.11"
-            - test: "3.13"
 
 ## Remote
   - stage: Remote_devel_extra_vms
@@ -173,8 +174,8 @@ stages:
           targets:
             - name: Alpine 3.23
               test: alpine/3.23
-            # - name: Fedora 43
-            #   test: fedora/43
+            # - name: Fedora 44
+            #   test: fedora/44
             - name: Ubuntu 22.04
               test: ubuntu/22.04
             - name: Ubuntu 24.04
@@ -189,8 +190,8 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: macOS 15.3
-              test: macos/15.3
+            - name: macOS 26.3
+              test: macos/26.3
             - name: RHEL 10.1
               test: rhel/10.1
             - name: RHEL 9.7
@@ -198,8 +199,27 @@ stages:
             # TODO: enable this ASAP!
             # - name: FreeBSD 15.0
             #   test: freebsd/15.0
-            - name: FreeBSD 14.3
-              test: freebsd/14.3
+            # TODO: enable this ASAP!
+            # - name: FreeBSD 14.4
+            #   test: freebsd/14.4
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Remote_2_21
+    displayName: Remote 2.21
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.21/{0}
+          targets:
+            # - name: macOS 26.3
+            #   test: macos/26.3
+            - name: RHEL 10.1
+              test: rhel/10.1
+            # - name: RHEL 9.7
+            #   test: rhel/9.7
           groups:
             - 1
             - 2
@@ -212,6 +232,8 @@ stages:
         parameters:
           testFormat: 2.20/{0}
           targets:
+            - name: macOS 15.3
+              test: macos/15.3
             - name: RHEL 10.1
               test: rhel/10.1
             - name: FreeBSD 14.3
@@ -236,22 +258,6 @@ stages:
             - 1
             - 2
             - 3
-  - stage: Remote_2_18
-    displayName: Remote 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/{0}
-          targets:
-            - name: macOS 14.3
-              test: macos/14.3
-            - name: FreeBSD 14.1
-              test: freebsd/14.1
-          groups:
-            - 1
-            - 2
-            - 3
 
 ### Docker
   - stage: Docker_devel
@@ -262,8 +268,8 @@ stages:
         parameters:
           testFormat: devel/linux/{0}
           targets:
-            - name: Fedora 43
-              test: fedora43
+            - name: Fedora 44
+              test: fedora44
             - name: Alpine 3.23
               test: alpine323
             - name: Ubuntu 22.04
@@ -274,6 +280,26 @@ stages:
             - 1
             - 2
             - 3
+  - stage: Docker_2_21
+    displayName: Docker 2.21
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.21/linux/{0}
+          targets:
+            - name: Fedora 43
+              test: fedora43
+            # - name: Alpine 3.23
+            #   test: alpine323
+            # - name: Ubuntu 22.04
+            #   test: ubuntu2204
+            - name: Ubuntu 24.04
+              test: ubuntu2404
+          groups:
+            - 1
+            - 2
+            - 3
   - stage: Docker_2_20
     displayName: Docker 2.20
     dependsOn: []
@@ -306,24 +332,6 @@ stages:
             - 1
             - 2
             - 3
-  - stage: Docker_2_18
-    displayName: Docker 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/linux/{0}
-          targets:
-            - name: Fedora 40
-              test: fedora40
-            - name: Alpine 3.20
-              test: alpine320
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
 
 ### Community Docker
   - stage: Docker_community_devel
@@ -359,6 +367,18 @@ stages:
 #          testFormat: devel/generic/{0}/1
 #          targets:
 #            - test: '3.9'
+#            - test: '3.13'
+#            - test: '3.15'
+#  - stage: Generic_2_21
+#    displayName: Generic 2.21
+#    dependsOn: []
+#    jobs:
+#      - template: templates/matrix.yml
+#        parameters:
+#          nameFormat: Python {0}
+#          testFormat: 2.21/generic/{0}/1
+#          targets:
+#            - test: '3.9'
 #            - test: '3.12'
 #            - test: '3.14'
 #  - stage: Generic_2_20
@@ -382,44 +402,33 @@ stages:
 #          testFormat: 2.19/generic/{0}/1
 #          targets:
 #            - test: '3.9'
-#            - test: '3.13'
-#  - stage: Generic_2_18
-#    displayName: Generic 2.18
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.18/generic/{0}/1
-#          targets:
-#            - test: '3.8'
 #            - test: '3.13'
 
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
       - Sanity_devel
+      - Sanity_2_21
       - Sanity_2_20
       - Sanity_2_19
-      - Sanity_2_18
       - Units_devel
+      - Units_2_21
       - Units_2_20
       - Units_2_19
-      - Units_2_18
       - Remote_devel_extra_vms
       - Remote_devel
+      - Remote_2_21
       - Remote_2_20
       - Remote_2_19
-      - Remote_2_18
       - Docker_devel
+      - Docker_2_21
       - Docker_2_20
       - Docker_2_19
-      - Docker_2_18
       - Docker_community_devel
 # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
 #      - Generic_devel
+#      - Generic_2_21
 #      - Generic_2_20
 #      - Generic_2_19
-#      - Generic_2_18
     jobs:
       - template: templates/coverage.yml

.azure-pipelines/scripts/combine-coverage.py

@@ -11,8 +11,7 @@ Keep in mind that Azure Pipelines does not enforce unique job display names (onl
 It is up to pipeline authors to avoid name collisions when deviating from the recommended format.
 """
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import re
@@ -24,12 +23,12 @@ def main():
     """Main program entry point."""
     source_directory = sys.argv[1]
 
-    if '/ansible_collections/' in os.getcwd():
+    if "/ansible_collections/" in os.getcwd():
         output_path = "tests/output"
     else:
         output_path = "test/results"
 
-    destination_directory = os.path.join(output_path, 'coverage')
+    destination_directory = os.path.join(output_path, "coverage")
 
     if not os.path.exists(destination_directory):
         os.makedirs(destination_directory)
@@ -38,27 +37,27 @@ def main():
     count = 0
 
     for name in os.listdir(source_directory):
-        match = re.search('^Coverage (?P<attempt>[0-9]+) (?P<label>.+)$', name)
-        label = match.group('label')
-        attempt = int(match.group('attempt'))
+        match = re.search("^Coverage (?P<attempt>[0-9]+) (?P<label>.+)$", name)
+        label = match.group("label")
+        attempt = int(match.group("attempt"))
         jobs[label] = max(attempt, jobs.get(label, 0))
 
     for label, attempt in jobs.items():
-        name = 'Coverage {attempt} {label}'.format(label=label, attempt=attempt)
+        name = f"Coverage {attempt} {label}"
         source = os.path.join(source_directory, name)
         source_files = os.listdir(source)
 
         for source_file in source_files:
             source_path = os.path.join(source, source_file)
-            destination_path = os.path.join(destination_directory, source_file + '.' + label)
-            print('"%s" -> "%s"' % (source_path, destination_path))
+            destination_path = os.path.join(destination_directory, source_file + "." + label)
+            print(f'"{source_path}" -> "{destination_path}"')
             shutil.copyfile(source_path, destination_path)
             count += 1
 
-    print('Coverage file count: %d' % count)
-    print('##vso[task.setVariable variable=coverageFileCount]%d' % count)
-    print('##vso[task.setVariable variable=outputPath]%s' % output_path)
+    print(f"Coverage file count: {count}")
+    print(f"##vso[task.setVariable variable=coverageFileCount]{count}")
+    print(f"##vso[task.setVariable variable=outputPath]{output_path}")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

.azure-pipelines/scripts/publish-codecov.py

@@ -15,7 +15,6 @@ import pathlib
 import shutil
 import subprocess
 import tempfile
-import typing as t
 import urllib.request
 
 
@@ -23,7 +22,7 @@ import urllib.request
 class CoverageFile:
     name: str
     path: pathlib.Path
-    flags: t.List[str]
+    flags: list[str]
 
 
 @dataclasses.dataclass(frozen=True)
@@ -34,8 +33,8 @@ class Args:
 
 def parse_args() -> Args:
     parser = argparse.ArgumentParser()
-    parser.add_argument('-n', '--dry-run', action='store_true')
-    parser.add_argument('path', type=pathlib.Path)
+    parser.add_argument("-n", "--dry-run", action="store_true")
+    parser.add_argument("path", type=pathlib.Path)
 
     args = parser.parse_args()
 
@@ -46,32 +45,36 @@ def parse_args() -> Args:
     return Args(**kwargs)
 
 
-def process_files(directory: pathlib.Path) -> t.Tuple[CoverageFile, ...]:
+def process_files(directory: pathlib.Path) -> tuple[CoverageFile, ...]:
     processed = []
-    for file in directory.joinpath('reports').glob('coverage*.xml'):
-        name = file.stem.replace('coverage=', '')
+    for file in directory.joinpath("reports").glob("coverage*.xml"):
+        name = file.stem.replace("coverage=", "")
 
         # Get flags from name
-        flags = name.replace('-powershell', '').split('=')  # Drop '-powershell' suffix
-        flags = [flag if not flag.startswith('stub') else flag.split('-')[0] for flag in flags]  # Remove "-01" from stub files
+        flags = name.replace("-powershell", "").split("=")  # Drop '-powershell' suffix
+        flags = [
+            flag if not flag.startswith("stub") else flag.split("-")[0] for flag in flags
+        ]  # Remove "-01" from stub files
 
         processed.append(CoverageFile(name, file, flags))
 
     return tuple(processed)
 
 
-def upload_files(codecov_bin: pathlib.Path, files: t.Tuple[CoverageFile, ...], dry_run: bool = False) -> None:
+def upload_files(codecov_bin: pathlib.Path, files: tuple[CoverageFile, ...], dry_run: bool = False) -> None:
     for file in files:
         cmd = [
             str(codecov_bin),
-            '--name', file.name,
-            '--file', str(file.path),
+            "--name",
+            file.name,
+            "--file",
+            str(file.path),
         ]
         for flag in file.flags:
-            cmd.extend(['--flags', flag])
+            cmd.extend(["--flags", flag])
 
         if dry_run:
-            print(f'DRY-RUN: Would run command: {cmd}')
+            print(f"DRY-RUN: Would run command: {cmd}")
             continue
 
         subprocess.run(cmd, check=True)
@@ -79,11 +82,11 @@ def upload_files(codecov_bin: pathlib.Path, files: t.Tuple[CoverageFile, ...], d
 
 def download_file(url: str, dest: pathlib.Path, flags: int, dry_run: bool = False) -> None:
     if dry_run:
-        print(f'DRY-RUN: Would download {url} to {dest} and set mode to {flags:o}')
+        print(f"DRY-RUN: Would download {url} to {dest} and set mode to {flags:o}")
         return
 
     with urllib.request.urlopen(url) as resp:
-        with dest.open('w+b') as f:
+        with dest.open("w+b") as f:
             # Read data in chunks rather than all at once
             shutil.copyfileobj(resp, f, 64 * 1024)
 
@@ -92,14 +95,14 @@ def download_file(url: str, dest: pathlib.Path, flags: int, dry_run: bool = Fals
 
 def main():
     args = parse_args()
-    url = 'https://ansible-ci-files.s3.amazonaws.com/codecov/linux/codecov'
-    with tempfile.TemporaryDirectory(prefix='codecov-') as tmpdir:
-        codecov_bin = pathlib.Path(tmpdir) / 'codecov'
+    url = "https://ansible-ci-files.s3.amazonaws.com/codecov/linux/codecov"
+    with tempfile.TemporaryDirectory(prefix="codecov-") as tmpdir:
+        codecov_bin = pathlib.Path(tmpdir) / "codecov"
         download_file(url, codecov_bin, 0o755, args.dry_run)
 
         files = process_files(args.path)
         upload_files(codecov_bin, files, args.dry_run)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

.azure-pipelines/scripts/time-command.py

@@ -5,8 +5,7 @@
 
 """Prepends a relative timestamp to each input line from stdin and writes it to stdout."""
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import sys
 import time
@@ -16,14 +15,14 @@ def main():
     """Main program entry point."""
     start = time.time()
 
-    sys.stdin.reconfigure(errors='surrogateescape')
-    sys.stdout.reconfigure(errors='surrogateescape')
+    sys.stdin.reconfigure(errors="surrogateescape")
+    sys.stdout.reconfigure(errors="surrogateescape")
 
     for line in sys.stdin:
-        seconds = time.time() - start
-        sys.stdout.write('%02d:%02d %s' % (seconds // 60, seconds % 60, line))
+        seconds = int(time.time() - start)
+        sys.stdout.write(f"{seconds // 60:02}:{seconds % 60:02} {line}")
         sys.stdout.flush()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

.devcontainer/devcontainer.json

@@ -0,0 +1,34 @@
+{
+  "name": "community.general devcontainer",
+  "image": "mcr.microsoft.com/devcontainers/python:3.14-bookworm",
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash",
+        "python.pythonPath": "/usr/local/bin/python",
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true,
+        "files.autoSave": "afterDelay",
+        "files.eol": "\n",
+        "files.insertFinalNewline": true,
+        "files.trimFinalNewlines": true,
+        "files.trimTrailingWhitespace": true
+      },
+      "extensions": [
+        "charliermarsh.ruff",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "redhat.ansible",
+        "redhat.vscode-yaml",
+        "trond-snekvik.simple-rst"
+      ]
+    }
+  },
+  "remoteUser": "vscode",
+  "postCreateCommand": ".devcontainer/setup.sh",
+  "workspaceFolder": "/workspace/ansible_collections/community/general",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/workspace/ansible_collections/community/general,type=bind"
+}

.devcontainer/devcontainer.json.license

@@ -0,0 +1,3 @@
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https: //www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+SPDX-FileCopyrightText: 2025 Alexei Znamensky <russoz@gmail.com>

.devcontainer/requirements-dev.txt

@@ -1,9 +1,10 @@
----
-# Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Alexei Znamensky <russoz@gmail.com>
 
-- name: delete backports.lzma
-  pip:
-    name: backports.lzma
-    state: absent
+nox
+ruff
+antsibull-nox
+pre-commit
+ansible-core
+andebox

.devcontainer/setup.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+set -x
+sudo chown -R vscode:vscode /workspace/
+
+pip install -U pip
+pip install -r .devcontainer/requirements-dev.txt
+pip install -r tests/unit/requirements.txt
+
+export ANSIBLE_COLLECTIONS_PATH=/workspace:${ANSIBLE_COLLECTIONS_PATH}
+ansible-galaxy collection install -v -r tests/unit/requirements.yml
+ansible-galaxy collection install -v -r tests/integration/requirements.yml
+
+pre-commit install

.git-blame-ignore-revs

@@ -7,3 +7,9 @@ d032de3b16eed11ea3a31cd3d96d78f7c46a2ee0
 e8f965fbf8154ea177c6622da149f2ae8533bd3c
 e938ca5f20651abc160ee6aba10014013d04dcc1
 eaa5e07b2866e05b6c7b5628ca92e9cb1142d008
+
+# Code reformatting
+340ff8586d4f1cb6a0f3c934eb42589bcc29c0ea
+e530d2906a1f61df89861286ac57c951a247f32c
+b769b0bc01520d12699d3911e1fc290b813cde40
+dd9c86dfc094131f223ffb59e5a3d9f2dfc5875d

.github/BOTMETA.yml

@@ -65,6 +65,9 @@ files:
   $callbacks/log_plays.py: {}
   $callbacks/loganalytics.py:
     maintainers: zhcli
+  $callbacks/loganalytics_ingestion.py:
+    ignore: zhcli
+    maintainers: pboushy vsh47 wtcline-intc
   $callbacks/logdna.py: {}
   $callbacks/logentries.py: {}
   $callbacks/logstash.py:
@@ -99,7 +102,6 @@ files:
   $callbacks/unixy.py:
     labels: unixy
     maintainers: akatch
-  $callbacks/yaml.py: {}
   $connections/:
     labels: connections
   $connections/chroot.py: {}
@@ -134,6 +136,8 @@ files:
   $doc_fragments/hwc.py:
     labels: hwc
     maintainers: $team_huawei
+  $doc_fragments/_icinga2_api.py:
+    maintainers: cfiehe
   $doc_fragments/nomad.py:
     maintainers: chris93111 apecnascimento
   $doc_fragments/pipx.py:
@@ -217,6 +221,10 @@ files:
     maintainers: resmo
   $filters/to_time_unit.yml:
     maintainers: resmo
+  $filters/to_toml.py:
+    maintainers: milliams
+  $filters/to_toml.yml:
+    maintainers: milliams
   $filters/to_weeks.yml:
     maintainers: resmo
   $filters/to_yaml.py:
@@ -239,6 +247,9 @@ files:
     maintainers: vbotka
   $inventories/icinga2.py:
     maintainers: BongoEADGC6
+  $inventories/incus.py:
+    labels: incus
+    maintainers: stgraber
   $inventories/linode.py:
     keywords: linode dynamic inventory script
     labels: cloud linode
@@ -301,7 +312,7 @@ files:
   $lookups/lmdb_kv.py:
     maintainers: jpmens
   $lookups/merge_variables.py:
-    maintainers: rlenferink m-a-r-k-e alpex8
+    maintainers: rlenferink m-a-r-k-e alpex8 cfiehe
   $lookups/onepass:
     labels: onepassword
     maintainers: samdoran
@@ -356,6 +367,8 @@ files:
     keywords: cloud huawei hwc
     labels: huawei hwc_utils networking
     maintainers: $team_huawei
+  $module_utils/_icinga2.py:
+    maintainers: cfiehe
   $module_utils/identity/keycloak/keycloak.py:
     maintainers: $team_keycloak
   $module_utils/identity/keycloak/keycloak_clientsecret.py:
@@ -366,6 +379,13 @@ files:
   $module_utils/jenkins.py:
     labels: jenkins
     maintainers: russoz
+  $module_utils/_crypt.py:
+    maintainers: russoz
+  $module_utils/_lxc.py:
+    maintainers: russoz
+  $module_utils/_lvm.py:
+    labels: lvm
+    maintainers: russoz
   $module_utils/manageiq.py:
     labels: manageiq
     maintainers: $team_manageiq
@@ -394,9 +414,6 @@ files:
   $module_utils/puppet.py:
     labels: puppet
     maintainers: russoz
-  $module_utils/pure.py:
-    labels: pure pure_storage
-    maintainers: $team_purestorage
   $module_utils/redfish_utils.py:
     labels: redfish_utils
     maintainers: $team_redfish
@@ -480,8 +497,6 @@ files:
     keywords: beadm dladm illumos ipadm nexenta omnios openindiana pfexec smartos solaris sunos zfs zpool
     labels: beadm solaris
     maintainers: $team_solaris
-  $modules/bearychat.py:
-    maintainers: tonyseek
   $modules/bigpanda.py:
     ignore: hkariti
   $modules/bitbucket_:
@@ -587,9 +602,6 @@ files:
   $modules/etcd3.py:
     ignore: vfauth
     maintainers: evrardjp
-  $modules/facter.py:
-    labels: facter
-    maintainers: $team_ansible_core gamethis
   $modules/facter_facts.py:
     labels: facter
     maintainers: russoz $team_ansible_core gamethis
@@ -598,6 +610,8 @@ files:
   $modules/filesystem.py:
     labels: filesystem
     maintainers: pilou- abulimov quidame
+  $modules/file_remove.py:
+    maintainers: shahargolshani
   $modules/flatpak.py:
     maintainers: $team_flatpak
   $modules/flatpak_remote.py:
@@ -633,6 +647,10 @@ files:
     maintainers: adrianmoisey
   $modules/github_repo.py:
     maintainers: atorrescogollo
+  $modules/github_secrets.py:
+    maintainers: konstruktoid
+  $modules/github_secrets_info.py:
+    maintainers: konstruktoid
   $modules/gitlab_:
     keywords: gitlab source_control
     maintainers: $team_gitlab
@@ -648,10 +666,10 @@ files:
     maintainers: zvaraondrej
   $modules/gitlab_milestone.py:
     maintainers: gpongelli
-  $modules/gitlab_project_variable.py:
-    maintainers: markuman
   $modules/gitlab_instance_variable.py:
     maintainers: benibr
+  $modules/gitlab_project_variable.py:
+    maintainers: markuman
   $modules/gitlab_runner.py:
     maintainers: SamyCoenen
   $modules/gitlab_user.py:
@@ -711,6 +729,8 @@ files:
     maintainers: $team_huawei huaweicloud
   $modules/ibm_sa_:
     maintainers: tzure
+  $modules/icinga2_downtime.py:
+    maintainers: cfiehe
   $modules/icinga2_feature.py:
     maintainers: nerzhul
   $modules/icinga2_host.py:
@@ -749,6 +769,8 @@ files:
     maintainers: obourdon hryamzik
   $modules/ip_netns.py:
     maintainers: bregman-arie
+  $modules/ip2location_info.py:
+    maintainers: ip2location
   $modules/ipa_:
     maintainers: $team_ipa
     ignore: fxfitz
@@ -756,14 +778,14 @@ files:
     maintainers: abakanovskii
   $modules/ipa_dnsrecord.py:
     maintainers: $team_ipa jwbernin
-  $modules/ipbase_info.py:
-    maintainers: dominikkukacka
   $modules/ipa_pwpolicy.py:
     maintainers: adralioh
   $modules/ipa_service.py:
     maintainers: cprh
   $modules/ipa_vault.py:
     maintainers: jparrill
+  $modules/ipbase_info.py:
+    maintainers: dominikkukacka
   $modules/ipify_facts.py:
     maintainers: resmo
   $modules/ipinfoio_facts.py:
@@ -813,6 +835,8 @@ files:
     maintainers: Slezhuk pertoft
   $modules/kdeconfig.py:
     maintainers: smeso
+  $modules/kea_command.py:
+    maintainers: mirabilos
   $modules/kernel_blacklist.py:
     maintainers: matze
   $modules/keycloak_:
@@ -821,16 +845,22 @@ files:
     maintainers: elfelip Gaetan2907
   $modules/keycloak_authentication_required_actions.py:
     maintainers: Skrekulko
+  $modules/keycloak_authentication_v2.py:
+    maintainers: thomasbargetz
   $modules/keycloak_authz_authorization_scope.py:
     maintainers: mattock
-  $modules/keycloak_authz_permission.py:
-    maintainers: mattock
   $modules/keycloak_authz_custom_policy.py:
     maintainers: mattock
+  $modules/keycloak_authz_permission.py:
+    maintainers: mattock
   $modules/keycloak_authz_permission_info.py:
     maintainers: mattock
+  $modules/keycloak_client.py:
+    maintainers: koke1997
   $modules/keycloak_client_rolemapping.py:
     maintainers: Gaetan2907
+  $modules/keycloak_client_rolescope.py:
+    maintainers: desand01
   $modules/keycloak_clientscope.py:
     maintainers: Gaetan2907
   $modules/keycloak_clientscope_type.py:
@@ -841,6 +871,8 @@ files:
     maintainers: fynncfchen johncant
   $modules/keycloak_component.py:
     maintainers: fivetide
+  $modules/keycloak_component_info.py:
+    maintainers: desand01
   $modules/keycloak_group.py:
     maintainers: adamgoossens
   $modules/keycloak_identity_provider.py:
@@ -850,23 +882,23 @@ files:
   $modules/keycloak_realm_info.py:
     maintainers: fynncfchen
   $modules/keycloak_realm_key.py:
-    maintainers: mattock
+    maintainers: mattock koke1997
+  $modules/keycloak_realm_localization.py:
+    maintainers: danekja
+  $modules/keycloak_realm_rolemapping.py:
+    maintainers: agross mhuysamen Gaetan2907
   $modules/keycloak_role.py:
     maintainers: laurpaum
   $modules/keycloak_user.py:
     maintainers: elfelip
+  $modules/keycloak_user_execute_actions_email.py:
+    maintainers: mariusbertram
   $modules/keycloak_user_federation.py:
     maintainers: laurpaum
+  $modules/keycloak_user_rolemapping.py:
+    maintainers: bratwurzt koke1997
   $modules/keycloak_userprofile.py:
     maintainers: yeoldegrove
-  $modules/keycloak_component_info.py:
-    maintainers: desand01
-  $modules/keycloak_client_rolescope.py:
-    maintainers: desand01
-  $modules/keycloak_user_rolemapping.py:
-    maintainers: bratwurzt
-  $modules/keycloak_realm_rolemapping.py:
-    maintainers: agross mhuysamen Gaetan2907
   $modules/keyring.py:
     maintainers: ahussey-redhat
   $modules/keyring_info.py:
@@ -909,6 +941,8 @@ files:
     labels: logentries
   $modules/logentries_msg.py:
     maintainers: jcftang
+  $modules/logrotate.py:
+    maintainers: a-gabidullin
   $modules/logstash_plugin.py:
     maintainers: nerzhul
   $modules/lvg.py:
@@ -931,6 +965,10 @@ files:
     maintainers: conloos
   $modules/lxd_project.py:
     maintainers: we10710aa
+  $modules/lxd_storage_pool_info.py:
+    maintainers: smcavoy
+  $modules/lxd_storage_volume_info.py:
+    maintainers: smcavoy
   $modules/macports.py:
     ignore: ryansb
     keywords: brew cask darwin homebrew macosx macports osx
@@ -1307,8 +1345,11 @@ files:
   $modules/snap_alias.py:
     labels: snap
     maintainers: russoz
+  $modules/snap_connect.py:
+    labels: snap
+    maintainers: russoz
   $modules/snmp_facts.py:
-    maintainers: ogenstad ujwalkomarla
+    maintainers: ogenstad ujwalkomarla lalten
   $modules/solaris_zone.py:
     keywords: beadm dladm illumos ipadm nexenta omnios openindiana pfexec smartos solaris sunos zfs zpool
     labels: solaris
@@ -1325,6 +1366,8 @@ files:
     maintainers: farhan7500 gautamphegde
   $modules/ssh_config.py:
     maintainers: gaqzi Akasurde
+  $modules/sssd_info.py:
+    maintainers: a-gabidullin
   $modules/stacki_host.py:
     labels: stacki_host
     maintainers: bsanders bbyhuy
@@ -1481,22 +1524,24 @@ files:
     ignore: matze
     labels: zypper
     maintainers: $team_suse
-  $plugin_utils/ansible_type.py:
-    maintainers: vbotka
   $modules/zypper_repository_info.py:
     labels: zypper
     maintainers: $team_suse TobiasZeuch181
+  $plugin_utils/ansible_type.py:
+    maintainers: vbotka
   $plugin_utils/keys_filter.py:
     maintainers: vbotka
   $plugin_utils/unsafe.py:
     maintainers: felixfontein
+  $plugin_utils/_tags.py:
+    maintainers: felixfontein
   $tests/a_module.py:
     maintainers: felixfontein
   $tests/ansible_type.py:
     maintainers: vbotka
   $tests/fqdn_valid.py:
     maintainers: vbotka
-#########################
+  #########################
   docs/docsite/rst/filter_guide.rst: {}
   docs/docsite/rst/filter_guide_abstract_informations.rst: {}
   docs/docsite/rst/filter_guide_abstract_informations_counting_elements_in_sequence.rst:
@@ -1535,6 +1580,8 @@ files:
     maintainers: russoz
   docs/docsite/rst/guide_deps.rst:
     maintainers: russoz
+  docs/docsite/rst/guide_ee.rst:
+    maintainers: russoz
   docs/docsite/rst/guide_iocage.rst:
     maintainers: russoz felixfontein
   docs/docsite/rst/guide_iocage_inventory.rst:
@@ -1565,7 +1612,7 @@ files:
     maintainers: russoz
   docs/docsite/rst/test_guide.rst:
     maintainers: felixfontein
-#########################
+  #########################
   tests/:
     labels: tests
   tests/integration:
@@ -1592,7 +1639,7 @@ macros:
   plugin_utils: plugins/plugin_utils
   tests: plugins/test
   team_ansible_core:
-  team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
+  team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
   team_consul: sgargan apollo13 Ilgmi
   team_cyberark_conjur: jvanderhoof ryanprior
@@ -1610,11 +1657,10 @@ macros:
   team_networking: NilashishC Qalthos danielmellado ganeshrn justjais trishnaguha sganesh-infoblox privateip
   team_opennebula: ilicmilan meerkampdvv rsmontero xorel nilsding
   team_oracle: manojmeda mross22 nalsaber
-  team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
   team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06 jyundt
   team_rhsm: cnsnyder ptoscano
   team_scaleway: remyleone abarbare
-  team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
+  team_solaris: bcoca fishman jasperla jpdasma scathatheworm troy2914 xen0l
   team_suse: commel evrardjp lrupp AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab Thulium-Drake Ajpantuso
   team_wdc: mikemoerk

.github/workflows/ansible-test.yml

@@ -29,8 +29,8 @@ jobs:
     strategy:
       matrix:
         ansible:
-          - '2.16'
           - '2.17'
+          - '2.18'
     runs-on: ubuntu-latest
     steps:
       - name: Perform sanity testing
@@ -58,18 +58,18 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          - ansible: '2.16'
-            python: '2.7'
-          - ansible: '2.16'
-            python: '3.6'
-          - ansible: '2.16'
-            python: '3.11'
           - ansible: '2.17'
             python: '3.7'
           - ansible: '2.17'
             python: '3.10'
           - ansible: '2.17'
             python: '3.12'
+          - ansible: '2.18'
+            python: '3.8'
+          - ansible: '2.18'
+            python: '3.11'
+          - ansible: '2.18'
+            python: '3.13'
 
     steps:
       - name: >-
@@ -105,44 +105,6 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          # 2.16
-          # CentOS 7 does not work in GHA, that's why it's not listed here.
-          - ansible: '2.16'
-            docker: fedora38
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.16'
-            docker: fedora38
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.16'
-            docker: fedora38
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.16'
-            docker: opensuse15
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.16'
-            docker: opensuse15
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.16'
-            docker: opensuse15
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.16'
-            docker: alpine3
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.16'
-            docker: alpine3
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.16'
-            docker: alpine3
-            python: ''
-            target: azp/posix/3/
           # 2.17
           - ansible: '2.17'
             docker: fedora39
@@ -156,18 +118,6 @@ jobs:
             docker: fedora39
             python: ''
             target: azp/posix/3/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/3/
           - ansible: '2.17'
             docker: ubuntu2004
             python: ''
@@ -180,6 +130,73 @@ jobs:
             docker: ubuntu2004
             python: ''
             target: azp/posix/3/
+          - ansible: '2.17'
+            docker: alpine319
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.17'
+            docker: alpine319
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.17'
+            docker: alpine319
+            python: ''
+            target: azp/posix/3/
+          # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
+          # - ansible: '2.17'
+          #   docker: default
+          #   python: '3.7'
+          #   target: azp/generic/1/
+          # - ansible: '2.17'
+          #   docker: default
+          #   python: '3.12'
+          #   target: azp/generic/1/
+          # 2.18
+          - ansible: '2.18'
+            docker: fedora40
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.18'
+            docker: fedora40
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.18'
+            docker: fedora40
+            python: ''
+            target: azp/posix/3/
+          - ansible: '2.18'
+            docker: ubuntu2404
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.18'
+            docker: ubuntu2404
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.18'
+            docker: ubuntu2404
+            python: ''
+            target: azp/posix/3/
+          - ansible: '2.18'
+            docker: alpine320
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.18'
+            docker: alpine320
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.18'
+            docker: alpine320
+            python: ''
+            target: azp/posix/3/
+          # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
+          # - ansible: '2.18'
+          #   docker: default
+          #   python: '3.8'
+          #   target: azp/generic/1/
+          # - ansible: '2.18'
+          #   docker: default
+          #   python: '3.13'
+          #   target: azp/generic/1/
 
     steps:
       - name: >-

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+name: nox
+'on':
+  push:
+    branches:
+      - main
+      - stable-*
+    paths:
+      - docs/**
+  pull_request:
+    paths:
+      - docs/**
+  # Run CI once per day (at 08:00 UTC)
+  schedule:
+    - cron: '0 8 * * *'
+  workflow_dispatch:
+
+jobs:
+  nox:
+    runs-on: ubuntu-latest
+    name: "Validate generated Ansible output"
+    steps:
+      - name: Check out collection
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Run nox
+        uses: ansible-community/antsibull-nox@main
+        with:
+          sessions: ansible-output

.mypy.ini

@@ -0,0 +1,242 @@
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[mypy]
+# check_untyped_defs = True
+# disallow_untyped_defs = True
+
+# strict = True -- only try to enable once everything (including dependencies!) is typed
+strict_equality = True
+strict_bytes = True
+
+warn_redundant_casts = True
+# warn_return_any = True
+warn_unreachable = True
+
+exclude = tests/integration/targets/django_.*/files/.*
+
+[mypy-ansible.*]
+# ansible-core has partial typing information
+follow_untyped_imports = True
+
+# The following imports are Python packages that:
+# 1. We do not install (we can't install everything!);
+# 2. That have type stubs, but we don't install them (again, we can't install everything!); or
+# 3. That have no types and type stubs.
+[mypy-aerospike.*]
+ignore_missing_imports = True
+[mypy-antsibull_nox.*]
+ignore_missing_imports = True
+[mypy-asyncore.*]
+ignore_missing_imports = True
+[mypy-boto3.*]
+ignore_missing_imports = True
+[mypy-bs4.*]
+ignore_missing_imports = True
+[mypy-cgi.*]
+ignore_missing_imports = True
+[mypy-chef.*]
+ignore_missing_imports = True
+[mypy-consul.*]
+ignore_missing_imports = True
+[mypy-credstash.*]
+ignore_missing_imports = True
+[mypy-crypt.*]
+ignore_missing_imports = True
+[mypy-daemon.*]
+ignore_missing_imports = True
+[mypy-datadog.*]
+ignore_missing_imports = True
+[mypy-dbus.*]
+ignore_missing_imports = True
+[mypy-delinea.*]
+ignore_missing_imports = True
+[mypy-dnf.*]
+ignore_missing_imports = True
+[mypy-dnsimple.*]
+ignore_missing_imports = True
+[mypy-etcd3.*]
+ignore_missing_imports = True
+[mypy-flatdict.*]
+ignore_missing_imports = True
+[mypy-footmark.*]
+ignore_missing_imports = True
+[mypy-fqdn.*]
+ignore_missing_imports = True
+[mypy-func.*]
+ignore_missing_imports = True
+[mypy-gi.*]
+ignore_missing_imports = True
+[mypy-github3.*]
+ignore_missing_imports = True
+[mypy-gssapi.*]
+ignore_missing_imports = True
+[mypy-hashids.*]
+ignore_missing_imports = True
+[mypy-heroku3.*]
+ignore_missing_imports = True
+[mypy-hpe3parclient.*]
+ignore_missing_imports = True
+[mypy-hpe3par_sdk.*]
+ignore_missing_imports = True
+[mypy-hpilo.*]
+ignore_missing_imports = True
+[mypy-hpOneView.*]
+ignore_missing_imports = True
+[mypy-httmock.*]  # TODO!
+ignore_missing_imports = True
+[mypy-influxdb.*]
+ignore_missing_imports = True
+[mypy-jc.*]
+ignore_missing_imports = True
+[mypy-jenkins.*]
+ignore_missing_imports = True
+[mypy-jmespath.*]
+ignore_missing_imports = True
+[mypy-jsonpatch.*]
+ignore_missing_imports = True
+[mypy-kazoo.*]
+ignore_missing_imports = True
+[mypy-keyring.*]
+ignore_missing_imports = True
+[mypy-keystoneauth1.*]
+ignore_missing_imports = True
+[mypy-layman.*]
+ignore_missing_imports = True
+[mypy-ldap.*]
+ignore_missing_imports = True
+[mypy-legacycrypt.*]
+ignore_missing_imports = True
+[mypy-libcloud.*]
+ignore_missing_imports = True
+[mypy-linode.*]
+ignore_missing_imports = True
+[mypy-linode_api4.*]
+ignore_missing_imports = True
+[mypy-lmdb.*]
+ignore_missing_imports = True
+[mypy-logdna.*]
+ignore_missing_imports = True
+[mypy-logstash.*]
+ignore_missing_imports = True
+[mypy-lxc.*]
+ignore_missing_imports = True
+[mypy-manageiq_client.*]
+ignore_missing_imports = True
+[mypy-matrix_client.*]
+ignore_missing_imports = True
+[mypy-memcache.*]
+ignore_missing_imports = True
+[mypy-nc_dnsapi.*]
+ignore_missing_imports = True
+[mypy-nomad.*]
+ignore_missing_imports = True
+[mypy-nopackagewiththisname.*]
+ignore_missing_imports = True
+[mypy-nox.*]
+ignore_missing_imports = True
+[mypy-oci.*]
+ignore_missing_imports = True
+[mypy-oneandone.*]
+ignore_missing_imports = True
+[mypy-opentelemetry.*]
+ignore_missing_imports = True
+[mypy-ovh.*]
+ignore_missing_imports = True
+[mypy-ovirtsdk.*]
+ignore_missing_imports = True
+[mypy-packet.*]
+ignore_missing_imports = True
+[mypy-paho.*]
+ignore_missing_imports = True
+[mypy-pam.*]
+ignore_missing_imports = True
+[mypy-pdpyras.*]
+ignore_missing_imports = True
+[mypy-petname.*]
+ignore_missing_imports = True
+[mypy-pingdom.*]
+ignore_missing_imports = True
+[mypy-pkg_resources.*]
+ignore_missing_imports = True
+[mypy-portage.*]
+ignore_missing_imports = True
+[mypy-potatoes_that_will_never_be_there.*]
+ignore_missing_imports = True
+[mypy-prettytable.*]
+ignore_missing_imports = True
+[mypy-pubnub_blocks_client.*]
+ignore_missing_imports = True
+[mypy-pushbullet.*]
+ignore_missing_imports = True
+[mypy-pycdlib.*]
+ignore_missing_imports = True
+[mypy-pyghmi.*]
+ignore_missing_imports = True
+[mypy-pylxca.*]
+ignore_missing_imports = True
+[mypy-pymssql.*]
+ignore_missing_imports = True
+[mypy-pyodbc.*]
+ignore_missing_imports = True
+[mypy-pyone.*]
+ignore_missing_imports = True
+[mypy-pypureomapi.*]
+ignore_missing_imports = True
+[mypy-pysnmp.*]
+ignore_missing_imports = True
+[mypy-pyxcli.*]
+ignore_missing_imports = True
+[mypy-rpm.*]
+ignore_missing_imports = True
+[mypy-ruamel.yaml.*]
+ignore_missing_imports = True
+[mypy-salt.*]
+ignore_missing_imports = True
+[mypy-selinux.*]
+ignore_missing_imports = True
+[mypy-semantic_version.*]
+ignore_missing_imports = True
+[mypy-sendgrid.*]
+ignore_missing_imports = True
+[mypy-seobject.*]
+ignore_missing_imports = True
+[mypy-sha.*]
+ignore_missing_imports = True
+[mypy-smtpd.*]
+ignore_missing_imports = True
+[mypy-smtpd_tls.*]
+ignore_missing_imports = True
+[mypy-SoftLayer.*]
+ignore_missing_imports = True
+[mypy-spotinst_sdk.*]
+ignore_missing_imports = True
+[mypy-statsd.*]
+ignore_missing_imports = True
+[mypy-storops.*]
+ignore_missing_imports = True
+[mypy-taiga.*]
+ignore_missing_imports = True
+[mypy-thycotic.*]
+ignore_missing_imports = True
+[mypy-tomlkit.*]
+ignore_missing_imports = True
+[mypy-univention.*]
+ignore_missing_imports = True
+[mypy-vexatapi.*]
+ignore_missing_imports = True
+[mypy-voluptuous.*]
+ignore_missing_imports = True
+[mypy-websocket.*]
+ignore_missing_imports = True
+[mypy-XenAPI.*]
+ignore_missing_imports = True
+[mypy-xkcdpass.*]
+ignore_missing_imports = True
+[mypy-xmljson.*]
+ignore_missing_imports = True
+[mypy-xmltodict.*]
+ignore_missing_imports = True
+[mypy-xmpp.*]
+ignore_missing_imports = True

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Alexei Znamensky <russoz@gmail.com>
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.9
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+      # Run the formatter.
+      - id: ruff-format

CONTRIBUTING.md

@@ -39,7 +39,7 @@ Please read our ['Contributing to collections'](https://docs.ansible.com/project
 * Make sure your PR includes a [changelog fragment](https://docs.ansible.com/projects/ansible/devel/community/collection_development_process.html#creating-a-changelog-fragment).
   * You must not include a fragment for new modules or new plugins. Also you shouldn't include one for docs-only changes. (If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) )
   * Please always include a link to the pull request itself, and if the PR is about an issue, also a link to the issue. Also make sure the fragment ends with a period, and begins with a lower-case letter after `-`. (Again, if you don't do this, we'll add suggestions to fix it, so don't worry too much :) )
-* Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed.
+* Note that we format the code with `ruff format`. If your change does not match the formatters expectations, CI will fail and your PR will not get merged. See below for how to format code with antsibull-nox.
 
 You can also read the Ansible community's [Quick-start development guide](https://docs.ansible.com/projects/ansible/devel/community/create_pr_quick_start.html).
 
@@ -49,11 +49,24 @@ If you want to test a PR locally, refer to [our testing guide](https://docs.ansi
 
 If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.
 
-## Run sanity or unit locally (with antsibull-nox)
+## Format code; and run sanity or unit tests locally (with antsibull-nox)
 
-The easiest way to run sanity and unit tests locally is to use [antsibull-nox](https://docs.ansible.com/projects/antsibull-nox/).
+The easiest way to format the code, and to run sanity and unit tests locally is to use [antsibull-nox](https://docs.ansible.com/projects/antsibull-nox/).
 (If you have [nox](https://nox.thea.codes/en/stable/) installed, it will automatically install antsibull-nox in a virtual environment for you.)
 
+### Format code
+
+The following commands show how to run ruff format:
+
+```.bash
+# Run all configured formatters:
+nox -Re formatters
+
+# If you notice discrepancies between your local formatter and CI, you might
+# need to re-generate the virtual environment:
+nox -e formatters
+```
+
 ### Sanity tests
 
 The following commands show how to run ansible-test sanity tests:
@@ -120,6 +133,7 @@ ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration
 Note that for running unit tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
 Right now, you need to install [`community.internal_test_tools`](https://github.com/ansible-collections/community.internal_test_tools).
 If you want to use the latest version from GitHub, you can run:
+
 ```
 git clone https://github.com/ansible-collections/community.internal_test_tools.git ~/dev/ansible_collections/community/internal_test_tools
 ```
@@ -142,6 +156,7 @@ ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools
 Note that for running integration tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
 Right now, depending on the test, you need to install [`ansible.posix`](https://github.com/ansible-collections/ansible.posix), [`community.crypto`](https://github.com/ansible-collections/community.crypto), and [`community.docker`](https://github.com/ansible-collections/community.docker):
 If you want to use the latest versions from GitHub, you can run:
+
 ```
 mkdir -p ~/dev/ansible_collections/ansible
 git clone https://github.com/ansible-collections/ansible.posix.git ~/dev/ansible_collections/ansible/posix
@@ -154,11 +169,13 @@ The following commands show how to run integration tests:
 #### In Docker
 
 Integration tests on Docker have the following parameters:
+
 - `image_name` (required): The name of the Docker image. To get the list of supported Docker images, run
   `ansible-test integration --help` and look for _target docker images_.
 - `test_name` (optional): The name of the integration test.
   For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.
   For plugins, the plugin type is added before the plugin's short name, for example `callback_yaml` for the `community.general.yaml` callback.
+
 ```.bash
 # Test all plugins/modules on fedora40
 ansible-test integration -v --docker fedora40
@@ -179,6 +196,31 @@ ansible-test integration -v lookup_flattened
 
 If you are unsure about the integration test target name for a module or plugin, you can take a look in `tests/integration/targets/`. Tests for plugins have the plugin type prepended.
 
+## Devcontainer
+
+Since community.general 12.2.0, the project repository supports [devcontainers](https://containers.dev/). In short, it is a standard mechanism to
+create a container that is then used during the development cycle. Many tools are pre-installed in the container and will be already available
+to you as a developer. A number of different IDEs support that configuration, the most prominent ones being VSCode and PyCharm.
+
+See the files under [.devcontainer](.devcontainer) for details on what is deployed inside that container.
+
+Beware of:
+
+- By default, the devcontainer installs the latest version of `ansible-core`.
+  When testing your changes locally, keep in mind that the collection must support older versions of
+  `ansible-core` and, depending on what is being tested, results may vary.
+- Integration tests executed directly inside the devcontainer without isolation (see above) may fail if
+  they expected to be run in full fledged VMs. On the other hand, the devcontainer setup allows running
+  containers inside the container (the `docker-in-docker` feature).
+- The devcontainer is built with a directory structure such that
+  `.../ansible_collections/community/general` contains the project repository, so `ansible-test` and
+  other standard tools should work without any additional setup
+- By default, the devcontainer installs `pre-commit` and configures it to perform `ruff check` and
+  `ruff format` on the Python files, prior to commiting. That configuration is going to be used by
+  `git` even outside the devcontainer. To prevent errors, you have to either install `pre-commit` in
+  your computer, outside the devcontainer, or run `pre-commit uninstall` from within the devcontainer
+  before quitting it.
+
 ## Creating new modules or plugins
 
 Creating new modules and plugins requires a bit more work than other Pull Requests.
@@ -188,7 +230,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
 
 2. Please do not add more than one plugin/module in one PR, especially if it is the first plugin/module you are contributing.
    That makes it easier for reviewers, and increases the chance that your PR will get merged. If you plan to contribute a group
-   of plugins/modules (say, more than a module and a corresponding ``_info`` module), please mention that in the first PR. In
+   of plugins/modules (say, more than a module and a corresponding `_info` module), please mention that in the first PR. In
    such cases, you also have to think whether it is better to publish the group of plugins/modules in a new collection.
 
 3. When creating a new module or plugin, please make sure that you follow various guidelines:

LICENSES/PSF-2.0.txt

@@ -1,48 +0,0 @@
-PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
---------------------------------------------
-
-1. This LICENSE AGREEMENT is between the Python Software Foundation
-("PSF"), and the Individual or Organization ("Licensee") accessing and
-otherwise using this software ("Python") in source or binary form and
-its associated documentation.
-
-2. Subject to the terms and conditions of this License Agreement, PSF hereby
-grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
-analyze, test, perform and/or display publicly, prepare derivative works,
-distribute, and otherwise use Python alone or in any derivative version,
-provided, however, that PSF's License Agreement and PSF's notice of copyright,
-i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
-2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Python Software Foundation;
-All Rights Reserved" are retained in Python alone or in any derivative version
-prepared by Licensee.
-
-3. In the event Licensee prepares a derivative work that is based on
-or incorporates Python or any part thereof, and wants to make
-the derivative work available to others as provided herein, then
-Licensee hereby agrees to include in any such work a brief summary of
-the changes made to Python.
-
-4. PSF is making Python available to Licensee on an "AS IS"
-basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
-IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
-DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
-FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
-INFRINGE ANY THIRD PARTY RIGHTS.
-
-5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
-FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
-A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
-OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
-
-6. This License Agreement will automatically terminate upon a material
-breach of its terms and conditions.
-
-7. Nothing in this License Agreement shall be deemed to create any
-relationship of agency, partnership, or joint venture between PSF and
-Licensee.  This License Agreement does not grant permission to use PSF
-trademarks or trade name in a trademark sense to endorse or promote
-products or services of Licensee, or any third party.
-
-8. By copying, installing or otherwise using Python, Licensee
-agrees to be bound by the terms and conditions of this License
-Agreement.

README.md

@@ -7,9 +7,9 @@ SPDX-License-Identifier: GPL-3.0-or-later
 # Community General Collection
 
 [![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/projects/ansible/devel/collections/community/general/)
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-11)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
-[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-11)](https://github.com/ansible-collections/community.general/actions)
-[![Nox CI](https://github.com/ansible-collections/community.general/actions/workflows/nox.yml/badge.svg?branch=stable-11)](https://github.com/ansible-collections/community.general/actions)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-12)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-12)](https://github.com/ansible-collections/community.general/actions)
+[![Nox CI](https://github.com/ansible-collections/community.general/actions/workflows/nox.yml/badge.svg?branch=stable-12)](https://github.com/ansible-collections/community.general/actions)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-collections/community.general)](https://api.reuse.software/info/github.com/ansible-collections/community.general)
 
@@ -39,7 +39,7 @@ For more information about communication, see the [Ansible communication guide](
 
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.16, ansible-core 2.17, ansible-core 2.18, ansible-core 2.19, ansible-core 2.20 releases and the current development version of ansible-core. Ansible-core versions before 2.16.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
+Tested with the current ansible-core 2.17, ansible-core 2.18, ansible-core 2.19, ansible-core 2.20, ansible-core 2.21 releases and the current development version of ansible-core. Ansible-core versions before 2.17.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
 
 ## External requirements
 
@@ -86,13 +86,13 @@ We are actively accepting new contributors.
 
 All types of contributions are very welcome.
 
-You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md)!
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md)!
 
-The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
 
 You can find more information in the [developer guide for collections](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/projects/ansible/latest/community/index.html).
 
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md).
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md).
 
 ### Running tests
 
@@ -102,8 +102,8 @@ See [here](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_
 
 To learn how to maintain / become a maintainer of this collection, refer to:
 
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
-* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
+* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md).
+* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/stable-12/maintaining.rst).
 
 It is necessary for maintainers of this collection to be subscribed to:
 
@@ -118,7 +118,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-11/CHANGELOG.md).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-12/CHANGELOG.md).
 
 ## Roadmap
 
@@ -137,8 +137,8 @@ See [this issue](https://github.com/ansible-collections/community.general/issues
 
 This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
 
-See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-11/COPYING) for the full text.
+See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-12/COPYING) for the full text.
 
-Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-11/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-11/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/stable-11/LICENSES/PSF-2.0.txt).
+Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-12/LICENSES/BSD-2-Clause.txt) and the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-12/LICENSES/MIT.txt).
 
 All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `REUSE.toml`. This conforms to the [REUSE specification](https://reuse.software/spec/).

antsibull-nox.toml

@@ -20,15 +20,39 @@ stable_branches = [ "stable-*" ]
 [sessions]
 
 [sessions.lint]
+code_files = ["."]  # consider all Python files in the collection
 run_isort = false
 run_black = false
+run_ruff_autofix = true
+ruff_autofix_config = "ruff.toml"
+ruff_autofix_select = [
+    "I",
+    "RUF022",
+]
+run_ruff_check = true
+ruff_check_config = "ruff.toml"
+run_ruff_format = true
+ruff_format_config = "ruff.toml"
 run_flake8 = false
 run_pylint = false
 run_yamllint = true
 yamllint_config = ".yamllint"
 # yamllint_config_plugins = ".yamllint-docs"
 # yamllint_config_plugins_examples = ".yamllint-examples"
-run_mypy = false
+run_mypy = true
+mypy_ansible_core_package = "ansible-core>=2.19.0"
+mypy_config = ".mypy.ini"
+mypy_extra_deps = [
+    "cryptography",
+    "dnspython",
+    "lxml-stubs",
+    "types-mock",
+    "types-paramiko",
+    "types-passlib",
+    "types-psutil",
+    "types-PyYAML",
+    "types-requests",
+]
 
 [sessions.docs_check]
 validate_collection_refs="all"

changelogs/fragments/11361-scaleway-get-resources-none-type.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - scaleway_image_info, scaleway_ip_info, scaleway_organization_info, scaleway_security_group_info, scaleway_server_info, scaleway_snapshot_info, scaleway_volume_info - fix ``NoneType`` error when the Scaleway API returns an empty or non-JSON response body (https://github.com/ansible-collections/community.general/issues/11361, https://github.com/ansible-collections/community.general/pull/11918).

changelogs/fragments/11909-fix-favicon-url.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - "mattermost, rocketchat, slack - update default ``icon_url`` to ansible favicon (https://github.com/ansible-collections/community.general/pull/11909)."

changelogs/fragments/11926-crypttab-fix-opts-equal-sign.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - crypttab - fix parsing of options whose value contains an equal sign (https://github.com/ansible-collections/community.general/issues/4963, https://github.com/ansible-collections/community.general/pull/11926).

changelogs/fragments/12.6.1.yml

@@ -0,0 +1 @@
+release_summary: Regular bugfix release.

docs/docsite/config.yml

@@ -5,3 +5,13 @@
 
 changelog:
   write_changelog: true
+
+ansible_output:
+  global_env:
+    ANSIBLE_STDOUT_CALLBACK: community.general.tasks_only
+    ANSIBLE_COLLECTIONS_TASKS_ONLY_NUMBER_OF_COLUMNS: 90
+  global_postprocessors:
+    reformat-yaml:
+      command:
+        - python
+        - docs/docsite/reformat-yaml.py

docs/docsite/extra-docs.yml

@@ -8,6 +8,9 @@ sections:
     toctree:
       - filter_guide
       - test_guide
+  - title: Deployment Guides
+    toctree:
+      - guide_ee
   - title: Technology Guides
     toctree:
       - guide_alicloud

docs/docsite/reformat-yaml.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import sys
+from io import StringIO
+
+from ruamel.yaml import YAML  # type: ignore[import-not-found]
+
+
+def main() -> None:
+    yaml = YAML(typ="rt")
+    yaml.indent(mapping=2, sequence=4, offset=2)
+
+    # Load
+    data = yaml.load(sys.stdin)
+
+    # Dump
+    sio = StringIO()
+    yaml.dump(data, sio)
+    print(sio.getvalue().rstrip("\n"))
+
+
+if __name__ == "__main__":
+    main()

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

@@ -13,6 +13,34 @@ Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a lis
 
 Let us use the below list in the following examples:
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+    - name: set-template
+      template:
+        env:
+          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
+        variables:
+          data:
+            previous_code_block: yaml
+            previous_code_block_index: 0
+          computation:
+            previous_code_block: yaml+jinja
+        postprocessors:
+          - name: reformat-yaml
+        language: yaml
+        skip_first_lines: 2
+        playbook: |-
+          - hosts: localhost
+            gather_facts: false
+            tasks:
+              - vars:
+                  @{{ data | indent(8) }}@
+                  @{{ computation | indent(8) }}@
+                ansible.builtin.debug:
+                  var: result
+
 .. code-block:: yaml
 
    input:
@@ -37,24 +65,48 @@ Let us use the below list in the following examples:
 
 gives
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - {k0_x0: A0, k1_x1: B0}
-     - {k0_x0: A1, k1_x1: B1}
+     - k0_x0: A0
+       k1_x1: B0
+     - k0_x0: A1
+       k1_x1: B1
 
 
 .. versionadded:: 9.1.0
 
 * The results of the below examples 1-5 are all the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: equal
+              target: ['k0_x0', 'k1_x1']
+              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - {k0_x0: A0, k1_x1: B0}
-     - {k0_x0: A1, k1_x1: B1}
+     - k0_x0: A0
+       k1_x1: B0
+     - k0_x0: A1
+       k1_x1: B1
 
 
 1. Match keys that equal any of the items in the target.
@@ -105,12 +157,28 @@ gives
 
 * The results of the below examples 6-9 are all the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: equal
+              target: k0_x0
+              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - {k0_x0: A0}
-     - {k0_x0: A1}
+     - k0_x0: A0
+     - k0_x0: A1
 
 
 6. Match keys that equal the target.
@@ -148,4 +216,3 @@ gives
    mp: regex
    target: ^.*0_x.*$
    result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst

@@ -13,6 +13,34 @@ Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a l
 
 Let us use the below list in the following examples:
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+    - name: set-template
+      template:
+        env:
+          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
+        variables:
+          data:
+            previous_code_block: yaml
+            previous_code_block_index: 0
+          computation:
+            previous_code_block: yaml+jinja
+        postprocessors:
+          - name: reformat-yaml
+        language: yaml
+        skip_first_lines: 2
+        playbook: |-
+          - hosts: localhost
+            gather_facts: false
+            tasks:
+              - vars:
+                  @{{ data | indent(8) }}@
+                  @{{ computation | indent(8) }}@
+                ansible.builtin.debug:
+                  var: result
+
 .. code-block:: yaml
 
    input:
@@ -37,13 +65,19 @@ Let us use the below list in the following examples:
 
 gives
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k2_x2: [C0]
+     - k2_x2:
+         - C0
        k3_x3: foo
-     - k2_x2: [C1]
+     - k2_x2:
+         - C1
        k3_x3: bar
 
 
@@ -51,13 +85,31 @@ gives
 
 * The results of the below examples 1-5 are all the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: equal
+              target: ['k0_x0', 'k1_x1']
+              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k2_x2: [C0]
+     - k2_x2:
+         - C0
        k3_x3: foo
-     - k2_x2: [C1]
+     - k2_x2:
+         - C1
        k3_x3: bar
 
 
@@ -109,15 +161,33 @@ gives
 
 * The results of the below examples 6-9 are all the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: equal
+              target: k0_x0
+              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - k1_x1: B0
-       k2_x2: [C0]
+       k2_x2:
+         - C0
        k3_x3: foo
      - k1_x1: B1
-       k2_x2: [C1]
+       k2_x2:
+         - C1
        k3_x3: bar
 
 
@@ -156,4 +226,3 @@ gives
    mp: regex
    target: ^.*0_x.*$
    result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst

@@ -13,6 +13,34 @@ Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a
 
 Let us use the below list in the following examples:
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+    - name: set-template
+      template:
+        env:
+          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
+        variables:
+          data:
+            previous_code_block: yaml
+            previous_code_block_index: 0
+          computation:
+            previous_code_block: yaml+jinja
+        postprocessors:
+          - name: reformat-yaml
+        language: yaml
+        skip_first_lines: 2
+        playbook: |-
+          - hosts: localhost
+            gather_facts: false
+            tasks:
+              - vars:
+                  @{{ data | indent(8) }}@
+                  @{{ computation | indent(8) }}@
+                ansible.builtin.debug:
+                  var: result
+
 .. code-block:: yaml
 
    input:
@@ -40,17 +68,23 @@ Let us use the below list in the following examples:
 
 gives
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - a0: A0
        a1: B0
-       k2_x2: [C0]
+       k2_x2:
+         - C0
        k3_x3: foo
      - a0: A1
        a1: B1
-       k2_x2: [C1]
+       k2_x2:
+         - C1
        k3_x3: bar
 
 
@@ -58,17 +92,37 @@ gives
 
 * The results of the below examples 1-3 are all the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: starts_with
+              target:
+                - {after: a0, before: k0}
+                - {after: a1, before: k1}
+              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - a0: A0
        a1: B0
-       k2_x2: [C0]
+       k2_x2:
+         - C0
        k3_x3: foo
      - a0: A1
        a1: B1
-       k2_x2: [C1]
+       k2_x2:
+         - C1
        k3_x3: bar
 
 
@@ -111,12 +165,29 @@ gives
 
 * The results of the below examples 4-5 are the same:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - vars:
+              @{{ data | indent(8) }}@
+
+              # I picked one of the examples
+              mp: regex
+              target:
+                - {after: X, before: ^.*_x.*$}
+              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
+            ansible.builtin.debug:
+              var: result
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - {X: foo}
-     - {X: bar}
+     - X: foo
+     - X: bar
 
 
 4. If more keys match the same attribute before the last one will be used.
@@ -145,6 +216,11 @@ gives
 
 6. If there are more matches for a key the first one will be used.
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
@@ -165,11 +241,17 @@ gives
 
 gives
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - {X: A, bbb1: B, ccc1: C}
-     - {X: D, bbb2: E, ccc2: F}
-
-
+     - X: A
+       bbb1: B
+       ccc1: C
+     - X: D
+       bbb2: E
+       ccc2: F

docs/docsite/rst/filter_guide_abstract_informations_counting_elements_in_sequence.rst

@@ -20,6 +20,17 @@ The :ansplugin:`community.general.counter filter plugin <community.general.count
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Count character occurrences in a string] ********************************************
@@ -72,9 +83,20 @@ This plugin is useful for selecting resources based on current allocation:
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
-    TASK [Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks]
+    TASK [Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks] ***
     ok: [localhost] => {
         "msg": "scsi_2"
     }

docs/docsite/rst/filter_guide_abstract_informations_dictionaries.rst

@@ -31,16 +31,27 @@ You can use the :ansplugin:`community.general.dict_kv filter <community.general.
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
-    TASK [Create a single-entry dictionary]  **************************************************
+    TASK [Create a single-entry dictionary] ***************************************************
     ok: [localhost] => {
         "msg": {
             "thatsmyvar": "myvalue"
         }
     }
 
-    TASK [Create a list of dictionaries where the 'server' field is taken from a list]  *******
+    TASK [Create a list of dictionaries where the 'server' field is taken from a list] ********
     ok: [localhost] => {
         "msg": [
             {
@@ -87,9 +98,20 @@ If you need to convert a list of key-value pairs to a dictionary, you can use th
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
-    TASK [Create a dictionary with the dict function]  ****************************************
+    TASK [Create a dictionary with the dict function] *****************************************
     ok: [localhost] => {
         "msg": {
             "1": 2,
@@ -97,7 +119,7 @@ This produces:
         }
     }
 
-    TASK [Create a dictionary with the community.general.dict filter]  ************************
+    TASK [Create a dictionary with the community.general.dict filter] *************************
     ok: [localhost] => {
         "msg": {
             "1": 2,
@@ -105,7 +127,7 @@ This produces:
         }
     }
 
-    TASK [Create a list of dictionaries with map and the community.general.dict filter]  ******
+    TASK [Create a list of dictionaries with map and the community.general.dict filter] *******
     ok: [localhost] => {
         "msg": [
             {

docs/docsite/rst/filter_guide_abstract_informations_grouping.rst

@@ -22,6 +22,49 @@ One example is ``ansible_facts.mounts``, which is a list of dictionaries where e
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    skip_first_lines: 3  # the set_fact task
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - ansible.builtin.set_fact:
+              ansible_facts:
+                mounts:
+                  - block_available: 2000
+                    block_size: 4096
+                    block_total: 2345
+                    block_used: 345
+                    device: "/dev/sda1"
+                    fstype: "ext4"
+                    inode_available: 500
+                    inode_total: 512
+                    inode_used: 12
+                    mount: "/boot"
+                    options: "rw,relatime,data=ordered"
+                    size_available: 56821
+                    size_total: 543210
+                    uuid: "ab31cade-d9c1-484d-8482-8a4cbee5241a"
+                  - block_available: 1234
+                    block_size: 4096
+                    block_total: 12345
+                    block_used: 11111
+                    device: "/dev/sda2"
+                    fstype: "ext4"
+                    inode_available: 1111
+                    inode_total: 1234
+                    inode_used: 123
+                    mount: "/"
+                    options: "rw,relatime"
+                    size_available: 42143
+                    size_total: 543210
+                    uuid: "abcdef01-2345-6789-0abc-def012345678"
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Output mount facts grouped by device name] ******************************************
@@ -79,7 +122,7 @@ This produces:
                 "options": "rw,relatime",
                 "size_available": 42143,
                 "size_total": 543210,
-                "uuid": "bdf50b7d-4859-40af-8665-c637ee7a7808"
+                "uuid": "abcdef01-2345-6789-0abc-def012345678"
             },
             "/boot": {
                 "block_available": 2000,

docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst

@@ -21,6 +21,34 @@ These filters preserve the item order, eliminate duplicates and are an extended
 
 Let us use the lists below in the following examples:
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+    - name: set-template
+      template:
+        env:
+          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
+        variables:
+          data:
+            previous_code_block: yaml
+            previous_code_block_index: 0
+          computation:
+            previous_code_block: yaml+jinja
+        postprocessors:
+          - name: reformat-yaml
+        language: yaml
+        skip_first_lines: 2
+        playbook: |-
+          - hosts: localhost
+            gather_facts: false
+            tasks:
+              - vars:
+                  @{{ data | indent(8) }}@
+                  @{{ computation | indent(8) }}@
+                ansible.builtin.debug:
+                  var: result
+
 .. code-block:: yaml
 
   A: [9, 5, 7, 1, 9, 4, 10, 5, 9, 7]
@@ -35,9 +63,22 @@ The union of ``A`` and ``B`` can be written as:
 
 This statement produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
-  result: [9, 5, 7, 1, 4, 10, 2, 8, 3]
+  result:
+    - 9
+    - 5
+    - 7
+    - 1
+    - 4
+    - 10
+    - 2
+    - 8
+    - 3
 
 If you want to calculate the intersection of ``A``, ``B`` and ``C``, you can use the following statement:
 
@@ -59,9 +100,14 @@ or
 
 All three statements are equivalent and give:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
-  result: [1]
+  result:
+    - 1
 
 .. note:: Be aware that in most cases, filter calls without any argument require ``flatten=true``, otherwise the input is returned as result. The reason for this is, that the input is considered as a variable argument and is wrapped by an additional outer list. ``flatten=true`` ensures that this list is removed before the input is processed by the filter logic.
 
@@ -75,7 +121,14 @@ For example, the symmetric difference of ``A``, ``B`` and ``C`` may be written a
 
 This gives:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
-  result: [5, 8, 3, 1]
-
+  result:
+    - 5
+    - 8
+    - 3
+    - 1

docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst

@@ -12,6 +12,34 @@ If you have two or more lists of dictionaries and want to combine them into a li
 
 Let us use the lists below in the following examples:
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+    - name: set-template
+      template:
+        env:
+          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
+        variables:
+          data:
+            previous_code_block: yaml
+            previous_code_block_index: 0
+          computation:
+            previous_code_block: yaml+jinja
+        postprocessors:
+          - name: reformat-yaml
+        language: yaml
+        skip_first_lines: 2
+        playbook: |-
+          - hosts: localhost
+            gather_facts: false
+            tasks:
+              - vars:
+                  @{{ data | indent(8) }}@
+                  @{{ computation | indent(8) }}@
+                ansible.builtin.debug:
+                  var: list3
+
 .. code-block:: yaml
 
   list1:
@@ -34,13 +62,22 @@ In the example below the lists are merged by the attribute ``name``:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
-    - {name: bar, extra: false}
-    - {name: baz, path: /baz}
-    - {name: foo, extra: true, path: /foo}
-    - {name: meh, extra: true}
+    - extra: false
+      name: bar
+    - name: baz
+      path: /baz
+    - extra: true
+      name: foo
+      path: /foo
+    - extra: true
+      name: meh
 
 
 .. versionadded:: 2.0.0
@@ -56,13 +93,22 @@ It is possible to use a list of lists as an input of the filter:
 
 This produces the same result as in the previous example:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
-    - {name: bar, extra: false}
-    - {name: baz, path: /baz}
-    - {name: foo, extra: true, path: /foo}
-    - {name: meh, extra: true}
+    - extra: false
+      name: bar
+    - name: baz
+      path: /baz
+    - extra: true
+      name: foo
+      path: /foo
+    - extra: true
+      name: meh
 
 Single list
 """""""""""
@@ -75,13 +121,22 @@ It is possible to merge single list:
 
 This produces the same result as in the previous example:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
-    - {name: bar, extra: false}
-    - {name: baz, path: /baz}
-    - {name: foo, extra: true, path: /foo}
-    - {name: meh, extra: true}
+    - extra: false
+      name: bar
+    - name: baz
+      path: /baz
+    - extra: true
+      name: foo
+      path: /foo
+    - extra: true
+      name: meh
 
 
 The filter also accepts two optional parameters: :ansopt:`community.general.lists_mergeby#filter:recursive` and :ansopt:`community.general.lists_mergeby#filter:list_merge`. This is available since community.general 4.4.0.
@@ -96,6 +151,11 @@ The examples below set :ansopt:`community.general.lists_mergeby#filter:recursive
 
 Let us use the lists below in the following examples
 
+.. ansible-output-meta::
+
+  actions:
+    - name: reset-previous-blocks
+
 .. code-block:: yaml
 
   list1:
@@ -128,17 +188,25 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=replace` (def
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - patch_value
         x: default_value
         y: patch_value
-        list: [patch_value]
         z: patch_value
     - name: myname02
-      param01: [3, 4, 4]
+      param01:
+        - 3
+        - 4
+        - 4
 
 list_merge=keep
 """""""""""""""
@@ -153,17 +221,26 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=keep`:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - default_value
         x: default_value
         y: patch_value
-        list: [default_value]
         z: patch_value
     - name: myname02
-      param01: [1, 1, 2, 3]
+      param01:
+        - 1
+        - 1
+        - 2
+        - 3
 
 list_merge=append
 """""""""""""""""
@@ -178,17 +255,30 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append`:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - default_value
+          - patch_value
         x: default_value
         y: patch_value
-        list: [default_value, patch_value]
         z: patch_value
     - name: myname02
-      param01: [1, 1, 2, 3, 3, 4, 4]
+      param01:
+        - 1
+        - 1
+        - 2
+        - 3
+        - 3
+        - 4
+        - 4
 
 list_merge=prepend
 """"""""""""""""""
@@ -203,17 +293,30 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend`:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - patch_value
+          - default_value
         x: default_value
         y: patch_value
-        list: [patch_value, default_value]
         z: patch_value
     - name: myname02
-      param01: [3, 4, 4, 1, 1, 2, 3]
+      param01:
+        - 3
+        - 4
+        - 4
+        - 1
+        - 1
+        - 2
+        - 3
 
 list_merge=append_rp
 """"""""""""""""""""
@@ -228,17 +331,29 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append_rp`:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - default_value
+          - patch_value
         x: default_value
         y: patch_value
-        list: [default_value, patch_value]
         z: patch_value
     - name: myname02
-      param01: [1, 1, 2, 3, 4, 4]
+      param01:
+        - 1
+        - 1
+        - 2
+        - 3
+        - 4
+        - 4
 
 list_merge=prepend_rp
 """""""""""""""""""""
@@ -253,15 +368,26 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend_rp`:
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: ~
+
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
+        list:
+          - patch_value
+          - default_value
         x: default_value
         y: patch_value
-        list: [patch_value, default_value]
         z: patch_value
     - name: myname02
-      param01: [3, 4, 4, 1, 1, 2]
-
+      param01:
+        - 3
+        - 4
+        - 4
+        - 1
+        - 1
+        - 2

docs/docsite/rst/filter_guide_conversions.rst

@@ -24,6 +24,17 @@ Ansible offers the :ansplugin:`community.general.read_csv module <community.gene
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Parse CSV from string] **************************************************************
@@ -69,6 +80,34 @@ Converting to JSON
 
 This produces:
 
+.. ansible-output-data::
+
+    skip_first_lines: 3
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - ansible.builtin.set_fact:
+              result_stdout: |-
+                bin
+                boot
+                dev
+                etc
+                home
+                lib
+                proc
+                root
+                run
+                tmp
+
+          - name: Run 'ls' to list files in /
+            command: ls /
+            register: result
+
+          - name: Parse the ls output
+            debug:
+              msg: "{{ result_stdout | community.general.jc('ls') }}"
+
 .. code-block:: ansible-output
 
     TASK [Run 'ls' to list files in /] ********************************************************

docs/docsite/rst/filter_guide_creating_identifiers.rst

@@ -25,6 +25,17 @@ Hashids
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Create hashid] **********************************************************************
@@ -66,16 +77,32 @@ You can use the :ansplugin:`community.general.random_mac filter <community.gener
 
 This produces:
 
+.. ansible-output-data::
+
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          - name: "Create a random MAC starting with ff:"
+            debug:
+              # We're using a seed here to avoid randomness in the output
+              msg: "{{ 'FF' | community.general.random_mac(seed='') }}"
+
+          - name: "Create a random MAC starting with 00:11:22:"
+            debug:
+              # We're using a seed here to avoid randomness in the output
+              msg: "{{ '00:11:22' | community.general.random_mac(seed='') }}"
+
 .. code-block:: ansible-output
 
     TASK [Create a random MAC starting with ff:] **********************************************
     ok: [localhost] => {
-        "msg": "ff:69:d3:78:7f:b4"
+        "msg": "ff:84:f5:d1:59:20"
     }
 
     TASK [Create a random MAC starting with 00:11:22:] ****************************************
     ok: [localhost] => {
-        "msg": "00:11:22:71:5d:3b"
+        "msg": "00:11:22:84:f5:d1"
     }
 
 You can also initialize the random number generator from a seed to create random-but-idempotent MAC addresses:

docs/docsite/rst/filter_guide_working_with_times.rst

@@ -69,21 +69,32 @@ Note that months and years are using a simplified representation: a month is 30
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Convert string to seconds] **********************************************************
     ok: [localhost] => {
-        "msg": "109210.123"
+        "msg": 109210.123
     }
 
     TASK [Convert string to hours] ************************************************************
     ok: [localhost] => {
-        "msg": "30.336145277778"
+        "msg": 30.336145277778
     }
 
     TASK [Convert string to years (using 365.25 days == 1 year)] ******************************
     ok: [localhost] => {
-        "msg": "1.096851471595"
+        "msg": 1.096851471595
     }
 
 .. versionadded: 0.2.0

docs/docsite/rst/filter_guide_working_with_unicode.rst

@@ -21,9 +21,20 @@ You can use the :ansplugin:`community.general.unicode_normalize filter <communit
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
-    TASK [Compare Unicode representations] ********************************************************
+    TASK [Compare Unicode representations] ****************************************************
     ok: [localhost] => {
         "msg": true
     }

docs/docsite/rst/filter_guide_working_with_versions.rst

@@ -23,6 +23,17 @@ If you need to sort a list of version numbers, the Jinja ``sort`` filter is prob
 
 This produces:
 
+.. ansible-output-data::
+
+    variables:
+      task:
+        previous_code_block: yaml+jinja
+    playbook: |-
+      - hosts: localhost
+        gather_facts: false
+        tasks:
+          @{{ task | indent(4) }}@
+
 .. code-block:: ansible-output
 
     TASK [Sort list by version number] ********************************************************

docs/docsite/rst/guide_ee.rst

@@ -0,0 +1,114 @@
+..
+  Copyright (c) Ansible Project
+  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+.. _ansible_collections.community.general.docsite.guide_ee:
+
+Execution Environment Guide
+===========================
+
+`Ansible Execution Environments <https://docs.ansible.com/projects/ansible/latest/getting_started_ee/index.html>`_
+(EEs) are container images that bundle ansible-core, collections, and their Python and system dependencies.
+They are the standard runtime for Red Hat Ansible Automation Platform and AWX, replacing the older virtualenv model.
+They can also be used outside of RHAAP and AWX by using `ansible-navigator <https://docs.ansible.com/projects/navigator/>`__, or by using ansible-runner directly.
+
+What runs in the EE
+^^^^^^^^^^^^^^^^^^^
+
+Only **controller-side plugins** run inside the EE. Their Python and system dependencies must be installed there.
+This includes: lookup plugins, inventory plugins, callback plugins, connection plugins, become plugins, and filter plugins.
+
+Modules run on the managed nodes and are transferred there at runtime — their dependencies must be present on the
+target, not in the EE.
+
+.. note::
+
+    Modules delegated to ``localhost`` (for example, those that interact with a remote API) are an exception:
+    they run on the controller and their dependencies must therefore be available in the EE.
+
+Why community.general does not provide EE metadata
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``community.general`` ships dozens of controller-side plugins covering a very broad range of technologies.
+Bundling the dependencies for all of them into a single EE image would almost certainly create irreconcilable
+conflicts — both within the collection and with other collections or tools (such as ``ansible-lint``) that
+share the same image.
+
+For that reason, ``community.general`` does **not** provide Python or system package dependency metadata.
+Users are expected to build purpose-built, minimal EEs containing only the dependencies
+required by the specific plugins they actually use.
+
+Finding the dependencies you need
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Every plugin that has external dependencies documents them in its ``requirements`` field.
+You can inspect those with ``ansible-doc``:
+
+.. code-block:: shell
+
+    $ ansible-doc -t lookup community.general.some_lookup | grep -A 10 "REQUIREMENTS"
+
+Or browse the plugin's documentation page on `docs.ansible.com <https://docs.ansible.com/ansible/latest/collections/community/general/>`_.
+
+For example, a lookup plugin that wraps an external service might list:
+
+.. code-block:: yaml
+
+    requirements:
+      - some-python-library >= 1.2
+
+An inventory plugin backed by a REST API might list:
+
+.. code-block:: yaml
+
+    requirements:
+      - requests
+      - some-sdk
+
+These are the packages you need to add to your EE.
+
+Building a minimal EE with ansible-builder
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`ansible-builder <https://docs.ansible.com/projects/builder/en/latest/>`_ is the standard tool for creating EEs.
+
+Install it with:
+
+.. code-block:: shell
+
+    $ pip install ansible-builder
+
+Create an ``execution-environment.yml`` **in your own project** — not inside ``community.general`` —
+that includes only the dependencies needed for the plugins you use:
+
+.. code-block:: yaml
+
+    version: 3
+
+    dependencies:
+      galaxy:
+        collections:
+          - name: community.general
+      python:
+        - some-python-library>=1.2
+        - requests
+      system:
+        - libxml2-devel [platform:rpm]
+
+    images:
+      base_image:
+        name: ghcr.io/ansible/community-ee-base:latest
+
+Then build the image:
+
+.. code-block:: shell
+
+    $ ansible-builder build -t my-custom-ee:latest
+
+.. seealso::
+
+    - `ansible-builder documentation <https://docs.ansible.com/projects/builder/en/latest/>`_
+    - `Building EEs with ansible-builder <https://ansible-builder.readthedocs.io/en/latest/definition/>`_
+    - `Issue #2968 — original request for EE requirements support <https://github.com/ansible-collections/community.general/issues/2968>`_
+    - `Issue #4512 — design discussion for EE support in community.general <https://github.com/ansible-collections/community.general/issues/4512>`_

docs/docsite/rst/guide_iocage_inventory.rst

@@ -12,7 +12,7 @@ The inventory plugin :ansplugin:`community.general.iocage#inventory` gets the in
 
 See:
 
-* `iocage - A FreeBSD Jail Manager <https://iocage.readthedocs.io/en/latest>`_
+* `iocage - A FreeBSD Jail Manager <https://freebsd.github.io/iocage/>`_
 * `man iocage <https://man.freebsd.org/cgi/man.cgi?query=iocage>`_
 * `Jails and Containers <https://docs.freebsd.org/en/books/handbook/jails>`_
 

docs/docsite/rst/guide_iocage_inventory_basics.rst

@@ -20,7 +20,7 @@ As root at the iocage host, create three VNET jails with a DHCP interface from t
    shell> iocage create --template ansible_client --name srv_3 bpf=1 dhcp=1 vnet=1
    srv_3 successfully created!
 
-See: `Configuring a VNET Jail <https://iocage.readthedocs.io/en/latest/networking.html#configuring-a-vnet-jail>`_.
+See: `Configuring VNET <https://freebsd.github.io/iocage/networking.html#vimage-vnet>`_.
 
 As admin at the controller, list the jails:
 
@@ -115,7 +115,7 @@ Optionally, create shared IP jails:
    | None | srv_3 | off  | down  | jail | 14.2-RELEASE-p3 | em0|10.1.0.103/24 | -   | ansible_client | no       |
    +------+-------+------+-------+------+-----------------+-------------------+-----+----------------+----------+
 
-See: `Configuring a Shared IP Jail <https://iocage.readthedocs.io/en/latest/networking.html#configuring-a-shared-ip-jail>`_
+See: `Configuring a Shared IP Jail <https://freebsd.github.io/iocage/networking.html#shared-ip>`_
 
 If iocage needs environment variable(s), use the option :ansopt:`community.general.iocage#inventory:env`. For example,
 

galaxy.yml

@@ -5,7 +5,7 @@
 
 namespace: community
 name: general
-version: 11.4.4
+version: 12.6.1
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)
@@ -19,3 +19,5 @@ repository: https://github.com/ansible-collections/community.general
 documentation: https://docs.ansible.com/projects/ansible/latest/collections/community/general/
 homepage: https://github.com/ansible-collections/community.general
 issues: https://github.com/ansible-collections/community.general/issues
+build_ignore:
+  - .nox

meta/runtime.yml

@@ -3,7 +3,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-requires_ansible: '>=2.16.0'
+requires_ansible: '>=2.17.0'
 action_groups:
   consul:
     - consul_agent_check
@@ -21,6 +21,7 @@ action_groups:
   keycloak:
     - keycloak_authentication
     - keycloak_authentication_required_actions
+    - keycloak_authentication_v2
     - keycloak_authz_authorization_scope
     - keycloak_authz_custom_policy
     - keycloak_authz_permission
@@ -40,12 +41,14 @@ action_groups:
     - keycloak_realm
     - keycloak_realm_key
     - keycloak_realm_keys_metadata_info
+    - keycloak_realm_localization
     - keycloak_realm_rolemapping
     - keycloak_role
     - keycloak_user
     - keycloak_user_federation
     - keycloak_user_rolemapping
     - keycloak_userprofile
+    - keycloak_user_execute_actions_email
   scaleway:
     - scaleway_compute
     - scaleway_compute_private_network
@@ -100,7 +103,7 @@ plugin_routing:
         warning_text: Use the 'default' callback plugin with 'display_failed_stderr
           = yes' option.
     yaml:
-      deprecation:
+      tombstone:
         removal_version: 12.0.0
         warning_text: >-
           The plugin has been superseded by the option `result_format=yaml` in callback plugin ansible.builtin.default from ansible-core 2.13 onwards.
@@ -153,7 +156,7 @@ plugin_routing:
         removal_version: 13.0.0
         warning_text: Project Atomic was sunset by the end of 2019.
     bearychat:
-      deprecation:
+      tombstone:
         removal_version: 12.0.0
         warning_text: Chat service is no longer available.
     catapult:
@@ -202,6 +205,14 @@ plugin_routing:
       tombstone:
         removal_version: 10.0.0
         warning_text: Use community.general.consul_token and/or community.general.consul_policy instead.
+    dimensiondata_network:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Service and its endpoints are no longer available.
+    dimensiondata_vlan:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Service and its endpoints are no longer available.
     docker_compose:
       redirect: community.docker.docker_compose
     docker_config:
@@ -257,7 +268,7 @@ plugin_routing:
     docker_volume_info:
       redirect: community.docker.docker_volume_info
     facter:
-      deprecation:
+      tombstone:
         removal_version: 12.0.0
         warning_text: Use community.general.facter_facts instead.
     flowdock:
@@ -361,6 +372,26 @@ plugin_routing:
       tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.hpilo_info instead.
+    aix_devices:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: Use ibm.power_aix.devices instead. The C(ibm.power_aix) collection is actively maintained by IBM.
+    aix_filesystem:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: Use ibm.power_aix.filesystem instead. The C(ibm.power_aix) collection is actively maintained by IBM.
+    aix_inittab:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: Use ibm.power_aix.inittab instead. The C(ibm.power_aix) collection is actively maintained by IBM.
+    aix_lvg:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: Use ibm.power_aix.lvg instead. The C(ibm.power_aix) collection is actively maintained by IBM.
+    aix_lvol:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: Use ibm.power_aix.lvol instead. The C(ibm.power_aix) collection is actively maintained by IBM.
     idrac_firmware:
       redirect: dellemc.openmanage.idrac_firmware
     idrac_redfish_facts:
@@ -369,6 +400,10 @@ plugin_routing:
         warning_text: Use community.general.idrac_redfish_info instead.
     idrac_server_config_profile:
       redirect: dellemc.openmanage.idrac_server_config_profile
+    jboss:
+      deprecation:
+        removal_version: 14.0.0
+        warning_text: Use role middleware_automation.wildfly.wildfly_app_deploy instead.
     jenkins_job_facts:
       tombstone:
         removal_version: 3.0.0
@@ -389,6 +424,10 @@ plugin_routing:
       redirect: community.kubevirt.kubevirt_template
     kubevirt_vm:
       redirect: community.kubevirt.kubevirt_vm
+    layman:
+      deprecation:
+        removal_version: 14.0.0
+        warning_text: Gentoo deprecated C(layman) in mid-2023.
     ldap_attr:
       tombstone:
         removal_version: 3.0.0
@@ -493,6 +532,30 @@ plugin_routing:
       tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.one_image_info instead.
+    oneandone_firewall_policy:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
+    oneandone_load_balancer:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
+    oneandone_monitoring_policy:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
+    oneandone_private_network:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
+    oneandone_public_ip:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
+    oneandone_server:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
     onepassword_facts:
       tombstone:
         removal_version: 3.0.0
@@ -800,6 +863,10 @@ plugin_routing:
       tombstone:
         removal_version: 3.0.0
         warning_text: Use purestorage.flashblade.purefb_info instead.
+    pushbullet:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Module relies on Python package pushbullet.py which is not maintained and supports only up to Python 3.2.
     python_requirements_facts:
       tombstone:
         removal_version: 3.0.0
@@ -996,12 +1063,24 @@ plugin_routing:
       tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.smartos_image_info instead.
+    spotinst_aws_elastigroup:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Module relies on unsupported Python package. Use the module spot.cloud_modules.aws_elastigroup instead.
     stackdriver:
       tombstone:
         removal_version: 9.0.0
         warning_text: This module relied on HTTPS APIs that do not exist anymore,
           and any new development in the direction of providing an alternative should
           happen in the context of the google.cloud collection.
+    swupd:
+      deprecation:
+        removal_version: 15.0.0
+        warning_text: ClearLinux was made EOL in July 2025. If you think the module is still useful for another distribution, please create an issue in the community.general repository.
+    typetalk:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: The typetalk service will be discontinued on Dec 2025.
     vertica_facts:
       tombstone:
         removal_version: 3.0.0
@@ -1038,6 +1117,14 @@ plugin_routing:
   doc_fragments:
     _gcp:
       redirect: community.google._gcp
+    dimensiondata:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Service and its endpoints are no longer available.
+    dimensiondata_wait:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Service and its endpoints are no longer available.
     docker:
       redirect: community.docker.docker
     hetzner:
@@ -1080,7 +1167,7 @@ plugin_routing:
         removal_version: 15.0.0
         warning_text: The proxmox content has been moved to community.proxmox.
     purestorage:
-      deprecation:
+      tombstone:
         removal_version: 12.0.0
         warning_text: The modules for purestorage were removed in community.general 3.0.0, this document fragment was left behind.
     rackspace:
@@ -1089,6 +1176,18 @@ plugin_routing:
         warning_text: This doc fragment was used by rax modules, that relied on the deprecated
           package pyrax.
   module_utils:
+    cloud:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: This code is not used by community.general. If you want to use it in another collection, please copy it over.
+    database:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: This code is not used by community.general. If you want to use it in another collection, please copy it over.
+    dimensiondata:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: Service and its endpoints are no longer available.
     docker.common:
       redirect: community.docker.common
     docker.swarm:
@@ -1101,6 +1200,10 @@ plugin_routing:
       redirect: community.google.gcp
     hetzner:
       redirect: community.hrobot.robot
+    known_hosts:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: This code is not used by community.general. If you want to use it in another collection, please copy it over.
     kubevirt:
       redirect: community.kubevirt.kubevirt
     net_tools.nios.api:
@@ -1109,6 +1212,10 @@ plugin_routing:
       deprecation:
         removal_version: 13.0.0
         warning_text: Code is unmaintained here and official Oracle collection is available for a number of years.
+    oneandone:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: DNS fails to resolve the API endpoint used by the module.
     postgresql:
       redirect: community.postgresql.postgresql
     proxmox:
@@ -1117,7 +1224,7 @@ plugin_routing:
         removal_version: 15.0.0
         warning_text: The proxmox content has been moved to community.proxmox.
     pure:
-      deprecation:
+      tombstone:
         removal_version: 12.0.0
         warning_text: The modules for purestorage were removed in community.general 3.0.0, this module util was left behind.
     rax:
@@ -1128,6 +1235,10 @@ plugin_routing:
       redirect: dellemc.openmanage.dellemc_idrac
     remote_management.dellemc.ome:
       redirect: dellemc.openmanage.ome
+    saslprep:
+      deprecation:
+        removal_version: 13.0.0
+        warning_text: This code is not used by community.general. If you want to use it in another collection, please copy it over.
   inventory:
     docker_machine:
       redirect: community.docker.docker_machine

noxfile.py

@@ -6,13 +6,17 @@
 # dependencies = ["nox>=2025.02.09", "antsibull-nox"]
 # ///
 
+import os
 import sys
 
-import nox
+import nox  # type: ignore[import-not-found]
+
+# Whether the noxfile is running in CI:
+IN_CI = os.environ.get("CI") == "true"
 
 
 try:
-    import antsibull_nox
+    import antsibull_nox  # type: ignore[import-not-found]
 except ImportError:
     print("You need to install antsibull-nox in the same Python environment as nox.")
     sys.exit(1)
@@ -32,6 +36,23 @@ def botmeta(session: nox.Session) -> None:
     session.run("python", "tests/sanity/extra/botmeta.py")
 
 
+@nox.session(name="ansible-output", default=False)
+def ansible_output(session: nox.Session) -> None:
+    session.install(
+        "ansible-core",
+        "antsibull-docs",
+        # Needed libs for some code blocks:
+        "jc",
+        "hashids",
+        # Tools for post-processing
+        "ruamel.yaml",  # used by docs/docsite/reformat-yaml.py
+    )
+    args = []
+    if IN_CI:
+        args.append("--check")
+    session.run("antsibull-docs", "ansible-output", *args, *session.posargs)
+
+
 # Allow to run the noxfile with `python noxfile.py`, `pipx run noxfile.py`, or similar.
 # Requires nox >= 2025.02.09
 if __name__ == "__main__":

plugins/action/iptables_state.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2020, quidame <quidame@poivron.org>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -6,85 +5,96 @@
 from __future__ import annotations
 
 import time
+import typing as t
 
-from ansible.plugins.action import ActionBase
 from ansible.errors import AnsibleActionFail, AnsibleConnectionFailure
-from ansible.utils.vars import merge_hash
+from ansible.plugins.action import ActionBase
 from ansible.utils.display import Display
+from ansible.utils.vars import merge_hash
 
 display = Display()
 
 
 class ActionModule(ActionBase):
-
     # Keep internal params away from user interactions
-    _VALID_ARGS = frozenset(('path', 'state', 'table', 'noflush', 'counters', 'modprobe', 'ip_version', 'wait'))
+    _VALID_ARGS = frozenset(("path", "state", "table", "noflush", "counters", "modprobe", "ip_version", "wait"))
     DEFAULT_SUDOABLE = True
 
     @staticmethod
-    def msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout):
+    def msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout) -> str:
         return (
             "This module doesn't support async>0 and poll>0 when its 'state' param "
             "is set to 'restored'. To enable its rollback feature (that needs the "
             "module to run asynchronously on the remote), please set task attribute "
             f"'poll' (={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended).")
+            f"'ansible_timeout' (={max_timeout}) (recommended)."
+        )
 
     @staticmethod
-    def msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout):
+    def msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout) -> str:
         return (
             "Attempts to restore iptables state without rollback in case of mistake "
             "may lead the ansible controller to loose access to the hosts and never "
             "regain it before fixing firewall rules through a serial console, or any "
             f"other way except SSH. Please set task attribute 'poll' (={task_poll}) to 0, and "
             f"'async' (={task_async}) to a value >2 and not greater than 'ansible_timeout' (={max_timeout}) "
-            "(recommended).")
+            "(recommended)."
+        )
 
     @staticmethod
-    def msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout):
+    def msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout) -> str:
         return (
             "You attempt to restore iptables state with rollback in case of mistake, "
             "but with settings that will lead this rollback to happen AFTER that the "
             "controller will reach its own timeout. Please set task attribute 'poll' "
             f"(={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended).")
+            f"'ansible_timeout' (={max_timeout}) (recommended)."
+        )
 
-    def _async_result(self, async_status_args, task_vars, timeout):
-        '''
+    def _async_result(
+        self, async_status_args: dict[str, t.Any], task_vars: dict[str, t.Any], timeout: int
+    ) -> dict[str, t.Any]:
+        """
         Retrieve results of the asynchronous task, and display them in place of
         the async wrapper results (those with the ansible_job_id key).
-        '''
+        """
         async_status = self._task.copy()
         async_status.args = async_status_args
-        async_status.action = 'ansible.builtin.async_status'
+        async_status.action = "ansible.builtin.async_status"
         async_status.async_val = 0
         async_action = self._shared_loader_obj.action_loader.get(
-            async_status.action, task=async_status, connection=self._connection,
-            play_context=self._play_context, loader=self._loader, templar=self._templar,
-            shared_loader_obj=self._shared_loader_obj)
+            async_status.action,
+            task=async_status,
+            connection=self._connection,
+            play_context=self._play_context,
+            loader=self._loader,
+            templar=self._templar,
+            shared_loader_obj=self._shared_loader_obj,
+        )
 
-        if async_status.args['mode'] == 'cleanup':
+        if async_status.args["mode"] == "cleanup":
             return async_action.run(task_vars=task_vars)
 
         # At least one iteration is required, even if timeout is 0.
         for dummy in range(max(1, timeout)):
             async_result = async_action.run(task_vars=task_vars)
-            if async_result.get('finished', 0) == 1:
+            if async_result.get("finished", 0) == 1:
                 break
             time.sleep(min(1, timeout))
 
         return async_result
 
-    def run(self, tmp=None, task_vars=None):
-
+    def run(self, tmp: str | None = None, task_vars: dict[str, t.Any] | None = None) -> dict[str, t.Any]:
         self._supports_check_mode = True
         self._supports_async = True
 
-        result = super(ActionModule, self).run(tmp, task_vars)
+        if task_vars is None:
+            task_vars = {}
+
+        result = super().run(tmp, task_vars)
         del tmp  # tmp no longer has any effect
 
-        if not result.get('skipped'):
-
+        if not result.get("skipped"):
             # FUTURE: better to let _execute_module calculate this internally?
             wrap_async = self._task.async_val and not self._connection.has_native_async
 
@@ -99,41 +109,38 @@ class ActionModule(ActionBase):
             starter_cmd = None
             confirm_cmd = None
 
-            if module_args.get('state', None) == 'restored':
+            if module_args.get("state", None) == "restored":
                 if not wrap_async:
                     if not check_mode:
-                        display.warning(self.msg_error__async_and_poll_not_zero(
-                            task_poll,
-                            task_async,
-                            max_timeout))
+                        display.warning(self.msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout))
                 elif task_poll:
-                    raise AnsibleActionFail(self.msg_warning__no_async_is_no_rollback(
-                        task_poll,
-                        task_async,
-                        max_timeout))
+                    raise AnsibleActionFail(
+                        self.msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout)
+                    )
                 else:
                     if task_async > max_timeout and not check_mode:
-                        display.warning(self.msg_warning__async_greater_than_timeout(
-                            task_poll,
-                            task_async,
-                            max_timeout))
+                        display.warning(
+                            self.msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout)
+                        )
 
                     # inject the async directory based on the shell option into the
                     # module args
-                    async_dir = self.get_shell_option('async_dir', default="~/.ansible_async")
+                    async_dir = self.get_shell_option("async_dir", default="~/.ansible_async")
 
                     # Bind the loop max duration to consistent values on both
                     # remote and local sides (if not the same, make the loop
                     # longer on the controller); and set a backup file path.
-                    module_args['_timeout'] = task_async
-                    module_args['_back'] = f'{async_dir}/iptables.state'
-                    async_status_args = dict(mode='status')
+                    module_args["_timeout"] = task_async
+                    module_args["_back"] = f"{async_dir}/iptables.state"
+                    async_status_args = dict(mode="status")
                     confirm_cmd = f"rm -f {module_args['_back']}"
                     starter_cmd = f"touch {module_args['_back']}.starter"
                     remaining_time = max(task_async, max_timeout)
 
             # do work!
-            result = merge_hash(result, self._execute_module(module_args=module_args, task_vars=task_vars, wrap_async=wrap_async))
+            result = merge_hash(
+                result, self._execute_module(module_args=module_args, task_vars=task_vars, wrap_async=wrap_async)
+            )
 
             # Then the 3-steps "go ahead or rollback":
             # 1. Catch early errors of the module (in asynchronous task) if any.
@@ -141,9 +148,9 @@ class ActionModule(ActionBase):
             # 2. Reset connection to ensure a persistent one will not be reused.
             # 3. Confirm the restored state by removing the backup on the remote.
             #    Retrieve the results of the asynchronous task to return them.
-            if '_back' in module_args:
-                async_status_args['jid'] = result.get('ansible_job_id', None)
-                if async_status_args['jid'] is None:
+            if "_back" in module_args:
+                async_status_args["jid"] = result.get("ansible_job_id", None)
+                if async_status_args["jid"] is None:
                     raise AnsibleActionFail("Unable to get 'ansible_job_id'.")
 
                 # Catch early errors due to missing mandatory option, bad
@@ -157,7 +164,7 @@ class ActionModule(ActionBase):
 
                 # As the main command is not yet executed on the target, here
                 # 'finished' means 'failed before main command be executed'.
-                if not result['finished']:
+                if not result["finished"]:
                     try:
                         self._connection.reset()
                     except AttributeError:
@@ -179,16 +186,16 @@ class ActionModule(ActionBase):
                     result = merge_hash(result, self._async_result(async_status_args, task_vars, remaining_time))
 
                 # Cleanup async related stuff and internal params
-                for key in ('ansible_job_id', 'results_file', 'started', 'finished'):
+                for key in ("ansible_job_id", "results_file", "started", "finished"):
                     if result.get(key):
                         del result[key]
 
-                if result.get('invocation', {}).get('module_args'):
-                    for key in ('_back', '_timeout', '_async_dir', 'jid'):
-                        if result['invocation']['module_args'].get(key):
-                            del result['invocation']['module_args'][key]
+                if result.get("invocation", {}).get("module_args"):
+                    for key in ("_back", "_timeout", "_async_dir", "jid"):
+                        if result["invocation"]["module_args"].get(key):
+                            del result["invocation"]["module_args"][key]
 
-                async_status_args['mode'] = 'cleanup'
+                async_status_args["mode"] = "cleanup"
                 dummy = self._async_result(async_status_args, task_vars, 0)
 
         if not wrap_async:

plugins/action/shutdown.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2020, Amin Vakil <info@aminvakil.com>
 # Copyright (c) 2016-2018, Matt Davis <mdavis@ansible.com>
 # Copyright (c) 2018, Sam Doran <sdoran@redhat.com>
@@ -7,121 +6,117 @@
 
 from __future__ import annotations
 
+import typing as t
 
-from ansible.errors import AnsibleError, AnsibleConnectionFailure
-from ansible.module_utils.common.text.converters import to_native, to_text
+from ansible.errors import AnsibleConnectionFailure, AnsibleError
 from ansible.module_utils.common.collections import is_string
+from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.plugins.action import ActionBase
 from ansible.utils.display import Display
 
+if t.TYPE_CHECKING:
+
+    class Distribution(t.TypedDict):
+        name: str
+        version: str
+        family: str
+
+
 display = Display()
 
 
-def fmt(mapping, key):
-    return to_native(mapping[key]).strip()
-
-
 class TimedOutException(Exception):
     pass
 
 
 class ActionModule(ActionBase):
     TRANSFERS_FILES = False
-    _VALID_ARGS = frozenset((
-        'msg',
-        'delay',
-        'search_paths'
-    ))
+    _VALID_ARGS = frozenset(("msg", "delay", "search_paths"))
 
     DEFAULT_CONNECT_TIMEOUT = None
     DEFAULT_PRE_SHUTDOWN_DELAY = 0
-    DEFAULT_SHUTDOWN_MESSAGE = 'Shut down initiated by Ansible'
-    DEFAULT_SHUTDOWN_COMMAND = 'shutdown'
+    DEFAULT_SHUTDOWN_MESSAGE = "Shut down initiated by Ansible"
+    DEFAULT_SHUTDOWN_COMMAND = "shutdown"
     DEFAULT_SHUTDOWN_COMMAND_ARGS = '-h {delay_min} "{message}"'
     DEFAULT_SUDOABLE = True
 
     SHUTDOWN_COMMANDS = {
-        'alpine': 'poweroff',
-        'vmkernel': 'halt',
+        "alpine": "poweroff",
+        "vmkernel": "halt",
     }
 
     SHUTDOWN_COMMAND_ARGS = {
-        'alpine': '',
-        'void': '-h +{delay_min} "{message}"',
-        'freebsd': '-p +{delay_sec}s "{message}"',
-        'linux': DEFAULT_SHUTDOWN_COMMAND_ARGS,
-        'macosx': '-h +{delay_min} "{message}"',
-        'openbsd': '-h +{delay_min} "{message}"',
-        'solaris': '-y -g {delay_sec} -i 5 "{message}"',
-        'sunos': '-y -g {delay_sec} -i 5 "{message}"',
-        'vmkernel': '-d {delay_sec}',
-        'aix': '-Fh',
+        "alpine": "",
+        "void": '-h +{delay_min} "{message}"',
+        "freebsd": '-p +{delay_sec}s "{message}"',
+        "linux": DEFAULT_SHUTDOWN_COMMAND_ARGS,
+        "macosx": '-h +{delay_min} "{message}"',
+        "openbsd": '-h +{delay_min} "{message}"',
+        "solaris": '-y -g {delay_sec} -i 5 "{message}"',
+        "sunos": '-y -g {delay_sec} -i 5 "{message}"',
+        "vmkernel": "-d {delay_sec}",
+        "aix": "-Fh",
     }
 
     def __init__(self, *args, **kwargs):
-        super(ActionModule, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     @property
     def delay(self):
-        return self._check_delay('delay', self.DEFAULT_PRE_SHUTDOWN_DELAY)
+        return self._check_delay("delay", self.DEFAULT_PRE_SHUTDOWN_DELAY)
 
-    def _check_delay(self, key, default):
+    def _check_delay(self, key: str, default: int) -> int:
         """Ensure that the value is positive or zero"""
         value = int(self._task.args.get(key, default))
         if value < 0:
             value = 0
         return value
 
-    def _get_value_from_facts(self, variable_name, distribution, default_value):
+    @staticmethod
+    def _get_value_from_facts(data: dict[str, str], distribution: Distribution, default_value: str) -> str:
         """Get dist+version specific args first, then distribution, then family, lastly use default"""
-        attr = getattr(self, variable_name)
-        value = attr.get(
-            distribution['name'] + distribution['version'],
-            attr.get(
-                distribution['name'],
-                attr.get(
-                    distribution['family'],
-                    getattr(self, default_value))))
-        return value
+        return data.get(
+            distribution["name"] + distribution["version"],
+            data.get(distribution["name"], data.get(distribution["family"], default_value)),
+        )
 
-    def get_distribution(self, task_vars):
+    def get_distribution(self, task_vars: dict[str, t.Any]) -> Distribution:
         # FIXME: only execute the module if we don't already have the facts we need
-        distribution = {}
-        display.debug(f'{self._task.action}: running setup module to get distribution')
+        display.debug(f"{self._task.action}: running setup module to get distribution")
         module_output = self._execute_module(
-            task_vars=task_vars,
-            module_name='ansible.legacy.setup',
-            module_args={'gather_subset': 'min'})
+            task_vars=task_vars, module_name="ansible.legacy.setup", module_args={"gather_subset": "min"}
+        )
         try:
-            if module_output.get('failed', False):
-                raise AnsibleError(f"Failed to determine system distribution. {fmt(module_output, 'module_stdout')}, {fmt(module_output, 'module_stderr')}")
-            distribution['name'] = module_output['ansible_facts']['ansible_distribution'].lower()
-            distribution['version'] = to_text(
-                module_output['ansible_facts']['ansible_distribution_version'].split('.')[0])
-            distribution['family'] = to_text(module_output['ansible_facts']['ansible_os_family'].lower())
+            if module_output.get("failed", False):
+                raise AnsibleError(
+                    f"Failed to determine system distribution. {to_native(module_output['module_stdout'])}, {to_native(module_output['module_stderr'])}"
+                )
+            distribution: Distribution = {
+                "name": module_output["ansible_facts"]["ansible_distribution"].lower(),
+                "version": to_text(module_output["ansible_facts"]["ansible_distribution_version"].split(".")[0]),
+                "family": to_text(module_output["ansible_facts"]["ansible_os_family"].lower()),
+            }
             display.debug(f"{self._task.action}: distribution: {distribution}")
             return distribution
         except KeyError as ke:
-            raise AnsibleError(f'Failed to get distribution information. Missing "{ke.args[0]}" in output.')
+            raise AnsibleError(f'Failed to get distribution information. Missing "{ke.args[0]}" in output.') from ke
 
-    def get_shutdown_command(self, task_vars, distribution):
-        def find_command(command, find_search_paths):
-            display.debug(f'{self._task.action}: running find module looking in {find_search_paths} to get path for "{command}"')
+    def get_shutdown_command(self, task_vars: dict[str, t.Any], distribution: Distribution) -> str:
+        def find_command(command: str, find_search_paths: list[str]) -> list[str]:
+            display.debug(
+                f'{self._task.action}: running find module looking in {find_search_paths} to get path for "{command}"'
+            )
             find_result = self._execute_module(
                 task_vars=task_vars,
                 # prevent collection search by calling with ansible.legacy (still allows library/ override of find)
-                module_name='ansible.legacy.find',
-                module_args={
-                    'paths': find_search_paths,
-                    'patterns': [command],
-                    'file_type': 'any'
-                }
+                module_name="ansible.legacy.find",
+                module_args={"paths": find_search_paths, "patterns": [command], "file_type": "any"},
             )
-            return [x['path'] for x in find_result['files']]
+            return [x["path"] for x in find_result["files"]]
 
-        shutdown_bin = self._get_value_from_facts('SHUTDOWN_COMMANDS', distribution, 'DEFAULT_SHUTDOWN_COMMAND')
-        default_search_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']
-        search_paths = self._task.args.get('search_paths', default_search_paths)
+        shutdown_bin = self._get_value_from_facts(self.SHUTDOWN_COMMANDS, distribution, self.DEFAULT_SHUTDOWN_COMMAND)
+        default_search_paths = ["/sbin", "/usr/sbin", "/usr/local/sbin"]
+        search_paths = self._task.args.get("search_paths", default_search_paths)
 
         # FIXME: switch all this to user arg spec validation methods when they are available
         # Convert bare strings to a list
@@ -132,36 +127,38 @@ class ActionModule(ActionBase):
             incorrect_type = any(not is_string(x) for x in search_paths)
             if not isinstance(search_paths, list) or incorrect_type:
                 raise TypeError
-        except TypeError:
+        except TypeError as e:
             # Error if we didn't get a list
             err_msg = f"'search_paths' must be a string or flat list of strings, got {search_paths}"
-            raise AnsibleError(err_msg)
+            raise AnsibleError(err_msg) from e
 
         full_path = find_command(shutdown_bin, search_paths)  # find the path to the shutdown command
         if not full_path:  # if we could not find the shutdown command
-
             # tell the user we will try with systemd
-            display.vvv(f'Unable to find command "{shutdown_bin}" in search paths: {search_paths}, will attempt a shutdown using systemd directly.')
-            systemctl_search_paths = ['/bin', '/usr/bin']
-            full_path = find_command('systemctl', systemctl_search_paths)  # find the path to the systemctl command
+            display.vvv(
+                f'Unable to find command "{shutdown_bin}" in search paths: {search_paths}, will attempt a shutdown using systemd directly.'
+            )
+            systemctl_search_paths = ["/bin", "/usr/bin"]
+            full_path = find_command("systemctl", systemctl_search_paths)  # find the path to the systemctl command
             if not full_path:  # if we couldn't find systemctl
                 raise AnsibleError(
                     f'Could not find command "{shutdown_bin}" in search paths: {search_paths} or systemctl'
-                    f' command in search paths: {systemctl_search_paths}, unable to shutdown.')  # we give up here
+                    f" command in search paths: {systemctl_search_paths}, unable to shutdown."
+                )  # we give up here
             else:
                 return f"{full_path[0]} poweroff"  # done, since we cannot use args with systemd shutdown
 
         # systemd case taken care of, here we add args to the command
-        args = self._get_value_from_facts('SHUTDOWN_COMMAND_ARGS', distribution, 'DEFAULT_SHUTDOWN_COMMAND_ARGS')
+        args = self._get_value_from_facts(self.SHUTDOWN_COMMAND_ARGS, distribution, self.DEFAULT_SHUTDOWN_COMMAND_ARGS)
         # Convert seconds to minutes. If less that 60, set it to 0.
         delay_sec = self.delay
-        shutdown_message = self._task.args.get('msg', self.DEFAULT_SHUTDOWN_MESSAGE)
+        shutdown_message = self._task.args.get("msg", self.DEFAULT_SHUTDOWN_MESSAGE)
 
         af = args.format(delay_sec=delay_sec, delay_min=delay_sec // 60, message=shutdown_message)
-        return f'{full_path[0]} {af}'
+        return f"{full_path[0]} {af}"
 
-    def perform_shutdown(self, task_vars, distribution):
-        result = {}
+    def perform_shutdown(self, task_vars, distribution) -> dict[str, t.Any]:
+        result: dict[str, t.Any] = {}
         shutdown_result = {}
         shutdown_command_exec = self.get_shutdown_command(task_vars, distribution)
 
@@ -170,40 +167,41 @@ class ActionModule(ActionBase):
             display.vvv(f"{self._task.action}: shutting down server...")
             display.debug(f"{self._task.action}: shutting down server with command '{shutdown_command_exec}'")
             if self._play_context.check_mode:
-                shutdown_result['rc'] = 0
+                shutdown_result["rc"] = 0
             else:
                 shutdown_result = self._low_level_execute_command(shutdown_command_exec, sudoable=self.DEFAULT_SUDOABLE)
         except AnsibleConnectionFailure as e:
             # If the connection is closed too quickly due to the system being shutdown, carry on
-            display.debug(
-                f'{self._task.action}: AnsibleConnectionFailure caught and handled: {e}')
-            shutdown_result['rc'] = 0
+            display.debug(f"{self._task.action}: AnsibleConnectionFailure caught and handled: {e}")
+            shutdown_result["rc"] = 0
 
-        if shutdown_result['rc'] != 0:
-            result['failed'] = True
-            result['shutdown'] = False
-            result['msg'] = f"Shutdown command failed. Error was {fmt(shutdown_result, 'stdout')}, {fmt(shutdown_result, 'stderr')}"
+        if shutdown_result["rc"] != 0:
+            result["failed"] = True
+            result["shutdown"] = False
+            result["msg"] = (
+                f"Shutdown command failed. Error was {to_native(shutdown_result['stdout'])}, {to_native(shutdown_result['stderr'])}"
+            )
             return result
 
-        result['failed'] = False
-        result['shutdown_command'] = shutdown_command_exec
+        result["failed"] = False
+        result["shutdown_command"] = shutdown_command_exec
         return result
 
-    def run(self, tmp=None, task_vars=None):
+    def run(self, tmp: str | None = None, task_vars: dict[str, t.Any] | None = None) -> dict[str, t.Any]:
         self._supports_check_mode = True
         self._supports_async = True
 
         # If running with local connection, fail so we don't shutdown ourself
-        if self._connection.transport == 'local' and (not self._play_context.check_mode):
-            msg = f'Running {self._task.action} with local connection would shutdown the control node.'
-            return {'changed': False, 'elapsed': 0, 'shutdown': False, 'failed': True, 'msg': msg}
+        if self._connection.transport == "local" and (not self._play_context.check_mode):
+            msg = f"Running {self._task.action} with local connection would shutdown the control node."
+            return {"changed": False, "elapsed": 0, "shutdown": False, "failed": True, "msg": msg}
 
         if task_vars is None:
             task_vars = {}
 
-        result = super(ActionModule, self).run(tmp, task_vars)
+        result = super().run(tmp, task_vars)
 
-        if result.get('skipped', False) or result.get('failed', False):
+        if result.get("skipped", False) or result.get("failed", False):
             return result
 
         distribution = self.get_distribution(task_vars)
@@ -211,12 +209,12 @@ class ActionModule(ActionBase):
         # Initiate shutdown
         shutdown_result = self.perform_shutdown(task_vars, distribution)
 
-        if shutdown_result['failed']:
+        if shutdown_result["failed"]:
             result = shutdown_result
             return result
 
-        result['shutdown'] = True
-        result['changed'] = True
-        result['shutdown_command'] = shutdown_result['shutdown_command']
+        result["shutdown"] = True
+        result["changed"] = True
+        result["shutdown_command"] = shutdown_result["shutdown_command"]
 
         return result

plugins/become/doas.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -83,9 +82,26 @@ options:
       - name: ansible_doas_prompt_l10n
     env:
       - name: ANSIBLE_DOAS_PROMPT_L10N
+  allow_pipelining:
+    description:
+      - When set to V(true), do allow pipelining with ansible-core 2.19+.
+      - This should only be used when doas is configured to not ask for a password (C(nopass)).
+    type: boolean
+    default: false
+    version_added: 12.4.0
+    ini:
+      - section: doas_become_plugin
+        key: allow_pipelining
+    vars:
+      - name: ansible_doas_allow_pipelining
+    env:
+      - name: ANSIBLE_DOAS_ALLOW_PIPELINING
 notes:
-  - This become plugin does not work when connection pipelining is enabled. With ansible-core 2.19+, using it automatically
-    disables pipelining. On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
+  - This become plugin does not work when connection pipelining is enabled
+    and doas requests a password.
+    With ansible-core 2.19+, using this plugin automatically disables pipelining,
+    unless O(allow_pipelining=true) is explicitly set by the user.
+    On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
 """
 
 import re
@@ -95,45 +111,47 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.doas'
+    name = "community.general.doas"
 
     # messages for detecting prompted password issues
-    fail = ('Permission denied',)
-    missing = ('Authorization required',)
+    fail = ("Permission denied",)
+    missing = ("Authorization required",)
 
     # See https://github.com/ansible-collections/community.general/issues/9977,
-    # https://github.com/ansible/ansible/pull/78111
-    pipelining = False
+    # https://github.com/ansible/ansible/pull/78111,
+    # https://github.com/ansible-collections/community.general/issues/11411
+    @property
+    def pipelining(self) -> bool:  # type: ignore[override]
+        return self.get_option("allow_pipelining")
 
     def check_password_prompt(self, b_output):
-        ''' checks if the expected password prompt exists in b_output '''
+        """checks if the expected password prompt exists in b_output"""
 
         # FIXME: more accurate would be: 'doas (%s@' % remote_user
         # however become plugins don't have that information currently
-        b_prompts = [to_bytes(p) for p in self.get_option('prompt_l10n')] or [br'doas \(', br'Password:']
+        b_prompts = [to_bytes(p) for p in self.get_option("prompt_l10n")] or [rb"doas \(", rb"Password:"]
         b_prompt = b"|".join(b_prompts)
 
         return bool(re.match(b_prompt, b_output))
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
         self.prompt = True
 
-        become_exe = self.get_option('become_exe')
+        become_exe = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        if not self.get_option('become_pass') and '-n' not in flags:
-            flags += ' -n'
+        flags = self.get_option("become_flags")
+        if not self.get_option("become_pass") and "-n" not in flags:
+            flags += " -n"
 
-        become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
+        become_user = self.get_option("become_user")
+        user = f"-u {become_user}" if become_user else ""
 
         success_cmd = self._build_success_command(cmd, shell, noexe=True)
-        executable = getattr(shell, 'executable', shell.SHELL_FAMILY)
+        executable = getattr(shell, "executable", shell.SHELL_FAMILY)
 
-        return f'{become_exe} {flags} {user} {executable} -c {success_cmd}'
+        return f"{become_exe} {flags} {user} {executable} -c {success_cmd}"

plugins/become/dzdo.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -75,26 +74,25 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.dzdo'
+    name = "community.general.dzdo"
 
     # messages for detecting prompted password issues
-    fail = ('Sorry, try again.',)
+    fail = ("Sorry, try again.",)
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        becomecmd = self.get_option('become_exe')
+        becomecmd = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        if self.get_option('become_pass'):
-            self.prompt = f'[dzdo via ansible, key={self._id}] password:'
-            flags = f"{flags.replace('-n', '')} -p \"{self.prompt}\""
+        flags = self.get_option("become_flags")
+        if self.get_option("become_pass"):
+            self.prompt = f"[dzdo via ansible, key={self._id}] password:"
+            flags = f'{flags.replace("-n", "")} -p "{self.prompt}"'
 
-        become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
+        become_user = self.get_option("become_user")
+        user = f"-u {become_user}" if become_user else ""
 
         return f"{becomecmd} {flags} {user} {self._build_success_command(cmd, shell)}"

plugins/become/ksu.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -93,24 +92,22 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.ksu'
+    name = "community.general.ksu"
 
     # messages for detecting prompted password issues
-    fail = ('Password incorrect',)
-    missing = ('No password given',)
+    fail = ("Password incorrect",)
+    missing = ("No password given",)
 
     def check_password_prompt(self, b_output):
-        ''' checks if the expected password prompt exists in b_output '''
+        """checks if the expected password prompt exists in b_output"""
 
-        prompts = self.get_option('prompt_l10n') or ["Kerberos password for .*@.*:"]
+        prompts = self.get_option("prompt_l10n") or ["Kerberos password for .*@.*:"]
         b_prompt = b"|".join(to_bytes(p) for p in prompts)
 
         return bool(re.match(b_prompt, b_output))
 
     def build_become_command(self, cmd, shell):
-
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         # Prompt handling for ``ksu`` is more complicated, this
         # is used to satisfy the connection plugin
@@ -119,8 +116,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        exe = self.get_option('become_exe')
+        exe = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        user = self.get_option('become_user')
-        return f'{exe} {user} {flags} -e {self._build_success_command(cmd, shell)} '
+        flags = self.get_option("become_flags")
+        user = self.get_option("become_user")
+        return f"{exe} {user} {flags} -e {self._build_success_command(cmd, shell)} "

plugins/become/machinectl.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -93,20 +92,18 @@ EXAMPLES = r"""
 
 from re import compile as re_compile
 
-from ansible.plugins.become import BecomeBase
 from ansible.module_utils.common.text.converters import to_bytes
+from ansible.plugins.become import BecomeBase
 
-
-ansi_color_codes = re_compile(to_bytes(r'\x1B\[[0-9;]+m'))
+ansi_color_codes = re_compile(to_bytes(r"\x1B\[[0-9;]+m"))
 
 
 class BecomeModule(BecomeBase):
+    name = "community.general.machinectl"
 
-    name = 'community.general.machinectl'
-
-    prompt = 'Password: '
-    fail = ('==== AUTHENTICATION FAILED ====',)
-    success = ('==== AUTHENTICATION COMPLETE ====',)
+    prompt = "Password: "
+    fail = ("==== AUTHENTICATION FAILED ====",)
+    success = ("==== AUTHENTICATION COMPLETE ====",)
     require_tty = True  # see https://github.com/ansible-collections/community.general/issues/6932
 
     # See https://github.com/ansible/ansible/issues/81254,
@@ -118,16 +115,19 @@ class BecomeModule(BecomeBase):
         return ansi_color_codes.sub(b"", line)
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe')
+        become = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        user = self.get_option('become_user')
-        return f'{become} -q shell {flags} {user}@ {self._build_success_command(cmd, shell)}'
+        flags = self.get_option("become_flags")
+        user = self.get_option("become_user")
+        # SYSTEMD_COLORS=0 stops machinectl from appending ANSI reset
+        # sequences (ESC[0m, ESC[J) after the child exits, which would
+        # otherwise land after the module JSON and break result parsing.
+        return f"SYSTEMD_COLORS=0 {become} -q shell {flags} {user}@ {self._build_success_command(cmd, shell)}"
 
     def check_success(self, b_output):
         b_output = self.remove_ansi_codes(b_output)

plugins/become/pbrun.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -87,22 +86,21 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
+    name = "community.general.pbrun"
 
-    name = 'community.general.pbrun'
-
-    prompt = 'Password:'
+    prompt = "Password:"
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        become_exe = self.get_option('become_exe')
+        become_exe = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
-        noexe = not self.get_option('wrap_exe')
+        flags = self.get_option("become_flags")
+        become_user = self.get_option("become_user")
+        user = f"-u {become_user}" if become_user else ""
+        noexe = not self.get_option("wrap_exe")
 
         return f"{become_exe} {flags} {user} {self._build_success_command(cmd, shell, noexe=noexe)}"

plugins/become/pfexec.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -92,17 +91,16 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.pfexec'
+    name = "community.general.pfexec"
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        exe = self.get_option('become_exe')
+        exe = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        noexe = not self.get_option('wrap_exe')
-        return f'{exe} {flags} {self._build_success_command(cmd, shell, noexe=noexe)}'
+        flags = self.get_option("become_flags")
+        noexe = not self.get_option("wrap_exe")
+        return f"{exe} {flags} {self._build_success_command(cmd, shell, noexe=noexe)}"

plugins/become/pmrun.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -60,21 +59,21 @@ notes:
 """
 
 from shlex import quote as shlex_quote
+
 from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.pmrun'
-    prompt = 'Enter UPM user password:'
+    name = "community.general.pmrun"
+    prompt = "Enter UPM user password:"
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe')
+        become = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        return f'{become} {flags} {shlex_quote(self._build_success_command(cmd, shell))}'
+        flags = self.get_option("become_flags")
+        return f"{become} {flags} {shlex_quote(self._build_success_command(cmd, shell))}"

plugins/become/run0.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2024, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from __future__ import annotations
 
-
 DOCUMENTATION = r"""
 name: run0
 short_description: Systemd's run0
@@ -62,6 +60,8 @@ options:
     type: string
 notes:
   - This plugin only works when a C(polkit) rule is in place.
+  - This become plugin does not work when connection pipelining is enabled. With ansible-core 2.19+, using it automatically
+    disables pipelining. On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
 """
 
 EXAMPLES = r"""
@@ -79,22 +79,23 @@ EXAMPLES = r"""
 
 from re import compile as re_compile
 
-from ansible.plugins.become import BecomeBase
 from ansible.module_utils.common.text.converters import to_bytes
+from ansible.plugins.become import BecomeBase
 
 ansi_color_codes = re_compile(to_bytes(r"\x1B\[[0-9;]+m"))
 
 
 class BecomeModule(BecomeBase):
-
     name = "community.general.run0"
 
     prompt = "Password: "
     fail = ("==== AUTHENTICATION FAILED ====",)
     success = ("==== AUTHENTICATION COMPLETE ====",)
-    require_tty = (
-        True  # see https://github.com/ansible-collections/community.general/issues/6932
-    )
+    require_tty = True  # see https://github.com/ansible-collections/community.general/issues/6932
+
+    # See https://github.com/ansible/ansible/issues/81254,
+    # https://github.com/ansible/ansible/pull/78111
+    pipelining = False
 
     @staticmethod
     def remove_ansi_codes(line):
@@ -110,9 +111,11 @@ class BecomeModule(BecomeBase):
         flags = self.get_option("become_flags")
         user = self.get_option("become_user")
 
-        return (
-            f"{become} --user={user} {flags} {self._build_success_command(cmd, shell)}"
-        )
+        # SYSTEMD_COLORS=0 stops run0 from emitting terminal control
+        # sequences (window title OSC, ANSI reset) around the child
+        # command, which would otherwise corrupt the module JSON and
+        # break result parsing.
+        return f"SYSTEMD_COLORS=0 {become} --user={user} {flags} {self._build_success_command(cmd, shell)}"
 
     def check_success(self, b_output):
         b_output = self.remove_ansi_codes(b_output)

plugins/become/sesu.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -76,20 +75,19 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
+    name = "community.general.sesu"
 
-    name = 'community.general.sesu'
-
-    prompt = 'Please enter your password:'
-    fail = missing = ('Sorry, try again with sesu.',)
+    prompt = "Please enter your password:"
+    fail = missing = ("Sorry, try again with sesu.",)
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe')
+        become = self.get_option("become_exe")
 
-        flags = self.get_option('become_flags')
-        user = self.get_option('become_user')
-        return f'{become} {flags} {user} -c {self._build_success_command(cmd, shell)}'
+        flags = self.get_option("become_flags")
+        user = self.get_option("become_user")
+        return f"{become} {flags} {user} -c {self._build_success_command(cmd, shell)}"

plugins/become/sudosu.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2021, Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -80,34 +79,33 @@ from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-
-    name = 'community.general.sudosu'
+    name = "community.general.sudosu"
 
     # messages for detecting prompted password issues
-    fail = ('Sorry, try again.',)
-    missing = ('Sorry, a password is required to run sudo', 'sudo: a password is required')
+    fail = ("Sorry, try again.",)
+    missing = ("Sorry, a password is required to run sudo", "sudo: a password is required")
 
     def build_become_command(self, cmd, shell):
-        super(BecomeModule, self).build_become_command(cmd, shell)
+        super().build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        becomecmd = 'sudo'
+        becomecmd = "sudo"
 
-        flags = self.get_option('become_flags') or ''
-        prompt = ''
-        if self.get_option('become_pass'):
-            self.prompt = f'[sudo via ansible, key={self._id}] password:'
+        flags = self.get_option("become_flags") or ""
+        prompt = ""
+        if self.get_option("become_pass"):
+            self.prompt = f"[sudo via ansible, key={self._id}] password:"
             if flags:  # this could be simplified, but kept as is for now for backwards string matching
-                flags = flags.replace('-n', '')
+                flags = flags.replace("-n", "")
             prompt = f'-p "{self.prompt}"'
 
-        user = self.get_option('become_user') or ''
+        user = self.get_option("become_user") or ""
         if user:
-            user = f'{user}'
+            user = f"{user}"
 
-        if self.get_option('alt_method'):
+        if self.get_option("alt_method"):
             return f"{becomecmd} {flags} {prompt} su -l {user} -c {self._build_success_command(cmd, shell, True)}"
         else:
             return f"{becomecmd} {flags} {prompt} su -l {user} {self._build_success_command(cmd, shell)}"

plugins/cache/memcached.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2014, Brian Coca, Josh Drake, et al
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -50,16 +49,17 @@ options:
 import collections
 import os
 import time
-from multiprocessing import Lock
+from collections.abc import MutableSet
 from itertools import chain
+from multiprocessing import Lock
 
 from ansible.errors import AnsibleError
-from collections.abc import MutableSet
 from ansible.plugins.cache import BaseCacheModule
 from ansible.utils.display import Display
 
 try:
     import memcache
+
     HAS_MEMCACHE = True
 except ImportError:
     HAS_MEMCACHE = False
@@ -67,7 +67,7 @@ except ImportError:
 display = Display()
 
 
-class ProxyClientPool(object):
+class ProxyClientPool:
     """
     Memcached connection pooling for thread/fork safety. Inspired by py-redis
     connection pool.
@@ -76,7 +76,7 @@ class ProxyClientPool(object):
     """
 
     def __init__(self, *args, **kwargs):
-        self.max_connections = kwargs.pop('max_connections', 1024)
+        self.max_connections = kwargs.pop("max_connections", 1024)
         self.connection_args = args
         self.connection_kwargs = kwargs
         self.reset()
@@ -124,6 +124,7 @@ class ProxyClientPool(object):
     def __getattr__(self, name):
         def wrapped(*args, **kwargs):
             return self._proxy_client(name, *args, **kwargs)
+
         return wrapped
 
     def _proxy_client(self, name, *args, **kwargs):
@@ -140,7 +141,8 @@ class CacheModuleKeys(MutableSet):
     A set subclass that keeps track of insertion time and persists
     the set in memcached.
     """
-    PREFIX = 'ansible_cache_keys'
+
+    PREFIX = "ansible_cache_keys"
 
     def __init__(self, cache, *args, **kwargs):
         self._cache = cache
@@ -172,15 +174,14 @@ class CacheModuleKeys(MutableSet):
 
 
 class CacheModule(BaseCacheModule):
-
     def __init__(self, *args, **kwargs):
-        connection = ['127.0.0.1:11211']
+        connection = ["127.0.0.1:11211"]
 
-        super(CacheModule, self).__init__(*args, **kwargs)
-        if self.get_option('_uri'):
-            connection = self.get_option('_uri')
-        self._timeout = self.get_option('_timeout')
-        self._prefix = self.get_option('_prefix')
+        super().__init__(*args, **kwargs)
+        if self.get_option("_uri"):
+            connection = self.get_option("_uri")
+        self._timeout = self.get_option("_timeout")
+        self._prefix = self.get_option("_prefix")
 
         if not HAS_MEMCACHE:
             raise AnsibleError("python-memcached is required for the memcached fact cache")

plugins/cache/pickle.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2017, Brian Coca
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -43,10 +42,7 @@ options:
     type: float
 """
 
-try:
-    import cPickle as pickle
-except ImportError:
-    import pickle
+import pickle
 
 from ansible.plugins.cache import BaseFileCacheModule
 
@@ -55,14 +51,15 @@ class CacheModule(BaseFileCacheModule):
     """
     A caching module backed by pickle files.
     """
+
     _persistent = False  # prevent unnecessary JSON serialization and key munging
 
     def _load(self, filepath):
         # Pickle is a binary format
-        with open(filepath, 'rb') as f:
-            return pickle.load(f, encoding='bytes')
+        with open(filepath, "rb") as f:
+            return pickle.load(f, encoding="bytes")
 
     def _dump(self, value, filepath):
-        with open(filepath, 'wb') as f:
+        with open(filepath, "wb") as f:
             # Use pickle protocol 2 which is compatible with Python 2.3+.
             pickle.dump(value, f, protocol=2)

plugins/cache/redis.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2014, Brian Coca, Josh Drake, et al
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -67,17 +66,18 @@ options:
         section: defaults
 """
 
+import json
 import re
 import time
-import json
 
 from ansible.errors import AnsibleError
-from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder
+from ansible.parsing.ajson import AnsibleJSONDecoder, AnsibleJSONEncoder
 from ansible.plugins.cache import BaseCacheModule
 from ansible.utils.display import Display
 
 try:
-    from redis import StrictRedis, VERSION
+    from redis import VERSION, StrictRedis
+
     HAS_REDIS = True
 except ImportError:
     HAS_REDIS = False
@@ -94,32 +94,35 @@ class CacheModule(BaseCacheModule):
     to expire keys. This mechanism is used or a pattern matched 'scan' for
     performance.
     """
+
     _sentinel_service_name = None
-    re_url_conn = re.compile(r'^([^:]+|\[[^]]+\]):(\d+):(\d+)(?::(.*))?$')
-    re_sent_conn = re.compile(r'^(.*):(\d+)$')
+    re_url_conn = re.compile(r"^([^:]+|\[[^]]+\]):(\d+):(\d+)(?::(.*))?$")
+    re_sent_conn = re.compile(r"^(.*):(\d+)$")
 
     def __init__(self, *args, **kwargs):
-        uri = ''
+        uri = ""
 
-        super(CacheModule, self).__init__(*args, **kwargs)
-        if self.get_option('_uri'):
-            uri = self.get_option('_uri')
-        self._timeout = float(self.get_option('_timeout'))
-        self._prefix = self.get_option('_prefix')
-        self._keys_set = self.get_option('_keyset_name')
-        self._sentinel_service_name = self.get_option('_sentinel_service_name')
+        super().__init__(*args, **kwargs)
+        if self.get_option("_uri"):
+            uri = self.get_option("_uri")
+        self._timeout = float(self.get_option("_timeout"))
+        self._prefix = self.get_option("_prefix")
+        self._keys_set = self.get_option("_keyset_name")
+        self._sentinel_service_name = self.get_option("_sentinel_service_name")
 
         if not HAS_REDIS:
-            raise AnsibleError("The 'redis' python module (version 2.4.5 or newer) is required for the redis fact cache, 'pip install redis'")
+            raise AnsibleError(
+                "The 'redis' python module (version 2.4.5 or newer) is required for the redis fact cache, 'pip install redis'"
+            )
 
         self._cache = {}
         kw = {}
 
         # tls connection
-        tlsprefix = 'tls://'
+        tlsprefix = "tls://"
         if uri.startswith(tlsprefix):
-            kw['ssl'] = True
-            uri = uri[len(tlsprefix):]
+            kw["ssl"] = True
+            uri = uri[len(tlsprefix) :]
 
         # redis sentinel connection
         if self._sentinel_service_name:
@@ -129,7 +132,7 @@ class CacheModule(BaseCacheModule):
             connection = self._parse_connection(self.re_url_conn, uri)
             self._db = StrictRedis(*connection, **kw)
 
-        display.vv(f'Redis connection: {self._db}')
+        display.vv(f"Redis connection: {self._db}")
 
     @staticmethod
     def _parse_connection(re_patt, uri):
@@ -144,36 +147,37 @@ class CacheModule(BaseCacheModule):
         """
         try:
             from redis.sentinel import Sentinel
-        except ImportError:
-            raise AnsibleError("The 'redis' python module (version 2.9.0 or newer) is required to use redis sentinel.")
+        except ImportError as e:
+            raise AnsibleError(
+                "The 'redis' python module (version 2.9.0 or newer) is required to use redis sentinel."
+            ) from e
 
-        if ';' not in uri:
-            raise AnsibleError('_uri does not have sentinel syntax.')
+        if ";" not in uri:
+            raise AnsibleError("_uri does not have sentinel syntax.")
 
         # format: "localhost:26379;localhost2:26379;0:changeme"
-        connections = uri.split(';')
+        connections = uri.split(";")
         connection_args = connections.pop(-1)
         if len(connection_args) > 0:  # handle if no db nr is given
-            connection_args = connection_args.split(':')
-            kw['db'] = connection_args.pop(0)
+            connection_args = connection_args.split(":")
+            kw["db"] = connection_args.pop(0)
             try:
-                kw['password'] = connection_args.pop(0)
+                kw["password"] = connection_args.pop(0)
             except IndexError:
                 pass  # password is optional
 
         sentinels = [self._parse_connection(self.re_sent_conn, shost) for shost in connections]
-        display.vv(f'\nUsing redis sentinels: {sentinels}')
+        display.vv(f"\nUsing redis sentinels: {sentinels}")
         scon = Sentinel(sentinels, **kw)
         try:
             return scon.master_for(self._sentinel_service_name, socket_timeout=0.2)
         except Exception as exc:
-            raise AnsibleError(f'Could not connect to redis sentinel: {exc}')
+            raise AnsibleError(f"Could not connect to redis sentinel: {exc}") from exc
 
     def _make_key(self, key):
         return self._prefix + key
 
     def get(self, key):
-
         if key not in self._cache:
             value = self._db.get(self._make_key(key))
             # guard against the key not being removed from the zset;
@@ -187,7 +191,6 @@ class CacheModule(BaseCacheModule):
         return self._cache.get(key)
 
     def set(self, key, value):
-
         value2 = json.dumps(value, cls=AnsibleJSONEncoder, sort_keys=True, indent=4)
         if self._timeout > 0:  # a timeout of 0 is handled as meaning 'never expire'
             self._db.setex(self._make_key(key), int(self._timeout), value2)
@@ -211,7 +214,7 @@ class CacheModule(BaseCacheModule):
 
     def contains(self, key):
         self._expire_keys()
-        return (self._db.zrank(self._keys_set, key) is not None)
+        return self._db.zrank(self._keys_set, key) is not None
 
     def delete(self, key):
         if key in self._cache:

plugins/cache/yaml.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2017, Brian Coca
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -47,9 +46,8 @@ options:
 import os
 
 import yaml
-
-from ansible.parsing.yaml.loader import AnsibleLoader
 from ansible.parsing.yaml.dumper import AnsibleDumper
+from ansible.parsing.yaml.loader import AnsibleLoader
 from ansible.plugins.cache import BaseFileCacheModule
 
 
@@ -59,9 +57,9 @@ class CacheModule(BaseFileCacheModule):
     """
 
     def _load(self, filepath):
-        with open(os.path.abspath(filepath), 'r', encoding='utf-8') as f:
+        with open(os.path.abspath(filepath), encoding="utf-8") as f:
             return AnsibleLoader(f).get_single_data()
 
     def _dump(self, value, filepath):
-        with open(os.path.abspath(filepath), 'w', encoding='utf-8') as f:
+        with open(os.path.abspath(filepath), "w", encoding="utf-8") as f:
             yaml.dump(value, f, Dumper=AnsibleDumper, default_flow_style=False)

plugins/callback/cgroup_memory_recap.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018 Matt Martz <matt@sivel.net>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -42,14 +41,15 @@ options:
         key: cur_mem_file
 """
 
-import time
 import threading
+import time
 
 from ansible.plugins.callback import CallbackBase
 
 
 class MemProf(threading.Thread):
     """Python thread for recording memory usage"""
+
     def __init__(self, path, obj=None):
         threading.Thread.__init__(self)
         self.obj = obj
@@ -67,25 +67,25 @@ class MemProf(threading.Thread):
 
 class CallbackModule(CallbackBase):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'aggregate'
-    CALLBACK_NAME = 'community.general.cgroup_memory_recap'
+    CALLBACK_TYPE = "aggregate"
+    CALLBACK_NAME = "community.general.cgroup_memory_recap"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display)
+        super().__init__(display)
 
         self._task_memprof = None
 
         self.task_results = []
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.cgroup_max_file = self.get_option('max_mem_file')
-        self.cgroup_current_file = self.get_option('cur_mem_file')
+        self.cgroup_max_file = self.get_option("max_mem_file")
+        self.cgroup_current_file = self.get_option("cur_mem_file")
 
-        with open(self.cgroup_max_file, 'w+') as f:
-            f.write('0')
+        with open(self.cgroup_max_file, "w+") as f:
+            f.write("0")
 
     def _profile_memory(self, obj=None):
         prev_task = None
@@ -113,8 +113,8 @@ class CallbackModule(CallbackBase):
         with open(self.cgroup_max_file) as f:
             max_results = int(f.read().strip()) / 1024 / 1024
 
-        self._display.banner('CGROUP MEMORY RECAP')
-        self._display.display(f'Execution Maximum: {max_results:0.2f}MB\n\n')
+        self._display.banner("CGROUP MEMORY RECAP")
+        self._display.display(f"Execution Maximum: {max_results:0.2f}MB\n\n")
 
         for task, memory in self.task_results:
-            self._display.display(f'{task.get_name()} ({task._uuid}): {memory:0.2f}MB')
+            self._display.display(f"{task.get_name()} ({task._uuid}): {memory:0.2f}MB")

plugins/callback/context_demo.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -26,13 +25,14 @@ class CallbackModule(CallbackBase):
     This is a very trivial example of how any callback function can get at play and task objects.
     play will be 'None' for runner invocations, and task will be None for 'setup' invocations.
     """
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'aggregate'
-    CALLBACK_NAME = 'community.general.context_demo'
+    CALLBACK_TYPE = "aggregate"
+    CALLBACK_NAME = "community.general.context_demo"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, *args, **kwargs):
-        super(CallbackModule, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
         self.task = None
         self.play = None
 
@@ -41,11 +41,11 @@ class CallbackModule(CallbackBase):
 
         self._display.display("     --- ARGS ")
         for i, a in enumerate(args):
-            self._display.display(f'     {i}: {a}')
+            self._display.display(f"     {i}: {a}")
 
         self._display.display("      --- KWARGS ")
         for k in kwargs:
-            self._display.display(f'     {k}: {kwargs[k]}')
+            self._display.display(f"     {k}: {kwargs[k]}")
 
     def v2_playbook_on_play_start(self, play):
         self.play = play

plugins/callback/counter_enabled.py

@@ -1,10 +1,9 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Ivan Aragones Muniesa <ivan.aragones.muniesa@gmail.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
-'''
-    Counter enabled Ansible callback plugin (See DOCUMENTATION for more information)
-'''
+"""
+Counter enabled Ansible callback plugin (See DOCUMENTATION for more information)
+"""
 
 from __future__ import annotations
 
@@ -24,21 +23,20 @@ requirements:
 """
 
 from ansible import constants as C
+from ansible.playbook.task_include import TaskInclude
 from ansible.plugins.callback import CallbackBase
 from ansible.utils.color import colorize, hostcolor
-from ansible.playbook.task_include import TaskInclude
 
 
 class CallbackModule(CallbackBase):
-
-    '''
+    """
     This is the default callback interface, which simply prints messages
     to stdout when new callback events are received.
-    '''
+    """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.counter_enabled'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.counter_enabled"
 
     _task_counter = 1
     _task_total = 0
@@ -48,7 +46,7 @@ class CallbackModule(CallbackBase):
     _previous_batch_total = 0
 
     def __init__(self):
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         self._playbook = ""
         self._play = ""
@@ -56,11 +54,7 @@ class CallbackModule(CallbackBase):
     def _all_vars(self, host=None, task=None):
         # host and task need to be specified in case 'magic variables' (host vars, group vars, etc)
         # need to be loaded as well
-        return self._play.get_variable_manager().get_vars(
-            play=self._play,
-            host=host,
-            task=task
-        )
+        return self._play.get_variable_manager().get_vars(play=self._play, host=host, task=task)
 
     def v2_playbook_on_start(self, playbook):
         self._playbook = playbook
@@ -68,7 +62,7 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_play_start(self, play):
         name = play.get_name().strip()
         if not name:
-            msg = u"play"
+            msg = "play"
         else:
             msg = f"PLAY [{name}]"
 
@@ -78,8 +72,8 @@ class CallbackModule(CallbackBase):
         self._play = play
 
         self._previous_batch_total = self._current_batch_total
-        self._current_batch_total = self._previous_batch_total + len(self._all_vars()['vars']['ansible_play_batch'])
-        self._host_total = len(self._all_vars()['vars']['ansible_play_hosts_all'])
+        self._current_batch_total = self._previous_batch_total + len(self._all_vars()["vars"]["ansible_play_batch"])
+        self._host_total = len(self._all_vars()["vars"]["ansible_play_hosts_all"])
         self._task_total = len(self._play.get_tasks()[0])
         self._task_counter = 1
 
@@ -94,39 +88,39 @@ class CallbackModule(CallbackBase):
                 f"{hostcolor(host, stat)} : {colorize('ok', stat['ok'], C.COLOR_OK)} {colorize('changed', stat['changed'], C.COLOR_CHANGED)} "
                 f"{colorize('unreachable', stat['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', stat['failures'], C.COLOR_ERROR)} "
                 f"{colorize('rescued', stat['rescued'], C.COLOR_OK)} {colorize('ignored', stat['ignored'], C.COLOR_WARN)}",
-                screen_only=True
+                screen_only=True,
             )
 
             self._display.display(
                 f"{hostcolor(host, stat, False)} : {colorize('ok', stat['ok'], None)} {colorize('changed', stat['changed'], None)} "
                 f"{colorize('unreachable', stat['unreachable'], None)} {colorize('failed', stat['failures'], None)} "
                 f"{colorize('rescued', stat['rescued'], None)} {colorize('ignored', stat['ignored'], None)}",
-                log_only=True
+                log_only=True,
             )
 
         self._display.display("", screen_only=True)
 
         # print custom stats
-        if self._plugin_options.get('show_custom_stats', C.SHOW_CUSTOM_STATS) and stats.custom:
+        if self._plugin_options.get("show_custom_stats", C.SHOW_CUSTOM_STATS) and stats.custom:
             # fallback on constants for inherited plugins missing docs
             self._display.banner("CUSTOM STATS: ")
             # per host
             # TODO: come up with 'pretty format'
             for k in sorted(stats.custom.keys()):
-                if k == '_run':
+                if k == "_run":
                     continue
-                _custom_stats = self._dump_results(stats.custom[k], indent=1).replace('\n', '')
-                self._display.display(f'\t{k}: {_custom_stats}')
+                _custom_stats = self._dump_results(stats.custom[k], indent=1).replace("\n", "")
+                self._display.display(f"\t{k}: {_custom_stats}")
 
             # print per run custom stats
-            if '_run' in stats.custom:
+            if "_run" in stats.custom:
                 self._display.display("", screen_only=True)
-                _custom_stats_run = self._dump_results(stats.custom['_run'], indent=1).replace('\n', '')
-                self._display.display(f'\tRUN: {_custom_stats_run}')
+                _custom_stats_run = self._dump_results(stats.custom["_run"], indent=1).replace("\n", "")
+                self._display.display(f"\tRUN: {_custom_stats_run}")
             self._display.display("", screen_only=True)
 
     def v2_playbook_on_task_start(self, task, is_conditional):
-        args = ''
+        args = ""
         # args can be specified as no_log in several places: in the task or in
         # the argument spec.  We can check whether the task is no_log but the
         # argument spec can't be because that is only run on the target
@@ -136,8 +130,8 @@ class CallbackModule(CallbackBase):
         # that they can secure this if they feel that their stdout is insecure
         # (shoulder surfing, logging stdout straight to a file, etc).
         if not task.no_log and C.DISPLAY_ARGS_TO_STDOUT:
-            args = ', '.join(('{k}={v}' for k, v in task.args.items()))
-            args = f' {args}'
+            args = ", ".join(("{k}={v}" for k, v in task.args.items()))
+            args = f" {args}"
         self._display.banner(f"TASK {self._task_counter}/{self._task_total} [{task.get_name().strip()}{args}]")
         if self._display.verbosity >= 2:
             path = task.get_path()
@@ -147,23 +141,24 @@ class CallbackModule(CallbackBase):
         self._task_counter += 1
 
     def v2_runner_on_ok(self, result):
-
         self._host_counter += 1
 
-        delegated_vars = result._result.get('_ansible_delegated_vars', None)
+        delegated_vars = result._result.get("_ansible_delegated_vars", None)
 
-        if self._play.strategy == 'free' and self._last_task_banner != result._task._uuid:
+        if self._play.strategy == "free" and self._last_task_banner != result._task._uuid:
             self._print_task_banner(result._task)
 
         if isinstance(result._task, TaskInclude):
             return
-        elif result._result.get('changed', False):
+        elif result._result.get("changed", False):
             if delegated_vars:
                 msg = f"changed: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> {delegated_vars['ansible_host']}]"
             else:
                 msg = f"changed: {self._host_counter}/{self._host_total} [{result._host.get_name()}]"
             color = C.COLOR_CHANGED
         else:
+            if not self._plugin_options.get("display_ok_hosts", True):
+                return
             if delegated_vars:
                 msg = f"ok: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> {delegated_vars['ansible_host']}]"
             else:
@@ -172,7 +167,7 @@ class CallbackModule(CallbackBase):
 
         self._handle_warnings(result._result)
 
-        if result._task.loop and 'results' in result._result:
+        if result._task.loop and "results" in result._result:
             self._process_items(result)
         else:
             self._clean_results(result._result, result._task.action)
@@ -182,19 +177,18 @@ class CallbackModule(CallbackBase):
             self._display.display(msg, color=color)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
-
         self._host_counter += 1
 
-        delegated_vars = result._result.get('_ansible_delegated_vars', None)
+        delegated_vars = result._result.get("_ansible_delegated_vars", None)
         self._clean_results(result._result, result._task.action)
 
-        if self._play.strategy == 'free' and self._last_task_banner != result._task._uuid:
+        if self._play.strategy == "free" and self._last_task_banner != result._task._uuid:
             self._print_task_banner(result._task)
 
         self._handle_exception(result._result)
         self._handle_warnings(result._result)
 
-        if result._task.loop and 'results' in result._result:
+        if result._task.loop and "results" in result._result:
             self._process_items(result)
 
         else:
@@ -202,12 +196,12 @@ class CallbackModule(CallbackBase):
                 self._display.display(
                     f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> "
                     f"{delegated_vars['ansible_host']}]: FAILED! => {self._dump_results(result._result)}",
-                    color=C.COLOR_ERROR
+                    color=C.COLOR_ERROR,
                 )
             else:
                 self._display.display(
                     f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()}]: FAILED! => {self._dump_results(result._result)}",
-                    color=C.COLOR_ERROR
+                    color=C.COLOR_ERROR,
                 )
 
         if ignore_errors:
@@ -216,14 +210,15 @@ class CallbackModule(CallbackBase):
     def v2_runner_on_skipped(self, result):
         self._host_counter += 1
 
-        if self._plugin_options.get('show_skipped_hosts', C.DISPLAY_SKIPPED_HOSTS):  # fallback on constants for inherited plugins missing docs
-
+        if self._plugin_options.get(
+            "show_skipped_hosts", C.DISPLAY_SKIPPED_HOSTS
+        ):  # fallback on constants for inherited plugins missing docs
             self._clean_results(result._result, result._task.action)
 
-            if self._play.strategy == 'free' and self._last_task_banner != result._task._uuid:
+            if self._play.strategy == "free" and self._last_task_banner != result._task._uuid:
                 self._print_task_banner(result._task)
 
-            if result._task.loop and 'results' in result._result:
+            if result._task.loop and "results" in result._result:
                 self._process_items(result)
             else:
                 msg = f"skipping: {self._host_counter}/{self._host_total} [{result._host.get_name()}]"
@@ -234,18 +229,18 @@ class CallbackModule(CallbackBase):
     def v2_runner_on_unreachable(self, result):
         self._host_counter += 1
 
-        if self._play.strategy == 'free' and self._last_task_banner != result._task._uuid:
+        if self._play.strategy == "free" and self._last_task_banner != result._task._uuid:
             self._print_task_banner(result._task)
 
-        delegated_vars = result._result.get('_ansible_delegated_vars', None)
+        delegated_vars = result._result.get("_ansible_delegated_vars", None)
         if delegated_vars:
             self._display.display(
                 f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> "
                 f"{delegated_vars['ansible_host']}]: UNREACHABLE! => {self._dump_results(result._result)}",
-                color=C.COLOR_UNREACHABLE
+                color=C.COLOR_UNREACHABLE,
             )
         else:
             self._display.display(
                 f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()}]: UNREACHABLE! => {self._dump_results(result._result)}",
-                color=C.COLOR_UNREACHABLE
+                color=C.COLOR_UNREACHABLE,
             )

plugins/callback/default_without_diff.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2024, Felix Fontein <felix@fontein.de>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -37,8 +35,8 @@ from ansible.plugins.callback.default import CallbackModule as Default
 
 class CallbackModule(Default):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.default_without_diff'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.default_without_diff"
 
     def v2_on_file_diff(self, result):
         pass

plugins/callback/dense.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2016, Dag Wieers <dag@wieers.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -23,17 +22,18 @@ requirements:
 HAS_OD = False
 try:
     from collections import OrderedDict
+
     HAS_OD = True
 except ImportError:
     pass
 
+import sys
 from collections.abc import MutableMapping, MutableSequence
+
 from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
 from ansible.utils.color import colorize, hostcolor
 from ansible.utils.display import Display
 
-import sys
-
 display = Display()
 
 
@@ -70,66 +70,66 @@ display = Display()
 # FIXME: Importing constants as C simply does not work, beats me :-/
 # from ansible import constants as C
 class C:
-    COLOR_HIGHLIGHT = 'white'
-    COLOR_VERBOSE = 'blue'
-    COLOR_WARN = 'bright purple'
-    COLOR_ERROR = 'red'
-    COLOR_DEBUG = 'dark gray'
-    COLOR_DEPRECATE = 'purple'
-    COLOR_SKIP = 'cyan'
-    COLOR_UNREACHABLE = 'bright red'
-    COLOR_OK = 'green'
-    COLOR_CHANGED = 'yellow'
+    COLOR_HIGHLIGHT = "white"
+    COLOR_VERBOSE = "blue"
+    COLOR_WARN = "bright purple"
+    COLOR_ERROR = "red"
+    COLOR_DEBUG = "dark gray"
+    COLOR_DEPRECATE = "purple"
+    COLOR_SKIP = "cyan"
+    COLOR_UNREACHABLE = "bright red"
+    COLOR_OK = "green"
+    COLOR_CHANGED = "yellow"
 
 
 # Taken from Dstat
 class vt100:
-    black = '\033[0;30m'
-    darkred = '\033[0;31m'
-    darkgreen = '\033[0;32m'
-    darkyellow = '\033[0;33m'
-    darkblue = '\033[0;34m'
-    darkmagenta = '\033[0;35m'
-    darkcyan = '\033[0;36m'
-    gray = '\033[0;37m'
+    black = "\033[0;30m"
+    darkred = "\033[0;31m"
+    darkgreen = "\033[0;32m"
+    darkyellow = "\033[0;33m"
+    darkblue = "\033[0;34m"
+    darkmagenta = "\033[0;35m"
+    darkcyan = "\033[0;36m"
+    gray = "\033[0;37m"
 
-    darkgray = '\033[1;30m'
-    red = '\033[1;31m'
-    green = '\033[1;32m'
-    yellow = '\033[1;33m'
-    blue = '\033[1;34m'
-    magenta = '\033[1;35m'
-    cyan = '\033[1;36m'
-    white = '\033[1;37m'
+    darkgray = "\033[1;30m"
+    red = "\033[1;31m"
+    green = "\033[1;32m"
+    yellow = "\033[1;33m"
+    blue = "\033[1;34m"
+    magenta = "\033[1;35m"
+    cyan = "\033[1;36m"
+    white = "\033[1;37m"
 
-    blackbg = '\033[40m'
-    redbg = '\033[41m'
-    greenbg = '\033[42m'
-    yellowbg = '\033[43m'
-    bluebg = '\033[44m'
-    magentabg = '\033[45m'
-    cyanbg = '\033[46m'
-    whitebg = '\033[47m'
+    blackbg = "\033[40m"
+    redbg = "\033[41m"
+    greenbg = "\033[42m"
+    yellowbg = "\033[43m"
+    bluebg = "\033[44m"
+    magentabg = "\033[45m"
+    cyanbg = "\033[46m"
+    whitebg = "\033[47m"
 
-    reset = '\033[0;0m'
-    bold = '\033[1m'
-    reverse = '\033[2m'
-    underline = '\033[4m'
+    reset = "\033[0;0m"
+    bold = "\033[1m"
+    reverse = "\033[2m"
+    underline = "\033[4m"
 
-    clear = '\033[2J'
-#    clearline = '\033[K'
-    clearline = '\033[2K'
-    save = '\033[s'
-    restore = '\033[u'
-    save_all = '\0337'
-    restore_all = '\0338'
-    linewrap = '\033[7h'
-    nolinewrap = '\033[7l'
+    clear = "\033[2J"
+    #    clearline = '\033[K'
+    clearline = "\033[2K"
+    save = "\033[s"
+    restore = "\033[u"
+    save_all = "\0337"
+    restore_all = "\0338"
+    linewrap = "\033[7h"
+    nolinewrap = "\033[7l"
 
-    up = '\033[1A'
-    down = '\033[1B'
-    right = '\033[1C'
-    left = '\033[1D'
+    up = "\033[1A"
+    down = "\033[1B"
+    right = "\033[1C"
+    left = "\033[1D"
 
 
 colors = dict(
@@ -141,41 +141,38 @@ colors = dict(
     unreachable=vt100.red,
 )
 
-states = ('skipped', 'ok', 'changed', 'failed', 'unreachable')
+states = ("skipped", "ok", "changed", "failed", "unreachable")
 
 
 class CallbackModule(CallbackModule_default):
-
-    '''
+    """
     This is the dense callback interface, where screen estate is still valued.
-    '''
+    """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'dense'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "dense"
 
     def __init__(self):
-
         # From CallbackModule
         self._display = display
 
         if HAS_OD:
-
             self.disabled = False
-            self.super_ref = super(CallbackModule, self)
+            self.super_ref = super()
             self.super_ref.__init__()
 
             # Attributes to remove from results for more density
             self.removed_attributes = (
                 #                'changed',
-                'delta',
+                "delta",
                 #                'diff',
-                'end',
-                'failed',
-                'failed_when_result',
-                'invocation',
-                'start',
-                'stdout_lines',
+                "end",
+                "failed",
+                "failed_when_result",
+                "invocation",
+                "start",
+                "stdout_lines",
             )
 
             # Initiate data structures
@@ -183,13 +180,15 @@ class CallbackModule(CallbackModule_default):
             self.keep = False
             self.shown_title = False
             self.count = dict(play=0, handler=0, task=0)
-            self.type = 'foo'
+            self.type = "foo"
 
             # Start immediately on the first line
             sys.stdout.write(vt100.reset + vt100.save + vt100.clearline)
             sys.stdout.flush()
         else:
-            display.warning("The 'dense' callback plugin requires OrderedDict which is not available in this version of python, disabling.")
+            display.warning(
+                "The 'dense' callback plugin requires OrderedDict which is not available in this version of python, disabling."
+            )
             self.disabled = True
 
     def __del__(self):
@@ -199,27 +198,27 @@ class CallbackModule(CallbackModule_default):
         name = result._host.get_name()
 
         # Add a new status in case a failed task is ignored
-        if status == 'failed' and result._task.ignore_errors:
-            status = 'ignored'
+        if status == "failed" and result._task.ignore_errors:
+            status = "ignored"
 
         # Check if we have to update an existing state (when looping over items)
         if name not in self.hosts:
             self.hosts[name] = dict(state=status)
-        elif states.index(self.hosts[name]['state']) < states.index(status):
-            self.hosts[name]['state'] = status
+        elif states.index(self.hosts[name]["state"]) < states.index(status):
+            self.hosts[name]["state"] = status
 
         # Store delegated hostname, if needed
-        delegated_vars = result._result.get('_ansible_delegated_vars', None)
+        delegated_vars = result._result.get("_ansible_delegated_vars", None)
         if delegated_vars:
-            self.hosts[name]['delegate'] = delegated_vars['ansible_host']
+            self.hosts[name]["delegate"] = delegated_vars["ansible_host"]
 
         # Print progress bar
         self._display_progress(result)
 
-#        # Ensure that tasks with changes/failures stay on-screen, and during diff-mode
-#        if status in ['changed', 'failed', 'unreachable'] or (result.get('_diff_mode', False) and result._resultget('diff', False)):
+        #        # Ensure that tasks with changes/failures stay on-screen, and during diff-mode
+        #        if status in ['changed', 'failed', 'unreachable'] or (result.get('_diff_mode', False) and result._resultget('diff', False)):
         # Ensure that tasks with changes/failures stay on-screen
-        if status in ['changed', 'failed', 'unreachable']:
+        if status in ["changed", "failed", "unreachable"]:
             self.keep = True
 
             if self._display.verbosity == 1:
@@ -240,9 +239,9 @@ class CallbackModule(CallbackModule_default):
                     del result[attr]
 
     def _handle_exceptions(self, result):
-        if 'exception' in result:
+        if "exception" in result:
             # Remove the exception from the result so it is not shown every time
-            del result['exception']
+            del result["exception"]
 
             if self._display.verbosity == 1:
                 return "An exception occurred during task execution. To see the full traceback, use -vvv."
@@ -250,16 +249,16 @@ class CallbackModule(CallbackModule_default):
     def _display_progress(self, result=None):
         # Always rewrite the complete line
         sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.nolinewrap + vt100.underline)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}:')
+        sys.stdout.write(f"{self.type} {self.count[self.type]}:")
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
         # Print out each host in its own status-color
         for name in self.hosts:
-            sys.stdout.write(' ')
-            if self.hosts[name].get('delegate', None):
+            sys.stdout.write(" ")
+            if self.hosts[name].get("delegate", None):
                 sys.stdout.write(f"{self.hosts[name]['delegate']}>")
-            sys.stdout.write(colors[self.hosts[name]['state']] + name + vt100.reset)
+            sys.stdout.write(colors[self.hosts[name]["state"]] + name + vt100.reset)
             sys.stdout.flush()
 
         sys.stdout.write(vt100.linewrap)
@@ -268,7 +267,7 @@ class CallbackModule(CallbackModule_default):
         if not self.shown_title:
             self.shown_title = True
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.underline)
-            sys.stdout.write(f'{self.type} {self.count[self.type]}: {self.task.get_name().strip()}')
+            sys.stdout.write(f"{self.type} {self.count[self.type]}: {self.task.get_name().strip()}")
             sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
             sys.stdout.flush()
         else:
@@ -285,29 +284,31 @@ class CallbackModule(CallbackModule_default):
 
         self._clean_results(result._result)
 
-        dump = ''
-        if result._task.action == 'include':
+        dump = ""
+        if result._task.action == "include":
             return
-        elif status == 'ok':
+        elif status == "ok":
             return
-        elif status == 'ignored':
+        elif status == "ignored":
             dump = self._handle_exceptions(result._result)
-        elif status == 'failed':
+        elif status == "failed":
             dump = self._handle_exceptions(result._result)
-        elif status == 'unreachable':
-            dump = result._result['msg']
+        elif status == "unreachable":
+            dump = result._result["msg"]
 
         if not dump:
             dump = self._dump_results(result._result)
 
-        if result._task.loop and 'results' in result._result:
+        if result._task.loop and "results" in result._result:
             self._process_items(result)
         else:
             sys.stdout.write(f"{colors[status] + status}: ")
 
-            delegated_vars = result._result.get('_ansible_delegated_vars', None)
+            delegated_vars = result._result.get("_ansible_delegated_vars", None)
             if delegated_vars:
-                sys.stdout.write(f"{vt100.reset}{result._host.get_name()}>{colors[status]}{delegated_vars['ansible_host']}")
+                sys.stdout.write(
+                    f"{vt100.reset}{result._host.get_name()}>{colors[status]}{delegated_vars['ansible_host']}"
+                )
             else:
                 sys.stdout.write(result._host.get_name())
 
@@ -315,7 +316,7 @@ class CallbackModule(CallbackModule_default):
             sys.stdout.write(f"{vt100.reset}{vt100.save}{vt100.clearline}")
             sys.stdout.flush()
 
-        if status == 'changed':
+        if status == "changed":
             self._handle_warnings(result._result)
 
     def v2_playbook_on_play_start(self, play):
@@ -328,13 +329,13 @@ class CallbackModule(CallbackModule_default):
         # Reset at the start of each play
         self.keep = False
         self.count.update(dict(handler=0, task=0))
-        self.count['play'] += 1
+        self.count["play"] += 1
         self.play = play
 
         # Write the next play on screen IN UPPERCASE, and make it permanent
         name = play.get_name().strip()
         if not name:
-            name = 'unnamed'
+            name = "unnamed"
         sys.stdout.write(f"PLAY {self.count['play']}: {name.upper()}")
         sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
         sys.stdout.flush()
@@ -352,14 +353,14 @@ class CallbackModule(CallbackModule_default):
         self.shown_title = False
         self.hosts = OrderedDict()
         self.task = task
-        self.type = 'task'
+        self.type = "task"
 
         # Enumerate task if not setup (task names are too long for dense output)
-        if task.get_name() != 'setup':
-            self.count['task'] += 1
+        if task.get_name() != "setup":
+            self.count["task"] += 1
 
         # Write the next task on screen (behind the prompt is the previous output)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}.')
+        sys.stdout.write(f"{self.type} {self.count[self.type]}.")
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
@@ -375,36 +376,36 @@ class CallbackModule(CallbackModule_default):
         self.shown_title = False
         self.hosts = OrderedDict()
         self.task = task
-        self.type = 'handler'
+        self.type = "handler"
 
         # Enumerate handler if not setup (handler names may be too long for dense output)
-        if task.get_name() != 'setup':
+        if task.get_name() != "setup":
             self.count[self.type] += 1
 
         # Write the next task on screen (behind the prompt is the previous output)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}.')
+        sys.stdout.write(f"{self.type} {self.count[self.type]}.")
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
     def v2_playbook_on_cleanup_task_start(self, task):
         # TBD
-        sys.stdout.write('cleanup.')
+        sys.stdout.write("cleanup.")
         sys.stdout.flush()
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
-        self._add_host(result, 'failed')
+        self._add_host(result, "failed")
 
     def v2_runner_on_ok(self, result):
-        if result._result.get('changed', False):
-            self._add_host(result, 'changed')
+        if result._result.get("changed", False):
+            self._add_host(result, "changed")
         else:
-            self._add_host(result, 'ok')
+            self._add_host(result, "ok")
 
     def v2_runner_on_skipped(self, result):
-        self._add_host(result, 'skipped')
+        self._add_host(result, "skipped")
 
     def v2_runner_on_unreachable(self, result):
-        self._add_host(result, 'unreachable')
+        self._add_host(result, "unreachable")
 
     def v2_runner_on_include(self, included_file):
         pass
@@ -424,24 +425,24 @@ class CallbackModule(CallbackModule_default):
         self.v2_runner_item_on_ok(result)
 
     def v2_runner_item_on_ok(self, result):
-        if result._result.get('changed', False):
-            self._add_host(result, 'changed')
+        if result._result.get("changed", False):
+            self._add_host(result, "changed")
         else:
-            self._add_host(result, 'ok')
+            self._add_host(result, "ok")
 
     # Old definition in v2.0
     def v2_playbook_item_on_failed(self, result):
         self.v2_runner_item_on_failed(result)
 
     def v2_runner_item_on_failed(self, result):
-        self._add_host(result, 'failed')
+        self._add_host(result, "failed")
 
     # Old definition in v2.0
     def v2_playbook_item_on_skipped(self, result):
         self.v2_runner_item_on_skipped(result)
 
     def v2_runner_item_on_skipped(self, result):
-        self._add_host(result, 'skipped')
+        self._add_host(result, "skipped")
 
     def v2_playbook_on_no_hosts_remaining(self):
         if self._display.verbosity == 0 and self.keep:
@@ -468,7 +469,7 @@ class CallbackModule(CallbackModule_default):
             return
 
         sys.stdout.write(vt100.bold + vt100.underline)
-        sys.stdout.write('SUMMARY')
+        sys.stdout.write("SUMMARY")
 
         sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
         sys.stdout.flush()
@@ -480,10 +481,10 @@ class CallbackModule(CallbackModule_default):
                 f"{hostcolor(h, t)} : {colorize('ok', t['ok'], C.COLOR_OK)} {colorize('changed', t['changed'], C.COLOR_CHANGED)} "
                 f"{colorize('unreachable', t['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', t['failures'], C.COLOR_ERROR)} "
                 f"{colorize('rescued', t['rescued'], C.COLOR_OK)} {colorize('ignored', t['ignored'], C.COLOR_WARN)}",
-                screen_only=True
+                screen_only=True,
             )
 
 
 # When using -vv or higher, simply do the default action
 if display.verbosity >= 2 or not HAS_OD:
-    CallbackModule = CallbackModule_default
+    CallbackModule = CallbackModule_default  # type: ignore

plugins/callback/diy.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2019, Trevor Highfill <trevor.highfill@outlook.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -780,19 +778,21 @@ playbook.yml: >-
 
 import sys
 from contextlib import contextmanager
+
+from ansible.module_utils.common.text.converters import to_text
+from ansible.plugins.callback.default import CallbackModule as Default
 from ansible.template import Templar
 from ansible.vars.manager import VariableManager
-from ansible.plugins.callback.default import CallbackModule as Default
-from ansible.module_utils.common.text.converters import to_text
 
 try:
     from ansible.template import trust_as_template  # noqa: F401, pylint: disable=unused-import
+
     SUPPORTS_DATA_TAGGING = True
 except ImportError:
     SUPPORTS_DATA_TAGGING = False
 
 
-class DummyStdout(object):
+class DummyStdout:
     def flush(self):
         pass
 
@@ -807,11 +807,12 @@ class CallbackModule(Default):
     """
     Callback plugin that allows you to supply your own custom callback templates to be output.
     """
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.diy'
 
-    DIY_NS = 'ansible_callback_diy'
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.diy"
+
+    DIY_NS = "ansible_callback_diy"
 
     @contextmanager
     def _suppress_stdout(self, enabled):
@@ -824,50 +825,48 @@ class CallbackModule(Default):
     def _get_output_specification(self, loader, variables):
         _ret = {}
         _calling_method = sys._getframe(1).f_code.co_name
-        _callback_type = (_calling_method[3:] if _calling_method[:3] == "v2_" else _calling_method)
-        _callback_options = ['msg', 'msg_color']
+        _callback_type = _calling_method[3:] if _calling_method[:3] == "v2_" else _calling_method
+        _callback_options = ["msg", "msg_color"]
 
         for option in _callback_options:
-            _option_name = f'{_callback_type}_{option}'
-            _option_template = variables.get(
-                f"{self.DIY_NS}_{_option_name}",
-                self.get_option(_option_name)
-            )
-            _ret.update({option: self._template(
-                loader=loader,
-                template=_option_template,
-                variables=variables
-            )})
+            _option_name = f"{_callback_type}_{option}"
+            _option_template = variables.get(f"{self.DIY_NS}_{_option_name}", self.get_option(_option_name))
+            _ret.update({option: self._template(loader=loader, template=_option_template, variables=variables)})
 
-        _ret.update({'vars': variables})
+        _ret.update({"vars": variables})
 
         return _ret
 
     def _using_diy(self, spec):
         sentinel = object()
-        omit = spec['vars'].get('omit', sentinel)
+        omit = spec["vars"].get("omit", sentinel)
         # With Data Tagging, omit is sentinel
-        return (spec['msg'] is not None) and (spec['msg'] != omit or omit is sentinel)
+        return (spec["msg"] is not None) and (spec["msg"] != omit or omit is sentinel)
 
     def _parent_has_callback(self):
-        return hasattr(super(CallbackModule, self), sys._getframe(1).f_code.co_name)
+        return hasattr(super(), sys._getframe(1).f_code.co_name)
 
     def _template(self, loader, template, variables):
         _templar = Templar(loader=loader, variables=variables)
-        return _templar.template(
-            template,
-            preserve_trailing_newlines=True,
-            convert_data=False,
-            escape_backslashes=True
-        )
+        return _templar.template(template, preserve_trailing_newlines=True, convert_data=False, escape_backslashes=True)
 
     def _output(self, spec, stderr=False):
-        _msg = to_text(spec['msg'])
+        _msg = to_text(spec["msg"])
         if len(_msg) > 0:
-            self._display.display(msg=_msg, color=spec['msg_color'], stderr=stderr)
+            self._display.display(msg=_msg, color=spec["msg_color"], stderr=stderr)
 
-    def _get_vars(self, playbook, play=None, host=None, task=None, included_file=None,
-                  handler=None, result=None, stats=None, remove_attr_ref_loop=True):
+    def _get_vars(
+        self,
+        playbook,
+        play=None,
+        host=None,
+        task=None,
+        included_file=None,
+        handler=None,
+        result=None,
+        stats=None,
+        remove_attr_ref_loop=True,
+    ):
         def _get_value(obj, attr=None, method=None):
             if attr:
                 return getattr(obj, attr, getattr(obj, f"_{attr}", None))
@@ -877,8 +876,8 @@ class CallbackModule(Default):
                 return _method()
 
         def _remove_attr_ref_loop(obj, attributes):
-            _loop_var = getattr(obj, 'loop_control', None)
-            _loop_var = (_loop_var or 'item')
+            _loop_var = getattr(obj, "loop_control", None)
+            _loop_var = _loop_var or "item"
 
             for attr in attributes:
                 if str(_loop_var) in str(_get_value(obj=obj, attr=attr)):
@@ -897,56 +896,128 @@ class CallbackModule(Default):
         _all = _variable_manager.get_vars()
         if play:
             _all = play.get_variable_manager().get_vars(
-                play=play,
-                host=(host if host else getattr(result, '_host', None)),
-                task=(handler if handler else task)
+                play=play, host=(host if host else getattr(result, "_host", None)), task=(handler if handler else task)
             )
         _ret.update(_all)
 
         _ret.update(_ret.get(self.DIY_NS, {self.DIY_NS: {} if SUPPORTS_DATA_TAGGING else CallbackDIYDict()}))
 
-        _ret[self.DIY_NS].update({'playbook': {}})
-        _playbook_attributes = ['entries', 'file_name', 'basedir']
+        _ret[self.DIY_NS].update({"playbook": {}})
+        _playbook_attributes = ["entries", "file_name", "basedir"]
 
         for attr in _playbook_attributes:
-            _ret[self.DIY_NS]['playbook'].update({attr: _get_value(obj=playbook, attr=attr)})
+            _ret[self.DIY_NS]["playbook"].update({attr: _get_value(obj=playbook, attr=attr)})
 
         if play:
-            _ret[self.DIY_NS].update({'play': {}})
-            _play_attributes = ['any_errors_fatal', 'become', 'become_flags', 'become_method',
-                                'become_user', 'check_mode', 'collections', 'connection',
-                                'debugger', 'diff', 'environment', 'fact_path', 'finalized',
-                                'force_handlers', 'gather_facts', 'gather_subset',
-                                'gather_timeout', 'handlers', 'hosts', 'ignore_errors',
-                                'ignore_unreachable', 'included_conditional', 'included_path',
-                                'max_fail_percentage', 'module_defaults', 'name', 'no_log',
-                                'only_tags', 'order', 'port', 'post_tasks', 'pre_tasks',
-                                'remote_user', 'removed_hosts', 'roles', 'run_once', 'serial',
-                                'skip_tags', 'squashed', 'strategy', 'tags', 'tasks', 'uuid',
-                                'validated', 'vars_files', 'vars_prompt']
+            _ret[self.DIY_NS].update({"play": {}})
+            _play_attributes = [
+                "any_errors_fatal",
+                "become",
+                "become_flags",
+                "become_method",
+                "become_user",
+                "check_mode",
+                "collections",
+                "connection",
+                "debugger",
+                "diff",
+                "environment",
+                "fact_path",
+                "finalized",
+                "force_handlers",
+                "gather_facts",
+                "gather_subset",
+                "gather_timeout",
+                "handlers",
+                "hosts",
+                "ignore_errors",
+                "ignore_unreachable",
+                "included_conditional",
+                "included_path",
+                "max_fail_percentage",
+                "module_defaults",
+                "name",
+                "no_log",
+                "only_tags",
+                "order",
+                "port",
+                "post_tasks",
+                "pre_tasks",
+                "remote_user",
+                "removed_hosts",
+                "roles",
+                "run_once",
+                "serial",
+                "skip_tags",
+                "squashed",
+                "strategy",
+                "tags",
+                "tasks",
+                "uuid",
+                "validated",
+                "vars_files",
+                "vars_prompt",
+            ]
 
             for attr in _play_attributes:
-                _ret[self.DIY_NS]['play'].update({attr: _get_value(obj=play, attr=attr)})
+                _ret[self.DIY_NS]["play"].update({attr: _get_value(obj=play, attr=attr)})
 
         if host:
-            _ret[self.DIY_NS].update({'host': {}})
-            _host_attributes = ['name', 'uuid', 'address', 'implicit']
+            _ret[self.DIY_NS].update({"host": {}})
+            _host_attributes = ["name", "uuid", "address", "implicit"]
 
             for attr in _host_attributes:
-                _ret[self.DIY_NS]['host'].update({attr: _get_value(obj=host, attr=attr)})
+                _ret[self.DIY_NS]["host"].update({attr: _get_value(obj=host, attr=attr)})
 
         if task:
-            _ret[self.DIY_NS].update({'task': {}})
-            _task_attributes = ['action', 'any_errors_fatal', 'args', 'async', 'async_val',
-                                'become', 'become_flags', 'become_method', 'become_user',
-                                'changed_when', 'check_mode', 'collections', 'connection',
-                                'debugger', 'delay', 'delegate_facts', 'delegate_to', 'diff',
-                                'environment', 'failed_when', 'finalized', 'ignore_errors',
-                                'ignore_unreachable', 'loop', 'loop_control', 'loop_with',
-                                'module_defaults', 'name', 'no_log', 'notify', 'parent', 'poll',
-                                'port', 'register', 'remote_user', 'retries', 'role', 'run_once',
-                                'squashed', 'tags', 'untagged', 'until', 'uuid', 'validated',
-                                'when']
+            _ret[self.DIY_NS].update({"task": {}})
+            _task_attributes = [
+                "action",
+                "any_errors_fatal",
+                "args",
+                "async",
+                "async_val",
+                "become",
+                "become_flags",
+                "become_method",
+                "become_user",
+                "changed_when",
+                "check_mode",
+                "collections",
+                "connection",
+                "debugger",
+                "delay",
+                "delegate_facts",
+                "delegate_to",
+                "diff",
+                "environment",
+                "failed_when",
+                "finalized",
+                "ignore_errors",
+                "ignore_unreachable",
+                "loop",
+                "loop_control",
+                "loop_with",
+                "module_defaults",
+                "name",
+                "no_log",
+                "notify",
+                "parent",
+                "poll",
+                "port",
+                "register",
+                "remote_user",
+                "retries",
+                "role",
+                "run_once",
+                "squashed",
+                "tags",
+                "untagged",
+                "until",
+                "uuid",
+                "validated",
+                "when",
+            ]
 
             # remove arguments that reference a loop var because they cause templating issues in
             # callbacks that do not have the loop context(e.g. playbook_on_task_start)
@@ -954,91 +1025,128 @@ class CallbackModule(Default):
                 _task_attributes = _remove_attr_ref_loop(obj=task, attributes=_task_attributes)
 
             for attr in _task_attributes:
-                _ret[self.DIY_NS]['task'].update({attr: _get_value(obj=task, attr=attr)})
+                _ret[self.DIY_NS]["task"].update({attr: _get_value(obj=task, attr=attr)})
 
         if included_file:
-            _ret[self.DIY_NS].update({'included_file': {}})
-            _included_file_attributes = ['args', 'filename', 'hosts', 'is_role', 'task']
+            _ret[self.DIY_NS].update({"included_file": {}})
+            _included_file_attributes = ["args", "filename", "hosts", "is_role", "task"]
 
             for attr in _included_file_attributes:
-                _ret[self.DIY_NS]['included_file'].update({attr: _get_value(
-                    obj=included_file,
-                    attr=attr
-                )})
+                _ret[self.DIY_NS]["included_file"].update({attr: _get_value(obj=included_file, attr=attr)})
 
         if handler:
-            _ret[self.DIY_NS].update({'handler': {}})
-            _handler_attributes = ['action', 'any_errors_fatal', 'args', 'async', 'async_val',
-                                   'become', 'become_flags', 'become_method', 'become_user',
-                                   'changed_when', 'check_mode', 'collections', 'connection',
-                                   'debugger', 'delay', 'delegate_facts', 'delegate_to', 'diff',
-                                   'environment', 'failed_when', 'finalized', 'ignore_errors',
-                                   'ignore_unreachable', 'listen', 'loop', 'loop_control',
-                                   'loop_with', 'module_defaults', 'name', 'no_log',
-                                   'notified_hosts', 'notify', 'parent', 'poll', 'port',
-                                   'register', 'remote_user', 'retries', 'role', 'run_once',
-                                   'squashed', 'tags', 'untagged', 'until', 'uuid', 'validated',
-                                   'when']
+            _ret[self.DIY_NS].update({"handler": {}})
+            _handler_attributes = [
+                "action",
+                "any_errors_fatal",
+                "args",
+                "async",
+                "async_val",
+                "become",
+                "become_flags",
+                "become_method",
+                "become_user",
+                "changed_when",
+                "check_mode",
+                "collections",
+                "connection",
+                "debugger",
+                "delay",
+                "delegate_facts",
+                "delegate_to",
+                "diff",
+                "environment",
+                "failed_when",
+                "finalized",
+                "ignore_errors",
+                "ignore_unreachable",
+                "listen",
+                "loop",
+                "loop_control",
+                "loop_with",
+                "module_defaults",
+                "name",
+                "no_log",
+                "notified_hosts",
+                "notify",
+                "parent",
+                "poll",
+                "port",
+                "register",
+                "remote_user",
+                "retries",
+                "role",
+                "run_once",
+                "squashed",
+                "tags",
+                "untagged",
+                "until",
+                "uuid",
+                "validated",
+                "when",
+            ]
 
             if handler.loop and remove_attr_ref_loop:
-                _handler_attributes = _remove_attr_ref_loop(obj=handler,
-                                                            attributes=_handler_attributes)
+                _handler_attributes = _remove_attr_ref_loop(obj=handler, attributes=_handler_attributes)
 
             for attr in _handler_attributes:
-                _ret[self.DIY_NS]['handler'].update({attr: _get_value(obj=handler, attr=attr)})
+                _ret[self.DIY_NS]["handler"].update({attr: _get_value(obj=handler, attr=attr)})
 
-            _ret[self.DIY_NS]['handler'].update({'is_host_notified': handler.is_host_notified(host)})
+            _ret[self.DIY_NS]["handler"].update({"is_host_notified": handler.is_host_notified(host)})
 
         if result:
-            _ret[self.DIY_NS].update({'result': {}})
-            _result_attributes = ['host', 'task', 'task_name']
+            _ret[self.DIY_NS].update({"result": {}})
+            _result_attributes = ["host", "task", "task_name"]
 
             for attr in _result_attributes:
-                _ret[self.DIY_NS]['result'].update({attr: _get_value(obj=result, attr=attr)})
+                _ret[self.DIY_NS]["result"].update({attr: _get_value(obj=result, attr=attr)})
 
-            _result_methods = ['is_changed', 'is_failed', 'is_skipped', 'is_unreachable']
+            _result_methods = ["is_changed", "is_failed", "is_skipped", "is_unreachable"]
 
             for method in _result_methods:
-                _ret[self.DIY_NS]['result'].update({method: _get_value(obj=result, method=method)})
+                _ret[self.DIY_NS]["result"].update({method: _get_value(obj=result, method=method)})
 
-            _ret[self.DIY_NS]['result'].update({'output': getattr(result, '_result', None)})
+            _ret[self.DIY_NS]["result"].update({"output": getattr(result, "_result", None)})
 
             _ret.update(result._result)
 
         if stats:
-            _ret[self.DIY_NS].update({'stats': {}})
-            _stats_attributes = ['changed', 'custom', 'dark', 'failures', 'ignored',
-                                 'ok', 'processed', 'rescued', 'skipped']
+            _ret[self.DIY_NS].update({"stats": {}})
+            _stats_attributes = [
+                "changed",
+                "custom",
+                "dark",
+                "failures",
+                "ignored",
+                "ok",
+                "processed",
+                "rescued",
+                "skipped",
+            ]
 
             for attr in _stats_attributes:
-                _ret[self.DIY_NS]['stats'].update({attr: _get_value(obj=stats, attr=attr)})
+                _ret[self.DIY_NS]["stats"].update({attr: _get_value(obj=stats, attr=attr)})
 
-        _ret[self.DIY_NS].update({'top_level_var_names': list(_ret.keys())})
+        _ret[self.DIY_NS].update({"top_level_var_names": list(_ret.keys())})
 
         return _ret
 
     def v2_on_any(self, *args, **kwargs):
-        self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._diy_spec['vars']
-        )
+        self._diy_spec = self._get_output_specification(loader=self._diy_loader, variables=self._diy_spec["vars"])
 
         if self._using_diy(spec=self._diy_spec):
             self._output(spec=self._diy_spec)
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_on_any(*args, **kwargs)
+                super().v2_on_any(*args, **kwargs)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1046,17 +1154,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_on_failed(result, ignore_errors)
+                super().v2_runner_on_failed(result, ignore_errors)
 
     def v2_runner_on_ok(self, result):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1064,17 +1169,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_on_ok(result)
+                super().v2_runner_on_ok(result)
 
     def v2_runner_on_skipped(self, result):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1082,17 +1184,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_on_skipped(result)
+                super().v2_runner_on_skipped(result)
 
     def v2_runner_on_unreachable(self, result):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1100,7 +1199,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_on_unreachable(result)
+                super().v2_runner_on_unreachable(result)
 
     # not implemented as the call to this is not implemented yet
     def v2_runner_on_async_poll(self, result):
@@ -1122,8 +1221,8 @@ class CallbackModule(Default):
                 play=self._diy_play,
                 task=self._diy_task,
                 result=result,
-                remove_attr_ref_loop=False
-            )
+                remove_attr_ref_loop=False,
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1131,7 +1230,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_item_on_ok(result)
+                super().v2_runner_item_on_ok(result)
 
     def v2_runner_item_on_failed(self, result):
         self._diy_spec = self._get_output_specification(
@@ -1141,8 +1240,8 @@ class CallbackModule(Default):
                 play=self._diy_play,
                 task=self._diy_task,
                 result=result,
-                remove_attr_ref_loop=False
-            )
+                remove_attr_ref_loop=False,
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1150,7 +1249,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_item_on_failed(result)
+                super().v2_runner_item_on_failed(result)
 
     def v2_runner_item_on_skipped(self, result):
         self._diy_spec = self._get_output_specification(
@@ -1160,8 +1259,8 @@ class CallbackModule(Default):
                 play=self._diy_play,
                 task=self._diy_task,
                 result=result,
-                remove_attr_ref_loop=False
-            )
+                remove_attr_ref_loop=False,
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1169,17 +1268,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_item_on_skipped(result)
+                super().v2_runner_item_on_skipped(result)
 
     def v2_runner_retry(self, result):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1187,7 +1283,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_retry(result)
+                super().v2_runner_retry(result)
 
     def v2_runner_on_start(self, host, task):
         self._diy_host = host
@@ -1196,11 +1292,8 @@ class CallbackModule(Default):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                host=self._diy_host,
-                task=self._diy_task
-            )
+                playbook=self._diy_playbook, play=self._diy_play, host=self._diy_host, task=self._diy_task
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1208,17 +1301,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_runner_on_start(host, task)
+                super().v2_runner_on_start(host, task)
 
     def v2_playbook_on_start(self, playbook):
         self._diy_playbook = playbook
         self._diy_loader = self._diy_playbook.get_loader()
 
         self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._get_vars(
-                playbook=self._diy_playbook
-            )
+            loader=self._diy_loader, variables=self._get_vars(playbook=self._diy_playbook)
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1226,7 +1316,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_start(playbook)
+                super().v2_playbook_on_start(playbook)
 
     def v2_playbook_on_notify(self, handler, host):
         self._diy_handler = handler
@@ -1235,11 +1325,8 @@ class CallbackModule(Default):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                host=self._diy_host,
-                handler=self._diy_handler
-            )
+                playbook=self._diy_playbook, play=self._diy_play, host=self._diy_host, handler=self._diy_handler
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1247,44 +1334,34 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_notify(handler, host)
+                super().v2_playbook_on_notify(handler, host)
 
     def v2_playbook_on_no_hosts_matched(self):
-        self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._diy_spec['vars']
-        )
+        self._diy_spec = self._get_output_specification(loader=self._diy_loader, variables=self._diy_spec["vars"])
 
         if self._using_diy(spec=self._diy_spec):
             self._output(spec=self._diy_spec)
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_no_hosts_matched()
+                super().v2_playbook_on_no_hosts_matched()
 
     def v2_playbook_on_no_hosts_remaining(self):
-        self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._diy_spec['vars']
-        )
+        self._diy_spec = self._get_output_specification(loader=self._diy_loader, variables=self._diy_spec["vars"])
 
         if self._using_diy(spec=self._diy_spec):
             self._output(spec=self._diy_spec)
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_no_hosts_remaining()
+                super().v2_playbook_on_no_hosts_remaining()
 
     def v2_playbook_on_task_start(self, task, is_conditional):
         self._diy_task = task
 
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
-            variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task
-            )
+            variables=self._get_vars(playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1292,7 +1369,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_task_start(task, is_conditional)
+                super().v2_playbook_on_task_start(task, is_conditional)
 
     # not implemented as the call to this is not implemented yet
     def v2_playbook_on_cleanup_task_start(self, task):
@@ -1303,11 +1380,7 @@ class CallbackModule(Default):
 
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
-            variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task
-            )
+            variables=self._get_vars(playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1315,25 +1388,29 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_handler_task_start(task)
+                super().v2_playbook_on_handler_task_start(task)
 
-    def v2_playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None,
-                                   confirm=False, salt_size=None, salt=None, default=None,
-                                   unsafe=None):
-        self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._diy_spec['vars']
-        )
+    def v2_playbook_on_vars_prompt(
+        self,
+        varname,
+        private=True,
+        prompt=None,
+        encrypt=None,
+        confirm=False,
+        salt_size=None,
+        salt=None,
+        default=None,
+        unsafe=None,
+    ):
+        self._diy_spec = self._get_output_specification(loader=self._diy_loader, variables=self._diy_spec["vars"])
 
         if self._using_diy(spec=self._diy_spec):
             self._output(spec=self._diy_spec)
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_vars_prompt(
-                    varname, private, prompt, encrypt,
-                    confirm, salt_size, salt, default,
-                    unsafe
+                super().v2_playbook_on_vars_prompt(
+                    varname, private, prompt, encrypt, confirm, salt_size, salt, default, unsafe
                 )
 
     # not implemented as the call to this is not implemented yet
@@ -1348,11 +1425,7 @@ class CallbackModule(Default):
         self._diy_play = play
 
         self._diy_spec = self._get_output_specification(
-            loader=self._diy_loader,
-            variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play
-            )
+            loader=self._diy_loader, variables=self._get_vars(playbook=self._diy_playbook, play=self._diy_play)
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1360,18 +1433,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_play_start(play)
+                super().v2_playbook_on_play_start(play)
 
     def v2_playbook_on_stats(self, stats):
         self._diy_stats = stats
 
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
-            variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                stats=self._diy_stats
-            )
+            variables=self._get_vars(playbook=self._diy_playbook, play=self._diy_play, stats=self._diy_stats),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1379,7 +1448,7 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_stats(stats)
+                super().v2_playbook_on_stats(stats)
 
     def v2_playbook_on_include(self, included_file):
         self._diy_included_file = included_file
@@ -1390,8 +1459,8 @@ class CallbackModule(Default):
                 playbook=self._diy_playbook,
                 play=self._diy_play,
                 task=self._diy_included_file._task,
-                included_file=self._diy_included_file
-            )
+                included_file=self._diy_included_file,
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1399,17 +1468,14 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_playbook_on_include(included_file)
+                super().v2_playbook_on_include(included_file)
 
     def v2_on_file_diff(self, result):
         self._diy_spec = self._get_output_specification(
             loader=self._diy_loader,
             variables=self._get_vars(
-                playbook=self._diy_playbook,
-                play=self._diy_play,
-                task=self._diy_task,
-                result=result
-            )
+                playbook=self._diy_playbook, play=self._diy_play, task=self._diy_task, result=result
+            ),
         )
 
         if self._using_diy(spec=self._diy_spec):
@@ -1417,4 +1483,4 @@ class CallbackModule(Default):
 
         if self._parent_has_callback():
             with self._suppress_stdout(enabled=self._using_diy(spec=self._diy_spec)):
-                super(CallbackModule, self).v2_on_file_diff(result)
+                super().v2_on_file_diff(result)

plugins/callback/elastic.py

@@ -81,7 +81,6 @@ import getpass
 import socket
 import time
 import uuid
-
 from collections import OrderedDict
 from contextlib import closing
 from os.path import basename
@@ -90,8 +89,9 @@ from ansible.errors import AnsibleError, AnsibleRuntimeError
 from ansible.module_utils.ansible_release import __version__ as ansible_version
 from ansible.plugins.callback import CallbackBase
 
+ELASTIC_LIBRARY_IMPORT_ERROR: ImportError | None
 try:
-    from elasticapm import Client, capture_span, trace_parent_from_string, instrument, label
+    from elasticapm import Client, capture_span, instrument, label, trace_parent_from_string
 except ImportError as imp_exc:
     ELASTIC_LIBRARY_IMPORT_ERROR = imp_exc
 else:
@@ -115,9 +115,9 @@ class TaskData:
 
     def add_host(self, host):
         if host.uuid in self.host_data:
-            if host.status == 'included':
+            if host.status == "included":
                 # concatenate task include output from multiple items
-                host.result = f'{self.host_data[host.uuid].result}\n{host.result}'
+                host.result = f"{self.host_data[host.uuid].result}\n{host.result}"
             else:
                 return
 
@@ -137,21 +137,21 @@ class HostData:
         self.finish = time.time()
 
 
-class ElasticSource(object):
+class ElasticSource:
     def __init__(self, display):
         self.ansible_playbook = ""
         self.session = str(uuid.uuid4())
         self.host = socket.gethostname()
         try:
             self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
+        except Exception:
             self.ip_address = None
         self.user = getpass.getuser()
 
         self._display = display
 
     def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
+        """record the start of a task for one or more hosts"""
 
         uuid = task._uuid
 
@@ -164,38 +164,50 @@ class ElasticSource(object):
         args = None
 
         if not task.no_log and not hide_task_arguments:
-            args = ', '.join((f'{k}={v}' for k, v in task.args.items()))
+            args = ", ".join((f"{k}={v}" for k, v in task.args.items()))
 
         tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
 
     def finish_task(self, tasks_data, status, result):
-        """ record the results of a task for a single host """
+        """record the results of a task for a single host"""
 
         task_uuid = result._task._uuid
 
-        if hasattr(result, '_host') and result._host is not None:
+        if hasattr(result, "_host") and result._host is not None:
             host_uuid = result._host._uuid
             host_name = result._host.name
         else:
-            host_uuid = 'include'
-            host_name = 'include'
+            host_uuid = "include"
+            host_name = "include"
 
         task = tasks_data[task_uuid]
 
         task.add_host(HostData(host_uuid, host_name, status, result))
 
-    def generate_distributed_traces(self, tasks_data, status, end_time, traceparent, apm_service_name,
-                                    apm_server_url, apm_verify_server_cert, apm_secret_token, apm_api_key):
-        """ generate distributed traces from the collected TaskData and HostData """
+    def generate_distributed_traces(
+        self,
+        tasks_data,
+        status,
+        end_time,
+        traceparent,
+        apm_service_name,
+        apm_server_url,
+        apm_verify_server_cert,
+        apm_secret_token,
+        apm_api_key,
+    ):
+        """generate distributed traces from the collected TaskData and HostData"""
 
         tasks = []
         parent_start_time = None
-        for task_uuid, task in tasks_data.items():
+        for task in tasks_data.values():
             if parent_start_time is None:
                 parent_start_time = task.start
             tasks.append(task)
 
-        apm_cli = self.init_apm_client(apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key)
+        apm_cli = self.init_apm_client(
+            apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key
+        )
         if apm_cli:
             with closing(apm_cli):
                 instrument()  # Only call this once, as early as possible.
@@ -211,78 +223,86 @@ class ElasticSource(object):
                     label(ansible_host_ip=self.ip_address)
 
                 for task_data in tasks:
-                    for host_uuid, host_data in task_data.host_data.items():
+                    for host_data in task_data.host_data.values():
                         self.create_span_data(apm_cli, task_data, host_data)
 
                 apm_cli.end_transaction(name=__name__, result=status, duration=end_time - parent_start_time)
 
     def create_span_data(self, apm_cli, task_data, host_data):
-        """ create the span with the given TaskData and HostData """
+        """create the span with the given TaskData and HostData"""
 
-        name = f'[{host_data.name}] {task_data.play}: {task_data.name}'
+        name = f"[{host_data.name}] {task_data.play}: {task_data.name}"
 
         message = "success"
         status = "success"
         enriched_error_message = None
-        if host_data.status == 'included':
+        if host_data.status == "included":
             rc = 0
         else:
             res = host_data.result._result
-            rc = res.get('rc', 0)
-            if host_data.status == 'failed':
+            rc = res.get("rc", 0)
+            if host_data.status == "failed":
                 message = self.get_error_message(res)
                 enriched_error_message = self.enrich_error_message(res)
                 status = "failure"
-            elif host_data.status == 'skipped':
-                if 'skip_reason' in res:
-                    message = res['skip_reason']
+            elif host_data.status == "skipped":
+                if "skip_reason" in res:
+                    message = res["skip_reason"]
                 else:
-                    message = 'skipped'
+                    message = "skipped"
                 status = "unknown"
 
-        with capture_span(task_data.name,
-                          start=task_data.start,
-                          span_type="ansible.task.run",
-                          duration=host_data.finish - task_data.start,
-                          labels={"ansible.task.args": task_data.args,
-                                  "ansible.task.message": message,
-                                  "ansible.task.module": task_data.action,
-                                  "ansible.task.name": name,
-                                  "ansible.task.result": rc,
-                                  "ansible.task.host.name": host_data.name,
-                                  "ansible.task.host.status": host_data.status}) as span:
+        with capture_span(
+            task_data.name,
+            start=task_data.start,
+            span_type="ansible.task.run",
+            duration=host_data.finish - task_data.start,
+            labels={
+                "ansible.task.args": task_data.args,
+                "ansible.task.message": message,
+                "ansible.task.module": task_data.action,
+                "ansible.task.name": name,
+                "ansible.task.result": rc,
+                "ansible.task.host.name": host_data.name,
+                "ansible.task.host.status": host_data.status,
+            },
+        ) as span:
             span.outcome = status
-            if 'failure' in status:
-                exception = AnsibleRuntimeError(message=f"{task_data.action}: {name} failed with error message {enriched_error_message}")
+            if "failure" in status:
+                exception = AnsibleRuntimeError(
+                    message=f"{task_data.action}: {name} failed with error message {enriched_error_message}"
+                )
                 apm_cli.capture_exception(exc_info=(type(exception), exception, exception.__traceback__), handled=True)
 
     def init_apm_client(self, apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key):
         if apm_server_url:
-            return Client(service_name=apm_service_name,
-                          server_url=apm_server_url,
-                          verify_server_cert=False,
-                          secret_token=apm_secret_token,
-                          api_key=apm_api_key,
-                          use_elastic_traceparent_header=True,
-                          debug=True)
+            return Client(
+                service_name=apm_service_name,
+                server_url=apm_server_url,
+                verify_server_cert=False,
+                secret_token=apm_secret_token,
+                api_key=apm_api_key,
+                use_elastic_traceparent_header=True,
+                debug=True,
+            )
 
     @staticmethod
     def get_error_message(result):
-        if result.get('exception') is not None:
-            return ElasticSource._last_line(result['exception'])
-        return result.get('msg', 'failed')
+        if result.get("exception") is not None:
+            return ElasticSource._last_line(result["exception"])
+        return result.get("msg", "failed")
 
     @staticmethod
     def _last_line(text):
-        lines = text.strip().split('\n')
+        lines = text.strip().split("\n")
         return lines[-1]
 
     @staticmethod
     def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return f"message: \"{message}\"\nexception: \"{exception}\"\nstderr: \"{stderr}\""
+        message = result.get("msg", "failed")
+        exception = result.get("exception")
+        stderr = result.get("stderr")
+        return f'message: "{message}"\nexception: "{exception}"\nstderr: "{stderr}"'
 
 
 class CallbackModule(CallbackBase):
@@ -291,12 +311,12 @@ class CallbackModule(CallbackBase):
     """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.elastic'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.elastic"
     CALLBACK_NEEDS_ENABLED = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.hide_task_arguments = None
         self.apm_service_name = None
         self.ansible_playbook = None
@@ -307,28 +327,28 @@ class CallbackModule(CallbackBase):
         self.disabled = False
 
         if ELASTIC_LIBRARY_IMPORT_ERROR:
-            raise AnsibleError('The `elastic-apm` must be installed to use this plugin') from ELASTIC_LIBRARY_IMPORT_ERROR
+            raise AnsibleError(
+                "The `elastic-apm` must be installed to use this plugin"
+            ) from ELASTIC_LIBRARY_IMPORT_ERROR
 
         self.tasks_data = OrderedDict()
 
         self.elastic = ElasticSource(display=self._display)
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
+        self.hide_task_arguments = self.get_option("hide_task_arguments")
 
-        self.apm_service_name = self.get_option('apm_service_name')
+        self.apm_service_name = self.get_option("apm_service_name")
         if not self.apm_service_name:
-            self.apm_service_name = 'ansible'
+            self.apm_service_name = "ansible"
 
-        self.apm_server_url = self.get_option('apm_server_url')
-        self.apm_secret_token = self.get_option('apm_secret_token')
-        self.apm_api_key = self.get_option('apm_api_key')
-        self.apm_verify_server_cert = self.get_option('apm_verify_server_cert')
-        self.traceparent = self.get_option('traceparent')
+        self.apm_server_url = self.get_option("apm_server_url")
+        self.apm_secret_token = self.get_option("apm_secret_token")
+        self.apm_api_key = self.get_option("apm_api_key")
+        self.apm_verify_server_cert = self.get_option("apm_verify_server_cert")
+        self.traceparent = self.get_option("traceparent")
 
     def v2_playbook_on_start(self, playbook):
         self.ansible_playbook = basename(playbook._file_name)
@@ -337,65 +357,29 @@ class CallbackModule(CallbackBase):
         self.play_name = play.get_name()
 
     def v2_runner_on_no_hosts(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.elastic.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_task_start(self, task, is_conditional):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.elastic.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_cleanup_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.elastic.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_handler_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.elastic.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
         self.errors += 1
-        self.elastic.finish_task(
-            self.tasks_data,
-            'failed',
-            result
-        )
+        self.elastic.finish_task(self.tasks_data, "failed", result)
 
     def v2_runner_on_ok(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'ok',
-            result
-        )
+        self.elastic.finish_task(self.tasks_data, "ok", result)
 
     def v2_runner_on_skipped(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'skipped',
-            result
-        )
+        self.elastic.finish_task(self.tasks_data, "skipped", result)
 
     def v2_playbook_on_include(self, included_file):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'included',
-            included_file
-        )
+        self.elastic.finish_task(self.tasks_data, "included", included_file)
 
     def v2_playbook_on_stats(self, stats):
         if self.errors == 0:
@@ -411,7 +395,7 @@ class CallbackModule(CallbackBase):
             self.apm_server_url,
             self.apm_verify_server_cert,
             self.apm_secret_token,
-            self.apm_api_key
+            self.apm_api_key,
         )
 
     def v2_runner_on_async_failed(self, result, **kwargs):

plugins/callback/jabber.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 maxn nikolaev.makc@gmail.com
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -55,29 +54,31 @@ from ansible.plugins.callback import CallbackBase
 
 
 class CallbackModule(CallbackBase):
-
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.jabber'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.jabber"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
 
         if not HAS_XMPP:
-            self._display.warning("The required python xmpp library (xmpppy) is not installed. "
-                                  "pip install git+https://github.com/ArchipelProject/xmpppy")
+            self._display.warning(
+                "The required python xmpp library (xmpppy) is not installed. "
+                "pip install git+https://github.com/ArchipelProject/xmpppy"
+            )
             self.disabled = True
 
-        self.serv = os.getenv('JABBER_SERV')
-        self.j_user = os.getenv('JABBER_USER')
-        self.j_pass = os.getenv('JABBER_PASS')
-        self.j_to = os.getenv('JABBER_TO')
+        self.serv = os.getenv("JABBER_SERV")
+        self.j_user = os.getenv("JABBER_USER")
+        self.j_pass = os.getenv("JABBER_PASS")
+        self.j_to = os.getenv("JABBER_TO")
 
         if (self.j_user or self.j_pass or self.serv or self.j_to) is None:
             self.disabled = True
-            self._display.warning('Jabber CallBack wants the JABBER_SERV, JABBER_USER, JABBER_PASS and JABBER_TO environment variables')
+            self._display.warning(
+                "Jabber CallBack wants the JABBER_SERV, JABBER_USER, JABBER_PASS and JABBER_TO environment variables"
+            )
 
     def send_msg(self, msg):
         """Send message"""
@@ -86,7 +87,7 @@ class CallbackModule(CallbackBase):
         client.connect(server=(self.serv, 5222))
         client.auth(jid.getNode(), self.j_pass, resource=jid.getResource())
         message = xmpp.Message(self.j_to, msg)
-        message.setAttr('type', 'chat')
+        message.setAttr("type", "chat")
         client.send(message)
         client.disconnect()
 
@@ -110,9 +111,9 @@ class CallbackModule(CallbackBase):
         unreachable = False
         for h in hosts:
             s = stats.summarize(h)
-            if s['failures'] > 0:
+            if s["failures"] > 0:
                 failures = True
-            if s['unreachable'] > 0:
+            if s["unreachable"] > 0:
                 unreachable = True
 
         if failures or unreachable:

plugins/callback/log_plays.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -28,16 +27,15 @@ options:
         key: log_folder
 """
 
+import json
 import os
 import time
-import json
-
-from ansible.utils.path import makedirs_safe
-from ansible.module_utils.common.text.converters import to_bytes
 from collections.abc import MutableMapping
+
+from ansible.module_utils.common.text.converters import to_bytes
 from ansible.parsing.ajson import AnsibleJSONEncoder
 from ansible.plugins.callback import CallbackBase
-
+from ansible.utils.path import makedirs_safe
 
 # NOTE: in Ansible 1.2 or later general logging is available without
 # this plugin, just set ANSIBLE_LOG_PATH as an environment variable
@@ -50,9 +48,10 @@ class CallbackModule(CallbackBase):
     """
     logs playbook results, per host, in /var/log/ansible/hosts
     """
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.log_plays'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.log_plays"
     CALLBACK_NEEDS_WHITELIST = True
 
     TIME_FORMAT = "%b %d %Y %H:%M:%S"
@@ -62,11 +61,10 @@ class CallbackModule(CallbackBase):
         return f"{now} - {playbook} - {task_name} - {task_action} - {category} - {data}\n\n"
 
     def __init__(self):
-
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         self.log_folder = self.get_option("log_folder")
 
@@ -76,12 +74,12 @@ class CallbackModule(CallbackBase):
     def log(self, result, category):
         data = result._result
         if isinstance(data, MutableMapping):
-            if '_ansible_verbose_override' in data:
+            if "_ansible_verbose_override" in data:
                 # avoid logging extraneous data
-                data = 'omitted'
+                data = "omitted"
             else:
                 data = data.copy()
-                invocation = data.pop('invocation', None)
+                invocation = data.pop("invocation", None)
                 data = json.dumps(data, cls=AnsibleJSONEncoder)
                 if invocation is not None:
                     data = f"{json.dumps(invocation)} => {data} "
@@ -94,25 +92,25 @@ class CallbackModule(CallbackBase):
             fd.write(msg)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
-        self.log(result, 'FAILED')
+        self.log(result, "FAILED")
 
     def v2_runner_on_ok(self, result):
-        self.log(result, 'OK')
+        self.log(result, "OK")
 
     def v2_runner_on_skipped(self, result):
-        self.log(result, 'SKIPPED')
+        self.log(result, "SKIPPED")
 
     def v2_runner_on_unreachable(self, result):
-        self.log(result, 'UNREACHABLE')
+        self.log(result, "UNREACHABLE")
 
     def v2_runner_on_async_failed(self, result):
-        self.log(result, 'ASYNC_FAILED')
+        self.log(result, "ASYNC_FAILED")
 
     def v2_playbook_on_start(self, playbook):
         self.playbook = playbook._file_name
 
     def v2_playbook_on_import_for_host(self, result, imported_file):
-        self.log(result, 'IMPORTED', imported_file)
+        self.log(result, "IMPORTED", imported_file)
 
     def v2_playbook_on_not_import_for_host(self, result, missing_file):
-        self.log(result, 'NOTIMPORTED', missing_file)
+        self.log(result, "NOTIMPORTED", missing_file)

plugins/callback/loganalytics.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) Ansible project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -52,14 +51,13 @@ examples: |-
     shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
 """
 
+import base64
+import getpass
 import hashlib
 import hmac
-import base64
 import json
-import uuid
 import socket
-import getpass
-
+import uuid
 from os.path import basename
 
 from ansible.module_utils.ansible_release import __version__ as ansible_version
@@ -72,7 +70,7 @@ from ansible_collections.community.general.plugins.module_utils.datetime import
 )
 
 
-class AzureLogAnalyticsSource(object):
+class AzureLogAnalyticsSource:
     def __init__(self):
         self.ansible_check_mode = False
         self.ansible_playbook = ""
@@ -84,11 +82,10 @@ class AzureLogAnalyticsSource(object):
     def __build_signature(self, date, workspace_id, shared_key, content_length):
         # Build authorisation signature for Azure log analytics API call
         sigs = f"POST\n{content_length}\napplication/json\nx-ms-date:{date}\n/api/logs"
-        utf8_sigs = sigs.encode('utf-8')
+        utf8_sigs = sigs.encode("utf-8")
         decoded_shared_key = base64.b64decode(shared_key)
-        hmac_sha256_sigs = hmac.new(
-            decoded_shared_key, utf8_sigs, digestmod=hashlib.sha256).digest()
-        encoded_hash = base64.b64encode(hmac_sha256_sigs).decode('utf-8')
+        hmac_sha256_sigs = hmac.new(decoded_shared_key, utf8_sigs, digestmod=hashlib.sha256).digest()
+        encoded_hash = base64.b64encode(hmac_sha256_sigs).decode("utf-8")
         signature = f"SharedKey {workspace_id}:{encoded_hash}"
         return signature
 
@@ -96,10 +93,10 @@ class AzureLogAnalyticsSource(object):
         return f"https://{workspace_id}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01"
 
     def __rfc1123date(self):
-        return now().strftime('%a, %d %b %Y %H:%M:%S GMT')
+        return now().strftime("%a, %d %b %Y %H:%M:%S GMT")
 
     def send_event(self, workspace_id, shared_key, state, result, runtime):
-        if result._task_fields['args'].get('_ansible_check_mode') is True:
+        if result._task_fields["args"].get("_ansible_check_mode") is True:
             self.ansible_check_mode = True
 
         if result._task._role:
@@ -108,31 +105,31 @@ class AzureLogAnalyticsSource(object):
             ansible_role = None
 
         data = {}
-        data['uuid'] = result._task._uuid
-        data['session'] = self.session
-        data['status'] = state
-        data['timestamp'] = self.__rfc1123date()
-        data['host'] = self.host
-        data['user'] = self.user
-        data['runtime'] = runtime
-        data['ansible_version'] = ansible_version
-        data['ansible_check_mode'] = self.ansible_check_mode
-        data['ansible_host'] = result._host.name
-        data['ansible_playbook'] = self.ansible_playbook
-        data['ansible_role'] = ansible_role
-        data['ansible_task'] = result._task_fields
+        data["uuid"] = result._task._uuid
+        data["session"] = self.session
+        data["status"] = state
+        data["timestamp"] = self.__rfc1123date()
+        data["host"] = self.host
+        data["user"] = self.user
+        data["runtime"] = runtime
+        data["ansible_version"] = ansible_version
+        data["ansible_check_mode"] = self.ansible_check_mode
+        data["ansible_host"] = result._host.name
+        data["ansible_playbook"] = self.ansible_playbook
+        data["ansible_role"] = ansible_role
+        data["ansible_task"] = result._task_fields
         # Removing args since it can contain sensitive data
-        if 'args' in data['ansible_task']:
-            data['ansible_task'].pop('args')
-        data['ansible_result'] = result._result
-        if 'content' in data['ansible_result']:
-            data['ansible_result'].pop('content')
+        if "args" in data["ansible_task"]:
+            data["ansible_task"].pop("args")
+        data["ansible_result"] = result._result
+        if "content" in data["ansible_result"]:
+            data["ansible_result"].pop("content")
 
         # Adding extra vars info
-        data['extra_vars'] = self.extra_vars
+        data["extra_vars"] = self.extra_vars
 
         # Preparing the playbook logs as JSON format and send to Azure log analytics
-        jsondata = json.dumps({'event': data}, cls=AnsibleJSONEncoder, sort_keys=True)
+        jsondata = json.dumps({"event": data}, cls=AnsibleJSONEncoder, sort_keys=True)
         content_length = len(jsondata)
         rfc1123date = self.__rfc1123date()
         signature = self.__build_signature(rfc1123date, workspace_id, shared_key, content_length)
@@ -142,38 +139,35 @@ class AzureLogAnalyticsSource(object):
             workspace_url,
             jsondata,
             headers={
-                'content-type': 'application/json',
-                'Authorization': signature,
-                'Log-Type': 'ansible_playbook',
-                'x-ms-date': rfc1123date
+                "content-type": "application/json",
+                "Authorization": signature,
+                "Log-Type": "ansible_playbook",
+                "x-ms-date": rfc1123date,
             },
-            method='POST'
+            method="POST",
         )
 
 
 class CallbackModule(CallbackBase):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'loganalytics'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "loganalytics"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.start_datetimes = {}  # Collect task start times
         self.workspace_id = None
         self.shared_key = None
         self.loganalytics = AzureLogAnalyticsSource()
 
     def _seconds_since_start(self, result):
-        return (
-            now() -
-            self.start_datetimes[result._task._uuid]
-        ).total_seconds()
+        return (now() - self.start_datetimes[result._task._uuid]).total_seconds()
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
-        self.workspace_id = self.get_option('workspace_id')
-        self.shared_key = self.get_option('shared_key')
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        self.workspace_id = self.get_option("workspace_id")
+        self.shared_key = self.get_option("shared_key")
 
     def v2_playbook_on_play_start(self, play):
         vm = play.get_variable_manager()
@@ -191,45 +185,25 @@ class CallbackModule(CallbackBase):
 
     def v2_runner_on_ok(self, result, **kwargs):
         self.loganalytics.send_event(
-            self.workspace_id,
-            self.shared_key,
-            'OK',
-            result,
-            self._seconds_since_start(result)
+            self.workspace_id, self.shared_key, "OK", result, self._seconds_since_start(result)
         )
 
     def v2_runner_on_skipped(self, result, **kwargs):
         self.loganalytics.send_event(
-            self.workspace_id,
-            self.shared_key,
-            'SKIPPED',
-            result,
-            self._seconds_since_start(result)
+            self.workspace_id, self.shared_key, "SKIPPED", result, self._seconds_since_start(result)
         )
 
     def v2_runner_on_failed(self, result, **kwargs):
         self.loganalytics.send_event(
-            self.workspace_id,
-            self.shared_key,
-            'FAILED',
-            result,
-            self._seconds_since_start(result)
+            self.workspace_id, self.shared_key, "FAILED", result, self._seconds_since_start(result)
         )
 
     def runner_on_async_failed(self, result, **kwargs):
         self.loganalytics.send_event(
-            self.workspace_id,
-            self.shared_key,
-            'FAILED',
-            result,
-            self._seconds_since_start(result)
+            self.workspace_id, self.shared_key, "FAILED", result, self._seconds_since_start(result)
         )
 
     def v2_runner_on_unreachable(self, result, **kwargs):
         self.loganalytics.send_event(
-            self.workspace_id,
-            self.shared_key,
-            'UNREACHABLE',
-            result,
-            self._seconds_since_start(result)
+            self.workspace_id, self.shared_key, "UNREACHABLE", result, self._seconds_since_start(result)
         )

plugins/callback/loganalytics_ingestion.py

@@ -0,0 +1,342 @@
+#!/usr/bin/env python
+# Copyright (c) Ansible project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import annotations
+
+DOCUMENTATION = """
+name: loganalytics_ingestion
+type: notification
+short_description: Posts task results to an Azure Log Analytics workspace using the new Logs Ingestion API
+author:
+  - Wade Cline (@wtcline-intc) <wade.cline@intel.com>
+  - Sriramoju Vishal Bharath (@vsh47) <sriramoju.vishal.bharath@intel.com>
+  - Cyrus Li (@zhcli) <cyrus1006@gmail.com>
+description:
+  - This callback plugin will post task results in JSON format to an Azure Log Analytics workspace using the new Logs Ingestion API.
+version_added: "12.4.0"
+requirements:
+  - The callback plugin has been enabled.
+  - An Azure Log Analytics workspace has been established.
+  - A Data Collection Rule (DCR) and custom table are created.
+options:
+  dce_url:
+    description: URL of the Data Collection Endpoint (DCE) for Azure Logs Ingestion API.
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_DCE_URL
+    ini:
+      - section: callback_loganalytics
+        key: dce_url
+  dcr_id:
+    description: Data Collection Rule (DCR) ID for the Azure Log Ingestion API.
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_DCR_ID
+    ini:
+      - section: callback_loganalytics
+        key: dcr_id
+  disable_attempts:
+    description:
+      - When O(disable_on_failure=true), number of plugin failures that must occur before the plugin is disabled.
+      - This helps prevent outright plugin failure from a single, transient network issue.
+    type: int
+    default: 3
+    env:
+      - name: ANSIBLE_LOGANALYTICS_DISABLE_ATTEMPTS
+    ini:
+      - section: callback_loganalytics
+        key: disable_attempts
+  disable_on_failure:
+    description: Stop trying to send data on plugin failure.
+    type: bool
+    default: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_DISABLE_ON_FAILURE
+    ini:
+      - section: callback_loganalytics
+        key: disable_on_failure
+  client_id:
+    description: Client ID of the Azure App registration for OAuth2 authentication ("Modern Authentication").
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_CLIENT_ID
+    ini:
+      - section: callback_loganalytics
+        key: client_id
+  client_secret:
+    description: Client Secret of the Azure App registration.
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_CLIENT_SECRET
+    ini:
+      - section: callback_loganalytics
+        key: client_secret
+  include_content:
+    description: Send the content to the Azure Log Analytics workspace.
+    type: bool
+    default: false
+    env:
+      - name: ANSIBLE_LOGANALYTICS_INCLUDE_CONTENT
+    ini:
+      - section: callback_loganalytics
+        key: include_content
+  include_task_args:
+    description: Send the task args to the Azure Log Analytics workspace.
+    type: bool
+    default: false
+    env:
+      - name: ANSIBLE_LOGANALYTICS_INCLUDE_TASK_ARGS
+    ini:
+      - section: callback_loganalytics
+        key: include_task_args
+  stream_name:
+    description: The name of the stream used to send the logs to the Azure Log Analytics workspace.
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_STREAM_NAME
+    ini:
+      - section: callback_loganalytics
+        key: stream_name
+  tenant_id:
+    description: Tenant ID for the Azure Active Directory.
+    type: str
+    required: true
+    env:
+      - name: ANSIBLE_LOGANALYTICS_TENANT_ID
+    ini:
+      - section: callback_loganalytics
+        key: tenant_id
+  timeout:
+    description: Timeout for the HTTP requests to the Azure Log Analytics API.
+    type: int
+    default: 2
+    env:
+      - name: ANSIBLE_LOGANALYTICS_TIMEOUT
+    ini:
+      - section: callback_loganalytics
+        key: timeout
+seealso:
+  - name: Logs Ingestion API
+    description: Overview of Logs Ingestion API in Azure Monitor
+    link: https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview
+notes:
+  - Triple verbosity logging (C(-vvv)) can be used to generate JSON sample data for creating the table schema in Azure Log Analytics.
+    Search for the string C(Event Data:) in the output in order to locate the data sample.
+"""
+
+EXAMPLES = """
+examples: |
+  Enable the plugin in ansible.cfg:
+    [defaults]
+    callback_enabled = community.general.loganalytics_ingestion
+  Set the environment variables:
+    export ANSIBLE_LOGANALYTICS_DCE_URL=https://my-dce.ingest.monitor.azure.com
+    export ANSIBLE_LOGANALYTICS_DCR_ID=dcr-xxxxxx
+    export ANSIBLE_LOGANALYTICS_CLIENT_ID=xxxxxxxx
+    export ANSIBLE_LOGANALYTICS_CLIENT_SECRET=xxxxxxxx
+    export ANSIBLE_LOGANALYTICS_TENANT_ID=xxxxxxxx
+    export ANSIBLE_LOGANALYTICS_STREAM_NAME=Custom-MyTable
+"""
+
+import getpass
+import json
+import socket
+import uuid
+from datetime import datetime, timedelta, timezone
+from os.path import basename
+from urllib.parse import urlencode
+
+from ansible.module_utils.urls import open_url
+from ansible.plugins.callback import CallbackBase
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class AzureLogAnalyticsIngestionSource:
+    def __init__(
+        self,
+        dce_url,
+        dcr_id,
+        disable_attempts,
+        disable_on_failure,
+        client_id,
+        client_secret,
+        tenant_id,
+        stream_name,
+        include_task_args,
+        include_content,
+        timeout,
+        fqcn,
+    ):
+        self.dce_url = dce_url
+        self.dcr_id = dcr_id
+        self.disabled = False
+        self.disable_attempts = disable_attempts
+        self.disable_on_failure = disable_on_failure
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.failures = 0
+        self.tenant_id = tenant_id
+        self.stream_name = stream_name
+        self.include_task_args = include_task_args
+        self.include_content = include_content
+        self.token_expiration_time = None
+        self.session = str(uuid.uuid4())
+        self.host = socket.gethostname()
+        self.user = getpass.getuser()
+        self.timeout = timeout
+        self.fqcn = fqcn
+
+        self.bearer_token = self.get_bearer_token()
+
+    # OAuth2 authentication method to get a Bearer token
+    # This replaces the shared_key authentication mechanism
+    def get_bearer_token(self):
+        url = f"https://login.microsoftonline.com/{self.tenant_id}/oauth2/v2.0/token"
+        headers = {"Content-Type": "application/x-www-form-urlencoded"}
+        data = urlencode(
+            {
+                "grant_type": "client_credentials",
+                "client_id": self.client_id,
+                "client_secret": self.client_secret,
+                # The scope value comes from https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview#headers
+                # and https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc#the-default-scope
+                "scope": "https://monitor.azure.com/.default",
+            }
+        )
+        response = open_url(url, data=data, force=True, headers=headers, method="POST", timeout=self.timeout)
+        j = json.loads(response.read().decode("utf-8"))
+        self.token_expiration_time = datetime.now() + timedelta(seconds=j.get("expires_in"))
+        return j.get("access_token")
+
+    def is_token_valid(self):
+        return datetime.now() + timedelta(seconds=10) < self.token_expiration_time
+
+    # Method to send event data to the Azure Logs Ingestion API
+    # This replaces the legacy API call and now uses the Logs Ingestion API endpoint
+    def send_event(self, event_data):
+        if not self.is_token_valid():
+            self.bearer_token = self.get_bearer_token()
+        ingestion_url = (
+            f"{self.dce_url}/dataCollectionRules/{self.dcr_id}/streams/{self.stream_name}?api-version=2023-01-01"
+        )
+        headers = {"Authorization": f"Bearer {self.bearer_token}", "Content-Type": "application/json"}
+        open_url(ingestion_url, data=json.dumps(event_data), headers=headers, method="POST", timeout=self.timeout)
+
+    def _rfc1123date(self):
+        return datetime.now(timezone.utc).strftime("%a, %d %b %Y %H:%M:%S GMT")
+
+    # This method wraps the private method with the appropriate error handling.
+    def send_to_loganalytics(self, playbook_name, result, state):
+        if self.disabled:
+            return
+        try:
+            self._send_to_loganalytics(playbook_name, result, state)
+        except Exception as e:
+            display.warning(f"{self.fqcn} callback plugin failure: {e}.")
+            if self.disable_on_failure:
+                self.failures += 1
+                if self.failures >= self.disable_attempts:
+                    display.warning(
+                        f"{self.fqcn} callback plugin failures exceed maximum of '{self.disable_attempts}'!  Disabling plugin!"
+                    )
+                    self.disabled = True
+                else:
+                    display.v(f"{self.fqcn} callback plugin failure {self.failures}/{self.disable_attempts}")
+
+    def _send_to_loganalytics(self, playbook_name, result, state):
+        ansible_role = str(result._task._role) if result._task._role else None
+
+        # Include/Exclude task args
+        if not self.include_task_args:
+            result._task_fields.pop("args", None)
+
+        # Include/Exclude content
+        if not self.include_content:
+            result._result.pop("content", None)
+
+        # Build the event data
+        event_data = [
+            {
+                "TimeGenerated": self._rfc1123date(),
+                "Host": result._host.name,
+                "User": self.user,
+                "Playbook": playbook_name,
+                "Role": ansible_role,
+                "TaskName": result._task.get_name(),
+                "Task": result._task_fields,
+                "Action": result._task_fields["action"],
+                "State": state,
+                "Result": result._result,
+                "Session": self.session,
+            }
+        ]
+
+        # The data displayed here can be used as a sample file in order to create the table's schema.
+        display.vvv(f"Event Data: {json.dumps(event_data)}")
+
+        self.send_event(event_data)
+
+
+class CallbackModule(CallbackBase):
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "loganalytics_ingestion"
+    CALLBACK_NEEDS_ENABLED = True
+
+    def __init__(self, display=None):
+        super().__init__(display=display)
+        self.start_datetimes = {}
+        self.playbook_name = None
+        self.azure_loganalytics = None
+        self.fqcn = f"community.general.{self.CALLBACK_NAME}"
+
+    def set_options(self, task_keys=None, var_options=None, direct=None):
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+
+        # Set options for the new Azure Logs Ingestion API configuration
+        self.client_id = self.get_option("client_id")
+        self.client_secret = self.get_option("client_secret")
+        self.dce_url = self.get_option("dce_url")
+        self.dcr_id = self.get_option("dcr_id")
+        self.disable_attempts = self.get_option("disable_attempts")
+        self.disable_on_failure = self.get_option("disable_on_failure")
+        self.include_content = self.get_option("include_content")
+        self.include_task_args = self.get_option("include_task_args")
+        self.stream_name = self.get_option("stream_name")
+        self.tenant_id = self.get_option("tenant_id")
+        self.timeout = self.get_option("timeout")
+
+        # Initialize the AzureLogAnalyticsIngestionSource with the new settings
+        self.azure_loganalytics = AzureLogAnalyticsIngestionSource(
+            self.dce_url,
+            self.dcr_id,
+            self.disable_attempts,
+            self.disable_on_failure,
+            self.client_id,
+            self.client_secret,
+            self.tenant_id,
+            self.stream_name,
+            self.include_task_args,
+            self.include_content,
+            self.timeout,
+            self.fqcn,
+        )
+
+    def v2_playbook_on_start(self, playbook):
+        self.playbook_name = basename(playbook._file_name)
+
+    # Build event data and send it to the Logs Ingestion API
+    def v2_runner_on_failed(self, result, **kwargs):
+        self.azure_loganalytics.send_to_loganalytics(self.playbook_name, result, "FAILED")
+
+    def v2_runner_on_ok(self, result, **kwargs):
+        self.azure_loganalytics.send_to_loganalytics(self.playbook_name, result, "OK")

plugins/callback/logdna.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018, Samir Musali <samir.musali@logdna.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -56,15 +55,17 @@ options:
     default: ansible
 """
 
-import logging
 import json
+import logging
 import socket
 from uuid import getnode
-from ansible.plugins.callback import CallbackBase
+
 from ansible.parsing.ajson import AnsibleJSONEncoder
+from ansible.plugins.callback import CallbackBase
 
 try:
     from logdna import LogDNAHandler
+
     HAS_LOGDNA = True
 except ImportError:
     HAS_LOGDNA = False
@@ -73,12 +74,12 @@ except ImportError:
 # Getting MAC Address of system:
 def get_mac():
     mac = f"{getnode():012x}"
-    return ":".join(map(lambda index: mac[index:index + 2], range(int(len(mac) / 2))))
+    return ":".join(map(lambda index: mac[index : index + 2], range(int(len(mac) / 2))))
 
 
 # Getting hostname of system:
 def get_hostname():
-    return str(socket.gethostname()).split('.local', 1)[0]
+    return str(socket.gethostname()).split(".local", 1)[0]
 
 
 # Getting IP of system:
@@ -88,10 +89,10 @@ def get_ip():
     except Exception:
         s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         try:
-            s.connect(('10.255.255.255', 1))
+            s.connect(("10.255.255.255", 1))
             IP = s.getsockname()[0]
         except Exception:
-            IP = '127.0.0.1'
+            IP = "127.0.0.1"
         finally:
             s.close()
         return IP
@@ -108,14 +109,13 @@ def isJSONable(obj):
 
 # LogDNA Callback Module:
 class CallbackModule(CallbackBase):
-
     CALLBACK_VERSION = 0.1
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.logdna'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.logdna"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
 
         self.disabled = True
         self.playbook_name = None
@@ -126,29 +126,29 @@ class CallbackModule(CallbackBase):
         self.conf_tags = None
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.conf_key = self.get_option('conf_key')
-        self.plugin_ignore_errors = self.get_option('plugin_ignore_errors')
-        self.conf_hostname = self.get_option('conf_hostname')
-        self.conf_tags = self.get_option('conf_tags')
+        self.conf_key = self.get_option("conf_key")
+        self.plugin_ignore_errors = self.get_option("plugin_ignore_errors")
+        self.conf_hostname = self.get_option("conf_hostname")
+        self.conf_tags = self.get_option("conf_tags")
         self.mac = get_mac()
         self.ip = get_ip()
 
         if self.conf_hostname is None:
             self.conf_hostname = get_hostname()
 
-        self.conf_tags = self.conf_tags.split(',')
+        self.conf_tags = self.conf_tags.split(",")
 
         if HAS_LOGDNA:
-            self.log = logging.getLogger('logdna')
+            self.log = logging.getLogger("logdna")
             self.log.setLevel(logging.INFO)
-            self.options = {'hostname': self.conf_hostname, 'mac': self.mac, 'index_meta': True}
+            self.options = {"hostname": self.conf_hostname, "mac": self.mac, "index_meta": True}
             self.log.addHandler(LogDNAHandler(self.conf_key, self.options))
             self.disabled = False
         else:
             self.disabled = True
-            self._display.warning('WARNING:\nPlease, install LogDNA Python Package: `pip install logdna`')
+            self._display.warning("WARNING:\nPlease, install LogDNA Python Package: `pip install logdna`")
 
     def metaIndexing(self, meta):
         invalidKeys = []
@@ -160,25 +160,25 @@ class CallbackModule(CallbackBase):
         if ninvalidKeys > 0:
             for key in invalidKeys:
                 del meta[key]
-            meta['__errors'] = f"These keys have been sanitized: {', '.join(invalidKeys)}"
+            meta["__errors"] = f"These keys have been sanitized: {', '.join(invalidKeys)}"
         return meta
 
     def sanitizeJSON(self, data):
         try:
             return json.loads(json.dumps(data, sort_keys=True, cls=AnsibleJSONEncoder))
         except Exception:
-            return {'warnings': ['JSON Formatting Issue', json.dumps(data, sort_keys=True, cls=AnsibleJSONEncoder)]}
+            return {"warnings": ["JSON Formatting Issue", json.dumps(data, sort_keys=True, cls=AnsibleJSONEncoder)]}
 
     def flush(self, log, options):
         if HAS_LOGDNA:
             self.log.info(json.dumps(log), options)
 
     def sendLog(self, host, category, logdata):
-        options = {'app': 'ansible', 'meta': {'playbook': self.playbook_name, 'host': host, 'category': category}}
-        logdata['info'].pop('invocation', None)
-        warnings = logdata['info'].pop('warnings', None)
+        options = {"app": "ansible", "meta": {"playbook": self.playbook_name, "host": host, "category": category}}
+        logdata["info"].pop("invocation", None)
+        warnings = logdata["info"].pop("warnings", None)
         if warnings is not None:
-            self.flush({'warn': warnings}, options)
+            self.flush({"warn": warnings}, options)
         self.flush(logdata, options)
 
     def v2_playbook_on_start(self, playbook):
@@ -189,21 +189,21 @@ class CallbackModule(CallbackBase):
         result = dict()
         for host in stats.processed.keys():
             result[host] = stats.summarize(host)
-        self.sendLog(self.conf_hostname, 'STATS', {'info': self.sanitizeJSON(result)})
+        self.sendLog(self.conf_hostname, "STATS", {"info": self.sanitizeJSON(result)})
 
     def runner_on_failed(self, host, res, ignore_errors=False):
         if self.plugin_ignore_errors:
             ignore_errors = self.plugin_ignore_errors
-        self.sendLog(host, 'FAILED', {'info': self.sanitizeJSON(res), 'ignore_errors': ignore_errors})
+        self.sendLog(host, "FAILED", {"info": self.sanitizeJSON(res), "ignore_errors": ignore_errors})
 
     def runner_on_ok(self, host, res):
-        self.sendLog(host, 'OK', {'info': self.sanitizeJSON(res)})
+        self.sendLog(host, "OK", {"info": self.sanitizeJSON(res)})
 
     def runner_on_unreachable(self, host, res):
-        self.sendLog(host, 'UNREACHABLE', {'info': self.sanitizeJSON(res)})
+        self.sendLog(host, "UNREACHABLE", {"info": self.sanitizeJSON(res)})
 
     def runner_on_async_failed(self, host, res, jid):
-        self.sendLog(host, 'ASYNC_FAILED', {'info': self.sanitizeJSON(res), 'job_id': jid})
+        self.sendLog(host, "ASYNC_FAILED", {"info": self.sanitizeJSON(res), "job_id": jid})
 
     def runner_on_async_ok(self, host, res, jid):
-        self.sendLog(host, 'ASYNC_OK', {'info': self.sanitizeJSON(res), 'job_id': jid})
+        self.sendLog(host, "ASYNC_OK", {"info": self.sanitizeJSON(res), "job_id": jid})

plugins/callback/logentries.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2015, Logentries.com, Jimmy Tang <jimmy.tang@logentries.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -97,19 +96,21 @@ examples: >-
 """
 
 import os
-import socket
 import random
+import socket
 import time
 import uuid
 
 try:
     import certifi
+
     HAS_CERTIFI = True
 except ImportError:
     HAS_CERTIFI = False
 
 try:
     import flatdict
+
     HAS_FLATDICT = True
 except ImportError:
     HAS_FLATDICT = False
@@ -121,9 +122,8 @@ from ansible.plugins.callback import CallbackBase
 #  * Better formatting of output before sending out to logentries data/api nodes.
 
 
-class PlainTextSocketAppender(object):
-    def __init__(self, display, LE_API='data.logentries.com', LE_PORT=80, LE_TLS_PORT=443):
-
+class PlainTextSocketAppender:
+    def __init__(self, display, LE_API="data.logentries.com", LE_PORT=80, LE_TLS_PORT=443):
         self.LE_API = LE_API
         self.LE_PORT = LE_PORT
         self.LE_TLS_PORT = LE_TLS_PORT
@@ -132,7 +132,7 @@ class PlainTextSocketAppender(object):
         # Error message displayed when an incorrect Token has been detected
         self.INVALID_TOKEN = "\n\nIt appears the LOGENTRIES_TOKEN parameter you entered is incorrect!\n\n"
         # Unicode Line separator character   \u2028
-        self.LINE_SEP = '\u2028'
+        self.LINE_SEP = "\u2028"
 
         self._display = display
         self._conn = None
@@ -171,14 +171,14 @@ class PlainTextSocketAppender(object):
     def put(self, data):
         # Replace newlines with Unicode line separator
         # for multi-line events
-        data = to_text(data, errors='surrogate_or_strict')
-        multiline = data.replace('\n', self.LINE_SEP)
+        data = to_text(data, errors="surrogate_or_strict")
+        multiline = data.replace("\n", self.LINE_SEP)
         multiline += "\n"
         # Send data, reconnect if needed
         while True:
             try:
-                self._conn.send(to_bytes(multiline, errors='surrogate_or_strict'))
-            except socket.error:
+                self._conn.send(to_bytes(multiline, errors="surrogate_or_strict"))
+            except OSError:
                 self.reopen_connection()
                 continue
             break
@@ -188,6 +188,7 @@ class PlainTextSocketAppender(object):
 
 try:
     import ssl
+
     HAS_SSL = True
 except ImportError:  # for systems without TLS support.
     SocketAppender = PlainTextSocketAppender
@@ -199,27 +200,28 @@ else:
             sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             context = ssl.create_default_context(
                 purpose=ssl.Purpose.SERVER_AUTH,
-                cafile=certifi.where(), )
+                cafile=certifi.where(),
+            )
             sock = context.wrap_socket(
                 sock=sock,
                 do_handshake_on_connect=True,
-                suppress_ragged_eofs=True, )
+                suppress_ragged_eofs=True,
+            )
             sock.connect((self.LE_API, self.LE_TLS_PORT))
             self._conn = sock
 
-    SocketAppender = TLSSocketAppender
+    SocketAppender = TLSSocketAppender  # type: ignore
 
 
 class CallbackModule(CallbackBase):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.logentries'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.logentries"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self):
-
         # TODO: allow for alternate posting methods (REST/UDP/agent/etc)
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         # verify dependencies
         if not HAS_SSL:
@@ -227,7 +229,9 @@ class CallbackModule(CallbackBase):
 
         if not HAS_CERTIFI:
             self.disabled = True
-            self._display.warning('The `certifi` python module is not installed.\nDisabling the Logentries callback plugin.')
+            self._display.warning(
+                "The `certifi` python module is not installed.\nDisabling the Logentries callback plugin."
+            )
 
         self.le_jobid = str(uuid.uuid4())
 
@@ -235,41 +239,47 @@ class CallbackModule(CallbackBase):
         self.timeout = 10
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         # get options
         try:
-            self.api_url = self.get_option('api')
-            self.api_port = self.get_option('port')
-            self.api_tls_port = self.get_option('tls_port')
-            self.use_tls = self.get_option('use_tls')
-            self.flatten = self.get_option('flatten')
+            self.api_url = self.get_option("api")
+            self.api_port = self.get_option("port")
+            self.api_tls_port = self.get_option("tls_port")
+            self.use_tls = self.get_option("use_tls")
+            self.flatten = self.get_option("flatten")
         except KeyError as e:
             self._display.warning(f"Missing option for Logentries callback plugin: {e}")
             self.disabled = True
 
         try:
-            self.token = self.get_option('token')
-        except KeyError as e:
-            self._display.warning('Logentries token was not provided, this is required for this callback to operate, disabling')
+            self.token = self.get_option("token")
+        except KeyError:
+            self._display.warning(
+                "Logentries token was not provided, this is required for this callback to operate, disabling"
+            )
             self.disabled = True
 
         if self.flatten and not HAS_FLATDICT:
             self.disabled = True
-            self._display.warning('You have chosen to flatten and the `flatdict` python module is not installed.\nDisabling the Logentries callback plugin.')
+            self._display.warning(
+                "You have chosen to flatten and the `flatdict` python module is not installed.\nDisabling the Logentries callback plugin."
+            )
 
         self._initialize_connections()
 
     def _initialize_connections(self):
-
         if not self.disabled:
             if self.use_tls:
                 self._display.vvvv(f"Connecting to {self.api_url}:{self.api_tls_port} with TLS")
-                self._appender = TLSSocketAppender(display=self._display, LE_API=self.api_url, LE_TLS_PORT=self.api_tls_port)
+                self._appender = TLSSocketAppender(
+                    display=self._display, LE_API=self.api_url, LE_TLS_PORT=self.api_tls_port
+                )
             else:
                 self._display.vvvv(f"Connecting to {self.api_url}:{self.api_port}")
-                self._appender = PlainTextSocketAppender(display=self._display, LE_API=self.api_url, LE_PORT=self.api_port)
+                self._appender = PlainTextSocketAppender(
+                    display=self._display, LE_API=self.api_url, LE_PORT=self.api_port
+                )
             self._appender.reopen_connection()
 
     def emit_formatted(self, record):
@@ -280,50 +290,50 @@ class CallbackModule(CallbackBase):
             self.emit(self._dump_results(record))
 
     def emit(self, record):
-        msg = record.rstrip('\n')
+        msg = record.rstrip("\n")
         msg = f"{self.token} {msg}"
         self._appender.put(msg)
         self._display.vvvv("Sent event to logentries")
 
     def _set_info(self, host, res):
-        return {'le_jobid': self.le_jobid, 'hostname': host, 'results': res}
+        return {"le_jobid": self.le_jobid, "hostname": host, "results": res}
 
     def runner_on_ok(self, host, res):
         results = self._set_info(host, res)
-        results['status'] = 'OK'
+        results["status"] = "OK"
         self.emit_formatted(results)
 
     def runner_on_failed(self, host, res, ignore_errors=False):
         results = self._set_info(host, res)
-        results['status'] = 'FAILED'
+        results["status"] = "FAILED"
         self.emit_formatted(results)
 
     def runner_on_skipped(self, host, item=None):
         results = self._set_info(host, item)
-        del results['results']
-        results['status'] = 'SKIPPED'
+        del results["results"]
+        results["status"] = "SKIPPED"
         self.emit_formatted(results)
 
     def runner_on_unreachable(self, host, res):
         results = self._set_info(host, res)
-        results['status'] = 'UNREACHABLE'
+        results["status"] = "UNREACHABLE"
         self.emit_formatted(results)
 
     def runner_on_async_failed(self, host, res, jid):
         results = self._set_info(host, res)
-        results['jid'] = jid
-        results['status'] = 'ASYNC_FAILED'
+        results["jid"] = jid
+        results["status"] = "ASYNC_FAILED"
         self.emit_formatted(results)
 
     def v2_playbook_on_play_start(self, play):
         results = {}
-        results['le_jobid'] = self.le_jobid
-        results['started_by'] = os.getlogin()
+        results["le_jobid"] = self.le_jobid
+        results["started_by"] = os.getlogin()
         if play.name:
-            results['play'] = play.name
-        results['hosts'] = play.hosts
+            results["play"] = play.name
+        results["hosts"] = play.hosts
         self.emit_formatted(results)
 
     def playbook_on_stats(self, stats):
-        """ close connection """
+        """close connection"""
         self._appender.close_connection()

plugins/callback/logstash.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2020, Yevhen Khmelenko <ujenmr@gmail.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -95,15 +94,17 @@ ansible.cfg: |
       }
 """
 
-import os
 import json
-from ansible import context
+import logging
+import os
 import socket
 import uuid
-import logging
+
+from ansible import context
 
 try:
     import logstash
+
     HAS_LOGSTASH = True
 except ImportError:
     HAS_LOGSTASH = False
@@ -116,14 +117,13 @@ from ansible_collections.community.general.plugins.module_utils.datetime import
 
 
 class CallbackModule(CallbackBase):
-
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.logstash'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.logstash"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self):
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         if not HAS_LOGSTASH:
             self.disabled = True
@@ -133,14 +133,11 @@ class CallbackModule(CallbackBase):
 
     def _init_plugin(self):
         if not self.disabled:
-            self.logger = logging.getLogger('python-logstash-logger')
+            self.logger = logging.getLogger("python-logstash-logger")
             self.logger.setLevel(logging.DEBUG)
 
             self.handler = logstash.TCPLogstashHandler(
-                self.ls_server,
-                self.ls_port,
-                version=1,
-                message_type=self.ls_type
+                self.ls_server, self.ls_port, version=1, message_type=self.ls_type
             )
 
             self.logger.addHandler(self.handler)
@@ -148,42 +145,36 @@ class CallbackModule(CallbackBase):
             self.session = str(uuid.uuid4())
             self.errors = 0
 
-            self.base_data = {
-                'session': self.session,
-                'host': self.hostname
-            }
+            self.base_data = {"session": self.session, "host": self.hostname}
 
             if self.ls_pre_command is not None:
-                self.base_data['ansible_pre_command_output'] = os.popen(
-                    self.ls_pre_command).read()
+                self.base_data["ansible_pre_command_output"] = os.popen(self.ls_pre_command).read()
 
             if context.CLIARGS is not None:
-                self.base_data['ansible_checkmode'] = context.CLIARGS.get('check')
-                self.base_data['ansible_tags'] = context.CLIARGS.get('tags')
-                self.base_data['ansible_skip_tags'] = context.CLIARGS.get('skip_tags')
-                self.base_data['inventory'] = context.CLIARGS.get('inventory')
+                self.base_data["ansible_checkmode"] = context.CLIARGS.get("check")
+                self.base_data["ansible_tags"] = context.CLIARGS.get("tags")
+                self.base_data["ansible_skip_tags"] = context.CLIARGS.get("skip_tags")
+                self.base_data["inventory"] = context.CLIARGS.get("inventory")
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.ls_server = self.get_option('server')
-        self.ls_port = int(self.get_option('port'))
-        self.ls_type = self.get_option('type')
-        self.ls_pre_command = self.get_option('pre_command')
-        self.ls_format_version = self.get_option('format_version')
+        self.ls_server = self.get_option("server")
+        self.ls_port = int(self.get_option("port"))
+        self.ls_type = self.get_option("type")
+        self.ls_pre_command = self.get_option("pre_command")
+        self.ls_format_version = self.get_option("format_version")
 
         self._init_plugin()
 
     def v2_playbook_on_start(self, playbook):
         data = self.base_data.copy()
-        data['ansible_type'] = "start"
-        data['status'] = "OK"
-        data['ansible_playbook'] = playbook._file_name
+        data["ansible_type"] = "start"
+        data["status"] = "OK"
+        data["ansible_playbook"] = playbook._file_name
 
         if self.ls_format_version == "v2":
-            self.logger.info(
-                "START PLAYBOOK | %s", data['ansible_playbook'], extra=data
-            )
+            self.logger.info("START PLAYBOOK | %s", data["ansible_playbook"], extra=data)
         else:
             self.logger.info("ansible start", extra=data)
 
@@ -200,15 +191,13 @@ class CallbackModule(CallbackBase):
             status = "FAILED"
 
         data = self.base_data.copy()
-        data['ansible_type'] = "finish"
-        data['status'] = status
-        data['ansible_playbook_duration'] = runtime.total_seconds()
-        data['ansible_result'] = json.dumps(summarize_stat)  # deprecated field
+        data["ansible_type"] = "finish"
+        data["status"] = status
+        data["ansible_playbook_duration"] = runtime.total_seconds()
+        data["ansible_result"] = json.dumps(summarize_stat)  # deprecated field
 
         if self.ls_format_version == "v2":
-            self.logger.info(
-                "FINISH PLAYBOOK | %s", json.dumps(summarize_stat), extra=data
-            )
+            self.logger.info("FINISH PLAYBOOK | %s", json.dumps(summarize_stat), extra=data)
         else:
             self.logger.info("ansible stats", extra=data)
 
@@ -219,10 +208,10 @@ class CallbackModule(CallbackBase):
             self.play_name = play.name
 
         data = self.base_data.copy()
-        data['ansible_type'] = "start"
-        data['status'] = "OK"
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
+        data["ansible_type"] = "start"
+        data["status"] = "OK"
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
 
         if self.ls_format_version == "v2":
             self.logger.info("START PLAY | %s", self.play_name, extra=data)
@@ -232,64 +221,61 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_task_start(self, task, is_conditional):
         self.task_id = str(task._uuid)
 
-    '''
+    """
     Tasks and handler tasks are dealt with here
-    '''
+    """
 
     def v2_runner_on_ok(self, result, **kwargs):
-        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+        task_name = str(result._task).replace("TASK: ", "").replace("HANDLER: ", "")
 
         data = self.base_data.copy()
-        if task_name == 'setup':
-            data['ansible_type'] = "setup"
-            data['status'] = "OK"
-            data['ansible_host'] = result._host.name
-            data['ansible_play_id'] = self.play_id
-            data['ansible_play_name'] = self.play_name
-            data['ansible_task'] = task_name
-            data['ansible_facts'] = self._dump_results(result._result)
+        if task_name == "setup":
+            data["ansible_type"] = "setup"
+            data["status"] = "OK"
+            data["ansible_host"] = result._host.name
+            data["ansible_play_id"] = self.play_id
+            data["ansible_play_name"] = self.play_name
+            data["ansible_task"] = task_name
+            data["ansible_facts"] = self._dump_results(result._result)
 
             if self.ls_format_version == "v2":
-                self.logger.info(
-                    "SETUP FACTS | %s", self._dump_results(result._result), extra=data
-                )
+                self.logger.info("SETUP FACTS | %s", self._dump_results(result._result), extra=data)
             else:
                 self.logger.info("ansible facts", extra=data)
         else:
-            if 'changed' in result._result.keys():
-                data['ansible_changed'] = result._result['changed']
+            if "changed" in result._result.keys():
+                data["ansible_changed"] = result._result["changed"]
             else:
-                data['ansible_changed'] = False
+                data["ansible_changed"] = False
 
-            data['ansible_type'] = "task"
-            data['status'] = "OK"
-            data['ansible_host'] = result._host.name
-            data['ansible_play_id'] = self.play_id
-            data['ansible_play_name'] = self.play_name
-            data['ansible_task'] = task_name
-            data['ansible_task_id'] = self.task_id
-            data['ansible_result'] = self._dump_results(result._result)
+            data["ansible_type"] = "task"
+            data["status"] = "OK"
+            data["ansible_host"] = result._host.name
+            data["ansible_play_id"] = self.play_id
+            data["ansible_play_name"] = self.play_name
+            data["ansible_task"] = task_name
+            data["ansible_task_id"] = self.task_id
+            data["ansible_result"] = self._dump_results(result._result)
 
             if self.ls_format_version == "v2":
                 self.logger.info(
-                    "TASK OK | %s | RESULT | %s",
-                    task_name, self._dump_results(result._result), extra=data
+                    "TASK OK | %s | RESULT | %s", task_name, self._dump_results(result._result), extra=data
                 )
             else:
                 self.logger.info("ansible ok", extra=data)
 
     def v2_runner_on_skipped(self, result, **kwargs):
-        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+        task_name = str(result._task).replace("TASK: ", "").replace("HANDLER: ", "")
 
         data = self.base_data.copy()
-        data['ansible_type'] = "task"
-        data['status'] = "SKIPPED"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['ansible_task'] = task_name
-        data['ansible_task_id'] = self.task_id
-        data['ansible_result'] = self._dump_results(result._result)
+        data["ansible_type"] = "task"
+        data["status"] = "SKIPPED"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["ansible_task"] = task_name
+        data["ansible_task_id"] = self.task_id
+        data["ansible_result"] = self._dump_results(result._result)
 
         if self.ls_format_version == "v2":
             self.logger.info("TASK SKIPPED | %s", task_name, extra=data)
@@ -298,12 +284,12 @@ class CallbackModule(CallbackBase):
 
     def v2_playbook_on_import_for_host(self, result, imported_file):
         data = self.base_data.copy()
-        data['ansible_type'] = "import"
-        data['status'] = "IMPORTED"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['imported_file'] = imported_file
+        data["ansible_type"] = "import"
+        data["status"] = "IMPORTED"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["imported_file"] = imported_file
 
         if self.ls_format_version == "v2":
             self.logger.info("IMPORT | %s", imported_file, extra=data)
@@ -312,12 +298,12 @@ class CallbackModule(CallbackBase):
 
     def v2_playbook_on_not_import_for_host(self, result, missing_file):
         data = self.base_data.copy()
-        data['ansible_type'] = "import"
-        data['status'] = "NOT IMPORTED"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['imported_file'] = missing_file
+        data["ansible_type"] = "import"
+        data["status"] = "NOT IMPORTED"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["imported_file"] = missing_file
 
         if self.ls_format_version == "v2":
             self.logger.info("NOT IMPORTED | %s", missing_file, extra=data)
@@ -325,75 +311,81 @@ class CallbackModule(CallbackBase):
             self.logger.info("ansible import", extra=data)
 
     def v2_runner_on_failed(self, result, **kwargs):
-        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+        task_name = str(result._task).replace("TASK: ", "").replace("HANDLER: ", "")
 
         data = self.base_data.copy()
-        if 'changed' in result._result.keys():
-            data['ansible_changed'] = result._result['changed']
+        if "changed" in result._result.keys():
+            data["ansible_changed"] = result._result["changed"]
         else:
-            data['ansible_changed'] = False
+            data["ansible_changed"] = False
 
-        data['ansible_type'] = "task"
-        data['status'] = "FAILED"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['ansible_task'] = task_name
-        data['ansible_task_id'] = self.task_id
-        data['ansible_result'] = self._dump_results(result._result)
+        data["ansible_type"] = "task"
+        data["status"] = "FAILED"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["ansible_task"] = task_name
+        data["ansible_task_id"] = self.task_id
+        data["ansible_result"] = self._dump_results(result._result)
 
         self.errors += 1
         if self.ls_format_version == "v2":
             self.logger.error(
                 "TASK FAILED | %s | HOST | %s | RESULT | %s",
-                task_name, self.hostname,
-                self._dump_results(result._result), extra=data
+                task_name,
+                self.hostname,
+                self._dump_results(result._result),
+                extra=data,
             )
         else:
             self.logger.error("ansible failed", extra=data)
 
     def v2_runner_on_unreachable(self, result, **kwargs):
-        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+        task_name = str(result._task).replace("TASK: ", "").replace("HANDLER: ", "")
 
         data = self.base_data.copy()
-        data['ansible_type'] = "task"
-        data['status'] = "UNREACHABLE"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['ansible_task'] = task_name
-        data['ansible_task_id'] = self.task_id
-        data['ansible_result'] = self._dump_results(result._result)
+        data["ansible_type"] = "task"
+        data["status"] = "UNREACHABLE"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["ansible_task"] = task_name
+        data["ansible_task_id"] = self.task_id
+        data["ansible_result"] = self._dump_results(result._result)
 
         self.errors += 1
         if self.ls_format_version == "v2":
             self.logger.error(
                 "UNREACHABLE | %s | HOST | %s | RESULT | %s",
-                task_name, self.hostname,
-                self._dump_results(result._result), extra=data
+                task_name,
+                self.hostname,
+                self._dump_results(result._result),
+                extra=data,
             )
         else:
             self.logger.error("ansible unreachable", extra=data)
 
     def v2_runner_on_async_failed(self, result, **kwargs):
-        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+        task_name = str(result._task).replace("TASK: ", "").replace("HANDLER: ", "")
 
         data = self.base_data.copy()
-        data['ansible_type'] = "task"
-        data['status'] = "FAILED"
-        data['ansible_host'] = result._host.name
-        data['ansible_play_id'] = self.play_id
-        data['ansible_play_name'] = self.play_name
-        data['ansible_task'] = task_name
-        data['ansible_task_id'] = self.task_id
-        data['ansible_result'] = self._dump_results(result._result)
+        data["ansible_type"] = "task"
+        data["status"] = "FAILED"
+        data["ansible_host"] = result._host.name
+        data["ansible_play_id"] = self.play_id
+        data["ansible_play_name"] = self.play_name
+        data["ansible_task"] = task_name
+        data["ansible_task_id"] = self.task_id
+        data["ansible_result"] = self._dump_results(result._result)
 
         self.errors += 1
         if self.ls_format_version == "v2":
             self.logger.error(
                 "ASYNC FAILED | %s | HOST | %s | RESULT | %s",
-                task_name, self.hostname,
-                self._dump_results(result._result), extra=data
+                task_name,
+                self.hostname,
+                self._dump_results(result._result),
+                extra=data,
             )
         else:
             self.logger.error("ansible async", extra=data)

plugins/callback/mail.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2012, Dag Wieers <dag@wieers.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -81,10 +79,10 @@ options:
     version_added: 8.2.0
 """
 
+import email.utils
 import json
 import os
 import re
-import email.utils
 import smtplib
 
 from ansible.module_utils.common.text.converters import to_bytes
@@ -93,33 +91,33 @@ from ansible.plugins.callback import CallbackBase
 
 
 class CallbackModule(CallbackBase):
-    ''' This Ansible callback plugin mails errors to interested parties. '''
+    """This Ansible callback plugin mails errors to interested parties."""
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.mail'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.mail"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.sender = None
-        self.to = 'root'
-        self.smtphost = os.getenv('SMTPHOST', 'localhost')
+        self.to = "root"
+        self.smtphost = os.getenv("SMTPHOST", "localhost")
         self.smtpport = 25
         self.cc = None
         self.bcc = None
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        self.sender = self.get_option("sender")
+        self.to = self.get_option("to")
+        self.smtphost = self.get_option("mta")
+        self.smtpport = self.get_option("mtaport")
+        self.cc = self.get_option("cc")
+        self.bcc = self.get_option("bcc")
 
-        self.sender = self.get_option('sender')
-        self.to = self.get_option('to')
-        self.smtphost = self.get_option('mta')
-        self.smtpport = self.get_option('mtaport')
-        self.cc = self.get_option('cc')
-        self.bcc = self.get_option('bcc')
-
-    def mail(self, subject='Ansible error mail', body=None):
+    def mail(self, subject="Ansible error mail", body=None):
         if body is None:
             body = subject
 
@@ -133,14 +131,14 @@ class CallbackModule(CallbackBase):
         if self.bcc:
             bcc_addresses = email.utils.getaddresses(self.bcc)
 
-        content = f'Date: {email.utils.formatdate()}\n'
-        content += f'From: {email.utils.formataddr(sender_address)}\n'
+        content = f"Date: {email.utils.formatdate()}\n"
+        content += f"From: {email.utils.formataddr(sender_address)}\n"
         if self.to:
             content += f"To: {', '.join([email.utils.formataddr(pair) for pair in to_addresses])}\n"
         if self.cc:
             content += f"Cc: {', '.join([email.utils.formataddr(pair) for pair in cc_addresses])}\n"
         content += f"Message-ID: {email.utils.make_msgid(domain=self.get_option('message_id_domain'))}\n"
-        content += f'Subject: {subject.strip()}\n\n'
+        content += f"Subject: {subject.strip()}\n\n"
         content += body
 
         addresses = to_addresses
@@ -150,23 +148,23 @@ class CallbackModule(CallbackBase):
             addresses += bcc_addresses
 
         if not addresses:
-            self._display.warning('No receiver has been specified for the mail callback plugin.')
+            self._display.warning("No receiver has been specified for the mail callback plugin.")
 
         smtp.sendmail(self.sender, [address for name, address in addresses], to_bytes(content))
 
         smtp.quit()
 
     def subject_msg(self, multiline, failtype, linenr):
-        msg = multiline.strip('\r\n').splitlines()[linenr]
-        return f'{failtype}: {msg}'
+        msg = multiline.strip("\r\n").splitlines()[linenr]
+        return f"{failtype}: {msg}"
 
     def indent(self, multiline, indent=8):
-        return re.sub('^', ' ' * indent, multiline, flags=re.MULTILINE)
+        return re.sub("^", " " * indent, multiline, flags=re.MULTILINE)
 
     def body_blob(self, multiline, texttype):
-        ''' Turn some text output in a well-indented block for sending in a mail body '''
-        intro = f'with the following {texttype}:\n\n'
-        blob = "\n".join(multiline.strip('\r\n').splitlines())
+        """Turn some text output in a well-indented block for sending in a mail body"""
+        intro = f"with the following {texttype}:\n\n"
+        blob = "\n".join(multiline.strip("\r\n").splitlines())
         return f"{intro}{self.indent(blob)}\n"
 
     def mail_result(self, result, failtype):
@@ -177,83 +175,87 @@ class CallbackModule(CallbackBase):
         # Add subject
         if self.itembody:
             subject = self.itemsubject
-        elif result._result.get('failed_when_result') is True:
+        elif result._result.get("failed_when_result") is True:
             subject = "Failed due to 'failed_when' condition"
-        elif result._result.get('msg'):
-            subject = self.subject_msg(result._result['msg'], failtype, 0)
-        elif result._result.get('stderr'):
-            subject = self.subject_msg(result._result['stderr'], failtype, -1)
-        elif result._result.get('stdout'):
-            subject = self.subject_msg(result._result['stdout'], failtype, -1)
-        elif result._result.get('exception'):  # Unrelated exceptions are added to output :-/
-            subject = self.subject_msg(result._result['exception'], failtype, -1)
+        elif result._result.get("msg"):
+            subject = self.subject_msg(result._result["msg"], failtype, 0)
+        elif result._result.get("stderr"):
+            subject = self.subject_msg(result._result["stderr"], failtype, -1)
+        elif result._result.get("stdout"):
+            subject = self.subject_msg(result._result["stdout"], failtype, -1)
+        elif result._result.get("exception"):  # Unrelated exceptions are added to output :-/
+            subject = self.subject_msg(result._result["exception"], failtype, -1)
         else:
-            subject = f'{failtype}: {result._task.name or result._task.action}'
+            subject = f"{failtype}: {result._task.name or result._task.action}"
 
         # Make playbook name visible (e.g. in Outlook/Gmail condensed view)
-        body = f'Playbook: {os.path.basename(self.playbook._file_name)}\n'
+        body = f"Playbook: {os.path.basename(self.playbook._file_name)}\n"
         if result._task.name:
-            body += f'Task: {result._task.name}\n'
-        body += f'Module: {result._task.action}\n'
-        body += f'Host: {host}\n'
-        body += '\n'
+            body += f"Task: {result._task.name}\n"
+        body += f"Module: {result._task.action}\n"
+        body += f"Host: {host}\n"
+        body += "\n"
 
         # Add task information (as much as possible)
-        body += 'The following task failed:\n\n'
-        if 'invocation' in result._result:
-            body += self.indent(f"{result._task.action}: {json.dumps(result._result['invocation']['module_args'], indent=4)}\n")
+        body += "The following task failed:\n\n"
+        if "invocation" in result._result:
+            body += self.indent(
+                f"{result._task.action}: {json.dumps(result._result['invocation']['module_args'], indent=4)}\n"
+            )
         elif result._task.name:
-            body += self.indent(f'{result._task.name} ({result._task.action})\n')
+            body += self.indent(f"{result._task.name} ({result._task.action})\n")
         else:
-            body += self.indent(f'{result._task.action}\n')
-        body += '\n'
+            body += self.indent(f"{result._task.action}\n")
+        body += "\n"
 
         # Add item / message
         if self.itembody:
             body += self.itembody
-        elif result._result.get('failed_when_result') is True:
-            fail_cond_list = '\n- '.join(result._task.failed_when)
+        elif result._result.get("failed_when_result") is True:
+            fail_cond_list = "\n- ".join(result._task.failed_when)
             fail_cond = self.indent(f"failed_when:\n- {fail_cond_list}")
             body += f"due to the following condition:\n\n{fail_cond}\n\n"
-        elif result._result.get('msg'):
-            body += self.body_blob(result._result['msg'], 'message')
+        elif result._result.get("msg"):
+            body += self.body_blob(result._result["msg"], "message")
 
         # Add stdout / stderr / exception / warnings / deprecations
-        if result._result.get('stdout'):
-            body += self.body_blob(result._result['stdout'], 'standard output')
-        if result._result.get('stderr'):
-            body += self.body_blob(result._result['stderr'], 'error output')
-        if result._result.get('exception'):  # Unrelated exceptions are added to output :-/
-            body += self.body_blob(result._result['exception'], 'exception')
-        if result._result.get('warnings'):
-            for i in range(len(result._result.get('warnings'))):
-                body += self.body_blob(result._result['warnings'][i], f'exception {i + 1}')
-        if result._result.get('deprecations'):
-            for i in range(len(result._result.get('deprecations'))):
-                body += self.body_blob(result._result['deprecations'][i], f'exception {i + 1}')
+        if result._result.get("stdout"):
+            body += self.body_blob(result._result["stdout"], "standard output")
+        if result._result.get("stderr"):
+            body += self.body_blob(result._result["stderr"], "error output")
+        if result._result.get("exception"):  # Unrelated exceptions are added to output :-/
+            body += self.body_blob(result._result["exception"], "exception")
+        if result._result.get("warnings"):
+            for i in range(len(result._result.get("warnings"))):
+                body += self.body_blob(result._result["warnings"][i], f"exception {i + 1}")
+        if result._result.get("deprecations"):
+            for i in range(len(result._result.get("deprecations"))):
+                body += self.body_blob(result._result["deprecations"][i], f"exception {i + 1}")
 
-        body += 'and a complete dump of the error:\n\n'
-        body += self.indent(f'{failtype}: {json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4)}')
+        body += "and a complete dump of the error:\n\n"
+        body += self.indent(f"{failtype}: {json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4)}")
 
         self.mail(subject=subject, body=body)
 
     def v2_playbook_on_start(self, playbook):
         self.playbook = playbook
-        self.itembody = ''
+        self.itembody = ""
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
         if ignore_errors:
             return
 
-        self.mail_result(result, 'Failed')
+        self.mail_result(result, "Failed")
 
     def v2_runner_on_unreachable(self, result):
-        self.mail_result(result, 'Unreachable')
+        self.mail_result(result, "Unreachable")
 
     def v2_runner_on_async_failed(self, result):
-        self.mail_result(result, 'Async failure')
+        self.mail_result(result, "Async failure")
 
     def v2_runner_item_on_failed(self, result):
         # Pass item information to task failure
-        self.itemsubject = result._result['msg']
-        self.itembody += self.body_blob(json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4), f"failed item dump '{result._result['item']}'")
+        self.itemsubject = result._result["msg"]
+        self.itembody += self.body_blob(
+            json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4), f"failed item dump '{result._result['item']}'"
+        )

plugins/callback/nrdp.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018 Remi Verchere <remi@verchere.fr>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -74,13 +73,13 @@ from ansible.plugins.callback import CallbackBase
 
 
 class CallbackModule(CallbackBase):
-    '''
+    """
     send ansible-playbook to Nagios server using nrdp protocol
-    '''
+    """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.nrdp'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.nrdp"
     CALLBACK_NEEDS_WHITELIST = True
 
     # Nagios states
@@ -90,34 +89,35 @@ class CallbackModule(CallbackBase):
     UNKNOWN = 3
 
     def __init__(self):
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         self.printed_playbook = False
         self.playbook_name = None
         self.play = None
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.url = self.get_option('url')
-        if not self.url.endswith('/'):
-            self.url += '/'
-        self.token = self.get_option('token')
-        self.hostname = self.get_option('hostname')
-        self.servicename = self.get_option('servicename')
-        self.validate_nrdp_certs = self.get_option('validate_certs')
+        self.url = self.get_option("url")
+        if not self.url.endswith("/"):
+            self.url += "/"
+        self.token = self.get_option("token")
+        self.hostname = self.get_option("hostname")
+        self.servicename = self.get_option("servicename")
+        self.validate_nrdp_certs = self.get_option("validate_certs")
 
-        if (self.url or self.token or self.hostname or
-                self.servicename) is None:
-            self._display.warning("NRDP callback wants the NRDP_URL,"
-                                  " NRDP_TOKEN, NRDP_HOSTNAME,"
-                                  " NRDP_SERVICENAME"
-                                  " environment variables'."
-                                  " The NRDP callback plugin is disabled.")
+        if (self.url or self.token or self.hostname or self.servicename) is None:
+            self._display.warning(
+                "NRDP callback wants the NRDP_URL,"
+                " NRDP_TOKEN, NRDP_HOSTNAME,"
+                " NRDP_SERVICENAME"
+                " environment variables'."
+                " The NRDP callback plugin is disabled."
+            )
             self.disabled = True
 
     def _send_nrdp(self, state, msg):
-        '''
+        """
         nrpd service check send XMLDATA like this:
         <?xml version='1.0'?>
             <checkresults>
@@ -128,7 +128,7 @@ class CallbackModule(CallbackBase):
                     <output>WARNING: Danger Will Robinson!|perfdata</output>
                 </checkresult>
             </checkresults>
-        '''
+        """
         xmldata = "<?xml version='1.0'?>\n"
         xmldata += "<checkresults>\n"
         xmldata += "<checkresult type='service'>\n"
@@ -139,31 +139,24 @@ class CallbackModule(CallbackBase):
         xmldata += "</checkresult>\n"
         xmldata += "</checkresults>\n"
 
-        body = {
-            'cmd': 'submitcheck',
-            'token': self.token,
-            'XMLDATA': to_bytes(xmldata)
-        }
+        body = {"cmd": "submitcheck", "token": self.token, "XMLDATA": to_bytes(xmldata)}
 
         try:
-            response = open_url(self.url,
-                                data=urlencode(body),
-                                method='POST',
-                                validate_certs=self.validate_nrdp_certs)
+            response = open_url(self.url, data=urlencode(body), method="POST", validate_certs=self.validate_nrdp_certs)
             return response.read()
         except Exception as ex:
             self._display.warning(f"NRDP callback cannot send result {ex}")
 
     def v2_playbook_on_play_start(self, play):
-        '''
+        """
         Display Playbook and play start messages
-        '''
+        """
         self.play = play
 
     def v2_playbook_on_stats(self, stats):
-        '''
+        """
         Display info about playbook statistics
-        '''
+        """
         name = self.play
         gstats = ""
         hosts = sorted(stats.processed.keys())
@@ -171,13 +164,14 @@ class CallbackModule(CallbackBase):
         for host in hosts:
             stat = stats.summarize(host)
             gstats += (
-                f"'{host}_ok'={stat['ok']} '{host}_changed'={stat['changed']} '{host}_unreachable'={stat['unreachable']} '{host}_failed'={stat['failures']} "
+                f"'{host}_ok'={stat['ok']} '{host}_changed'={stat['changed']}"
+                f" '{host}_unreachable'={stat['unreachable']} '{host}_failed'={stat['failures']} "
             )
             # Critical when failed tasks or unreachable host
-            critical += stat['failures']
-            critical += stat['unreachable']
+            critical += stat["failures"]
+            critical += stat["unreachable"]
             # Warning when changed tasks
-            warning += stat['changed']
+            warning += stat["changed"]
 
         msg = f"{name} | {gstats}"
         if critical:

plugins/callback/null.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -21,11 +20,10 @@ from ansible.plugins.callback import CallbackBase
 
 
 class CallbackModule(CallbackBase):
-
-    '''
+    """
     This callback won't print messages to stdout when new callback events are received.
-    '''
+    """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.null'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.null"

plugins/callback/opentelemetry.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2021, Victor Martinez <VictorMartinezRubio@gmail.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -146,22 +145,18 @@ from ansible.errors import AnsibleError
 from ansible.module_utils.ansible_release import __version__ as ansible_version
 from ansible.plugins.callback import CallbackBase
 
+OTEL_LIBRARY_IMPORT_ERROR: ImportError | None
 try:
     from opentelemetry import trace
-    from opentelemetry.trace import SpanKind
     from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter as GRPCOTLPSpanExporter
     from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter as HTTPOTLPSpanExporter
     from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-    from opentelemetry.trace.status import Status, StatusCode
-    from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
     from opentelemetry.sdk.trace import TracerProvider
-    from opentelemetry.sdk.trace.export import (
-        BatchSpanProcessor,
-        SimpleSpanProcessor
-    )
-    from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
-        InMemorySpanExporter
-    )
+    from opentelemetry.sdk.trace.export import BatchSpanProcessor, SimpleSpanProcessor
+    from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
+    from opentelemetry.trace import SpanKind
+    from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
+    from opentelemetry.trace.status import Status, StatusCode
 except ImportError as imp_exc:
     OTEL_LIBRARY_IMPORT_ERROR = imp_exc
 else:
@@ -186,9 +181,9 @@ class TaskData:
 
     def add_host(self, host):
         if host.uuid in self.host_data:
-            if host.status == 'included':
+            if host.status == "included":
                 # concatenate task include output from multiple items
-                host.result = f'{self.host_data[host.uuid].result}\n{host.result}'
+                host.result = f"{self.host_data[host.uuid].result}\n{host.result}"
             else:
                 return
 
@@ -208,14 +203,14 @@ class HostData:
         self.finish = time_ns()
 
 
-class OpenTelemetrySource(object):
+class OpenTelemetrySource:
     def __init__(self, display):
         self.ansible_playbook = ""
         self.session = str(uuid.uuid4())
         self.host = socket.gethostname()
         try:
             self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
+        except Exception:
             self.ip_address = None
         self.user = getpass.getuser()
 
@@ -223,11 +218,11 @@ class OpenTelemetrySource(object):
 
     def traceparent_context(self, traceparent):
         carrier = dict()
-        carrier['traceparent'] = traceparent
+        carrier["traceparent"] = traceparent
         return TraceContextTextMapPropagator().extract(carrier=carrier)
 
     def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
+        """record the start of a task for one or more hosts"""
 
         uuid = task._uuid
 
@@ -245,53 +240,51 @@ class OpenTelemetrySource(object):
         tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
 
     def finish_task(self, tasks_data, status, result, dump):
-        """ record the results of a task for a single host """
+        """record the results of a task for a single host"""
 
         task_uuid = result._task._uuid
 
-        if hasattr(result, '_host') and result._host is not None:
+        if hasattr(result, "_host") and result._host is not None:
             host_uuid = result._host._uuid
             host_name = result._host.name
         else:
-            host_uuid = 'include'
-            host_name = 'include'
+            host_uuid = "include"
+            host_name = "include"
 
         task = tasks_data[task_uuid]
 
         task.dump = dump
         task.add_host(HostData(host_uuid, host_name, status, result))
 
-    def generate_distributed_traces(self,
-                                    otel_service_name,
-                                    ansible_playbook,
-                                    tasks_data,
-                                    status,
-                                    traceparent,
-                                    disable_logs,
-                                    disable_attributes_in_logs,
-                                    otel_exporter_otlp_traces_protocol,
-                                    store_spans_in_file):
-        """ generate distributed traces from the collected TaskData and HostData """
+    def generate_distributed_traces(
+        self,
+        otel_service_name,
+        ansible_playbook,
+        tasks_data,
+        status,
+        traceparent,
+        disable_logs,
+        disable_attributes_in_logs,
+        otel_exporter_otlp_traces_protocol,
+        store_spans_in_file,
+    ):
+        """generate distributed traces from the collected TaskData and HostData"""
 
         tasks = []
         parent_start_time = None
-        for task_uuid, task in tasks_data.items():
+        for task in tasks_data.values():
             if parent_start_time is None:
                 parent_start_time = task.start
             tasks.append(task)
 
-        trace.set_tracer_provider(
-            TracerProvider(
-                resource=Resource.create({SERVICE_NAME: otel_service_name})
-            )
-        )
+        trace.set_tracer_provider(TracerProvider(resource=Resource.create({SERVICE_NAME: otel_service_name})))
 
         otel_exporter = None
         if store_spans_in_file:
             otel_exporter = InMemorySpanExporter()
             processor = SimpleSpanProcessor(otel_exporter)
         else:
-            if otel_exporter_otlp_traces_protocol == 'grpc':
+            if otel_exporter_otlp_traces_protocol == "grpc":
                 otel_exporter = GRPCOTLPSpanExporter()
             else:
                 otel_exporter = HTTPOTLPSpanExporter()
@@ -301,8 +294,12 @@ class OpenTelemetrySource(object):
 
         tracer = trace.get_tracer(__name__)
 
-        with tracer.start_as_current_span(ansible_playbook, context=self.traceparent_context(traceparent),
-                                          start_time=parent_start_time, kind=SpanKind.SERVER) as parent:
+        with tracer.start_as_current_span(
+            ansible_playbook,
+            context=self.traceparent_context(traceparent),
+            start_time=parent_start_time,
+            kind=SpanKind.SERVER,
+        ) as parent:
             parent.set_status(status)
             # Populate trace metadata attributes
             parent.set_attribute("ansible.version", ansible_version)
@@ -312,43 +309,45 @@ class OpenTelemetrySource(object):
                 parent.set_attribute("ansible.host.ip", self.ip_address)
             parent.set_attribute("ansible.host.user", self.user)
             for task in tasks:
-                for host_uuid, host_data in task.host_data.items():
+                for host_data in task.host_data.values():
                     with tracer.start_as_current_span(task.name, start_time=task.start, end_on_exit=False) as span:
                         self.update_span_data(task, host_data, span, disable_logs, disable_attributes_in_logs)
 
         return otel_exporter
 
     def update_span_data(self, task_data, host_data, span, disable_logs, disable_attributes_in_logs):
-        """ update the span with the given TaskData and HostData """
+        """update the span with the given TaskData and HostData"""
 
-        name = f'[{host_data.name}] {task_data.play}: {task_data.name}'
+        name = f"[{host_data.name}] {task_data.play}: {task_data.name}"
 
-        message = 'success'
+        message = "success"
         res = {}
         rc = 0
         status = Status(status_code=StatusCode.OK)
-        if host_data.status != 'included':
+        if host_data.status != "included":
             # Support loops
             enriched_error_message = None
-            if 'results' in host_data.result._result:
-                if host_data.status == 'failed':
-                    message = self.get_error_message_from_results(host_data.result._result['results'], task_data.action)
-                    enriched_error_message = self.enrich_error_message_from_results(host_data.result._result['results'], task_data.action)
+            if "results" in host_data.result._result:
+                if host_data.status == "failed":
+                    message = self.get_error_message_from_results(host_data.result._result["results"], task_data.action)
+                    enriched_error_message = self.enrich_error_message_from_results(
+                        host_data.result._result["results"], task_data.action
+                    )
             else:
                 res = host_data.result._result
-                rc = res.get('rc', 0)
-                if host_data.status == 'failed':
+                rc = res.get("rc", 0)
+                if host_data.status == "failed":
                     message = self.get_error_message(res)
                     enriched_error_message = self.enrich_error_message(res)
 
-            if host_data.status == 'failed':
+            if host_data.status == "failed":
                 status = Status(status_code=StatusCode.ERROR, description=message)
                 # Record an exception with the task message
                 span.record_exception(BaseException(enriched_error_message))
-            elif host_data.status == 'skipped':
-                message = res['skip_reason'] if 'skip_reason' in res else 'skipped'
+            elif host_data.status == "skipped":
+                message = res["skip_reason"] if "skip_reason" in res else "skipped"
                 status = Status(status_code=StatusCode.UNSET)
-            elif host_data.status == 'ignored':
+            elif host_data.status == "ignored":
                 status = Status(status_code=StatusCode.UNSET)
 
         span.set_status(status)
@@ -360,7 +359,7 @@ class OpenTelemetrySource(object):
             "ansible.task.name": name,
             "ansible.task.result": rc,
             "ansible.task.host.name": host_data.name,
-            "ansible.task.host.status": host_data.status
+            "ansible.task.host.status": host_data.status,
         }
         if isinstance(task_data.args, dict) and "gather_facts" not in task_data.action:
             names = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.keys())
@@ -380,10 +379,10 @@ class OpenTelemetrySource(object):
         span.end(end_time=host_data.finish)
 
     def set_span_attributes(self, span, attributes):
-        """ update the span attributes with the given attributes if not None """
+        """update the span attributes with the given attributes if not None"""
 
         if span is None and self._display is not None:
-            self._display.warning('span object is None. Please double check if that is expected.')
+            self._display.warning("span object is None. Please double check if that is expected.")
         else:
             if attributes is not None:
                 span.set_attributes(attributes)
@@ -411,7 +410,18 @@ class OpenTelemetrySource(object):
     @staticmethod
     def url_from_args(args):
         # the order matters
-        url_args = ("url", "api_url", "baseurl", "repo", "server_url", "chart_repo_url", "registry_url", "endpoint", "uri", "updates_url")
+        url_args = (
+            "url",
+            "api_url",
+            "baseurl",
+            "repo",
+            "server_url",
+            "chart_repo_url",
+            "registry_url",
+            "endpoint",
+            "uri",
+            "updates_url",
+        )
         for arg in url_args:
             if args is not None and args.get(arg):
                 return args.get(arg)
@@ -436,33 +446,33 @@ class OpenTelemetrySource(object):
 
     @staticmethod
     def get_error_message(result):
-        if result.get('exception') is not None:
-            return OpenTelemetrySource._last_line(result['exception'])
-        return result.get('msg', 'failed')
+        if result.get("exception") is not None:
+            return OpenTelemetrySource._last_line(result["exception"])
+        return result.get("msg", "failed")
 
     @staticmethod
     def get_error_message_from_results(results, action):
         for result in results:
-            if result.get('failed', False):
+            if result.get("failed", False):
                 return f"{action}({result.get('item', 'none')}) - {OpenTelemetrySource.get_error_message(result)}"
 
     @staticmethod
     def _last_line(text):
-        lines = text.strip().split('\n')
+        lines = text.strip().split("\n")
         return lines[-1]
 
     @staticmethod
     def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return f"message: \"{message}\"\nexception: \"{exception}\"\nstderr: \"{stderr}\""
+        message = result.get("msg", "failed")
+        exception = result.get("exception")
+        stderr = result.get("stderr")
+        return f'message: "{message}"\nexception: "{exception}"\nstderr: "{stderr}"'
 
     @staticmethod
     def enrich_error_message_from_results(results, action):
         message = ""
         for result in results:
-            if result.get('failed', False):
+            if result.get("failed", False):
                 message = f"{action}({result.get('item', 'none')}) - {OpenTelemetrySource.enrich_error_message(result)}\n{message}"
         return message
 
@@ -473,12 +483,12 @@ class CallbackModule(CallbackBase):
     """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.opentelemetry'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.opentelemetry"
     CALLBACK_NEEDS_ENABLED = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.hide_task_arguments = None
         self.disable_attributes_in_logs = None
         self.disable_logs = None
@@ -494,7 +504,7 @@ class CallbackModule(CallbackBase):
 
         if OTEL_LIBRARY_IMPORT_ERROR:
             raise AnsibleError(
-                'The `opentelemetry-api`, `opentelemetry-exporter-otlp` or `opentelemetry-sdk` must be installed to use this plugin'
+                "The `opentelemetry-api`, `opentelemetry-exporter-otlp` or `opentelemetry-sdk` must be installed to use this plugin"
             ) from OTEL_LIBRARY_IMPORT_ERROR
 
         self.tasks_data = OrderedDict()
@@ -502,37 +512,35 @@ class CallbackModule(CallbackBase):
         self.opentelemetry = OpenTelemetrySource(display=self._display)
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        environment_variable = self.get_option('enable_from_environment')
-        if environment_variable is not None and os.environ.get(environment_variable, 'false').lower() != 'true':
+        environment_variable = self.get_option("enable_from_environment")
+        if environment_variable is not None and os.environ.get(environment_variable, "false").lower() != "true":
             self.disabled = True
             self._display.warning(
                 f"The `enable_from_environment` option has been set and {environment_variable} is not enabled. Disabling the `opentelemetry` callback plugin."
             )
 
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
+        self.hide_task_arguments = self.get_option("hide_task_arguments")
 
-        self.disable_attributes_in_logs = self.get_option('disable_attributes_in_logs')
+        self.disable_attributes_in_logs = self.get_option("disable_attributes_in_logs")
 
-        self.disable_logs = self.get_option('disable_logs')
+        self.disable_logs = self.get_option("disable_logs")
 
-        self.store_spans_in_file = self.get_option('store_spans_in_file')
+        self.store_spans_in_file = self.get_option("store_spans_in_file")
 
-        self.otel_service_name = self.get_option('otel_service_name')
+        self.otel_service_name = self.get_option("otel_service_name")
 
         if not self.otel_service_name:
-            self.otel_service_name = 'ansible'
+            self.otel_service_name = "ansible"
 
         # See https://github.com/open-telemetry/opentelemetry-specification/issues/740
-        self.traceparent = self.get_option('traceparent')
+        self.traceparent = self.get_option("traceparent")
 
-        self.otel_exporter_otlp_traces_protocol = self.get_option('otel_exporter_otlp_traces_protocol')
+        self.otel_exporter_otlp_traces_protocol = self.get_option("otel_exporter_otlp_traces_protocol")
 
     def dump_results(self, task, result):
-        """ dump the results if disable_logs is not enabled """
+        """dump the results if disable_logs is not enabled"""
         if self.disable_logs:
             return ""
         # ansible.builtin.uri contains the response in the json field
@@ -552,74 +560,40 @@ class CallbackModule(CallbackBase):
         self.play_name = play.get_name()
 
     def v2_runner_on_no_hosts(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.opentelemetry.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_task_start(self, task, is_conditional):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.opentelemetry.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_cleanup_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.opentelemetry.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_playbook_on_handler_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
+        self.opentelemetry.start_task(self.tasks_data, self.hide_task_arguments, self.play_name, task)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
         if ignore_errors:
-            status = 'ignored'
+            status = "ignored"
         else:
-            status = 'failed'
+            status = "failed"
             self.errors += 1
 
         self.opentelemetry.finish_task(
-            self.tasks_data,
-            status,
-            result,
-            self.dump_results(self.tasks_data[result._task._uuid], result)
+            self.tasks_data, status, result, self.dump_results(self.tasks_data[result._task._uuid], result)
         )
 
     def v2_runner_on_ok(self, result):
         self.opentelemetry.finish_task(
-            self.tasks_data,
-            'ok',
-            result,
-            self.dump_results(self.tasks_data[result._task._uuid], result)
+            self.tasks_data, "ok", result, self.dump_results(self.tasks_data[result._task._uuid], result)
         )
 
     def v2_runner_on_skipped(self, result):
         self.opentelemetry.finish_task(
-            self.tasks_data,
-            'skipped',
-            result,
-            self.dump_results(self.tasks_data[result._task._uuid], result)
+            self.tasks_data, "skipped", result, self.dump_results(self.tasks_data[result._task._uuid], result)
         )
 
     def v2_playbook_on_include(self, included_file):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'included',
-            included_file,
-            ""
-        )
+        self.opentelemetry.finish_task(self.tasks_data, "included", included_file, "")
 
     def v2_playbook_on_stats(self, stats):
         if self.errors == 0:
@@ -635,7 +609,7 @@ class CallbackModule(CallbackBase):
             self.disable_logs,
             self.disable_attributes_in_logs,
             self.otel_exporter_otlp_traces_protocol,
-            self.store_spans_in_file
+            self.store_spans_in_file,
         )
 
         if self.store_spans_in_file:

plugins/callback/print_task.py

@@ -1,10 +1,8 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2025, Max Mitschke <maxmitschke@fastmail.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = r"""
 name: print_task
@@ -24,13 +22,13 @@ ansible.cfg: |-
   callbacks_enabled=community.general.print_task
 """
 
-from yaml import load, dump
+from yaml import dump, load
 
 try:
     from yaml import CSafeDumper as SafeDumper
     from yaml import CSafeLoader as SafeLoader
 except ImportError:
-    from yaml import SafeDumper, SafeLoader
+    from yaml import SafeDumper, SafeLoader  # type: ignore
 
 from ansible.plugins.callback import CallbackBase
 
@@ -39,18 +37,19 @@ class CallbackModule(CallbackBase):
     """
     This callback module tells you how long your plays ran for.
     """
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'aggregate'
-    CALLBACK_NAME = 'community.general.print_task'
+    CALLBACK_TYPE = "aggregate"
+    CALLBACK_NAME = "community.general.print_task"
 
     CALLBACK_NEEDS_ENABLED = True
 
     def __init__(self):
-        super(CallbackModule, self).__init__()
+        super().__init__()
         self._printed_message = False
 
     def _print_task(self, task):
-        if hasattr(task, '_ds'):
+        if hasattr(task, "_ds"):
             task_snippet = load(str([task._ds.copy()]), Loader=SafeLoader)
             task_yaml = dump(task_snippet, sort_keys=False, Dumper=SafeDumper)
             self._display.display(f"\n{task_yaml}\n")

plugins/callback/say.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -19,9 +18,9 @@ description:
   - This plugin uses C(say) or C(espeak) to "speak" about play events.
 """
 
+import os
 import platform
 import subprocess
-import os
 
 from ansible.module_utils.common.process import get_bin_path
 from ansible.plugins.callback import CallbackBase
@@ -31,14 +30,14 @@ class CallbackModule(CallbackBase):
     """
     makes Ansible much more exciting.
     """
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.say'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.say"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self):
-
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         self.FAILED_VOICE = None
         self.REGULAR_VOICE = None
@@ -46,21 +45,23 @@ class CallbackModule(CallbackBase):
         self.LASER_VOICE = None
 
         try:
-            self.synthesizer = get_bin_path('say')
-            if platform.system() != 'Darwin':
+            self.synthesizer = get_bin_path("say")
+            if platform.system() != "Darwin":
                 # 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter
-                self._display.warning(f"'say' executable found but system is '{platform.system()}': ignoring voice parameter")
+                self._display.warning(
+                    f"'say' executable found but system is '{platform.system()}': ignoring voice parameter"
+                )
             else:
-                self.FAILED_VOICE = 'Zarvox'
-                self.REGULAR_VOICE = 'Trinoids'
-                self.HAPPY_VOICE = 'Cellos'
-                self.LASER_VOICE = 'Princess'
+                self.FAILED_VOICE = "Zarvox"
+                self.REGULAR_VOICE = "Trinoids"
+                self.HAPPY_VOICE = "Cellos"
+                self.LASER_VOICE = "Princess"
         except ValueError:
             try:
-                self.synthesizer = get_bin_path('espeak')
-                self.FAILED_VOICE = 'klatt'
-                self.HAPPY_VOICE = 'f5'
-                self.LASER_VOICE = 'whisper'
+                self.synthesizer = get_bin_path("espeak")
+                self.FAILED_VOICE = "klatt"
+                self.HAPPY_VOICE = "f5"
+                self.LASER_VOICE = "whisper"
             except ValueError:
                 self.synthesizer = None
 
@@ -68,12 +69,14 @@ class CallbackModule(CallbackBase):
         # ansible will not call any callback if disabled is set to True
         if not self.synthesizer:
             self.disabled = True
-            self._display.warning(f"Unable to find either 'say' or 'espeak' executable, plugin {os.path.basename(__file__)} disabled")
+            self._display.warning(
+                f"Unable to find either 'say' or 'espeak' executable, plugin {os.path.basename(__file__)} disabled"
+            )
 
     def say(self, msg, voice):
         cmd = [self.synthesizer, msg]
         if voice:
-            cmd.extend(('-v', voice))
+            cmd.extend(("-v", voice))
         subprocess.call(cmd)
 
     def runner_on_failed(self, host, res, ignore_errors=False):

plugins/callback/selective.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) Fastly, inc 2016
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -40,20 +39,19 @@ EXAMPLES = r"""
 import difflib
 
 from ansible import constants as C
-from ansible.plugins.callback import CallbackBase
 from ansible.module_utils.common.text.converters import to_text
-
+from ansible.plugins.callback import CallbackBase
 
 DONT_COLORIZE = False
 COLORS = {
-    'normal': '\033[0m',
-    'ok': f'\x1b[{C.COLOR_CODES[C.COLOR_OK]}m',
-    'bold': '\033[1m',
-    'not_so_bold': '\033[1m\033[34m',
-    'changed': f'\x1b[{C.COLOR_CODES[C.COLOR_CHANGED]}m',
-    'failed': f'\x1b[{C.COLOR_CODES[C.COLOR_ERROR]}m',
-    'endc': '\033[0m',
-    'skipped': f'\x1b[{C.COLOR_CODES[C.COLOR_SKIP]}m',
+    "normal": "\033[0m",
+    "ok": f"\x1b[{C.COLOR_CODES[C.COLOR_OK]}m",  # type: ignore
+    "bold": "\033[1m",
+    "not_so_bold": "\033[1m\033[34m",
+    "changed": f"\x1b[{C.COLOR_CODES[C.COLOR_CHANGED]}m",  # type: ignore
+    "failed": f"\x1b[{C.COLOR_CODES[C.COLOR_ERROR]}m",  # type: ignore
+    "endc": "\033[0m",
+    "skipped": f"\x1b[{C.COLOR_CODES[C.COLOR_SKIP]}m",  # type: ignore
 }
 
 
@@ -79,22 +77,21 @@ class CallbackModule(CallbackBase):
     """selective.py callback plugin."""
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.selective'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.selective"
 
     def __init__(self, display=None):
         """selective.py callback plugin."""
-        super(CallbackModule, self).__init__(display)
+        super().__init__(display)
         self.last_skipped = False
         self.last_task_name = None
         self.printed_last_task = False
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         global DONT_COLORIZE
-        DONT_COLORIZE = self.get_option('nocolor')
+        DONT_COLORIZE = self.get_option("nocolor")
 
     def _print_task(self, task_name=None):
         if task_name is None:
@@ -106,7 +103,7 @@ class CallbackModule(CallbackBase):
             if self.last_skipped:
                 print()
             line = f"# {task_name} "
-            msg = colorize(f"{line}{'*' * (line_length - len(line))}", 'bold')
+            msg = colorize(f"{line}{'*' * (line_length - len(line))}", "bold")
             print(msg)
 
     def _indent_text(self, text, indent_level):
@@ -114,48 +111,51 @@ class CallbackModule(CallbackBase):
         result_lines = []
         for l in lines:
             result_lines.append(f"{' ' * indent_level}{l}")
-        return '\n'.join(result_lines)
+        return "\n".join(result_lines)
 
     def _print_diff(self, diff, indent_level):
         if isinstance(diff, dict):
             try:
-                diff = '\n'.join(difflib.unified_diff(diff['before'].splitlines(),
-                                                      diff['after'].splitlines(),
-                                                      fromfile=diff.get('before_header',
-                                                                        'new_file'),
-                                                      tofile=diff['after_header']))
+                diff = "\n".join(
+                    difflib.unified_diff(
+                        diff["before"].splitlines(),
+                        diff["after"].splitlines(),
+                        fromfile=diff.get("before_header", "new_file"),
+                        tofile=diff["after_header"],
+                    )
+                )
             except AttributeError:
-                diff = dict_diff(diff['before'], diff['after'])
+                diff = dict_diff(diff["before"], diff["after"])
         if diff:
-            diff = colorize(str(diff), 'changed')
+            diff = colorize(str(diff), "changed")
             print(self._indent_text(diff, indent_level + 4))
 
     def _print_host_or_item(self, host_or_item, changed, msg, diff, is_host, error, stdout, stderr):
         if is_host:
             indent_level = 0
-            name = colorize(host_or_item.name, 'not_so_bold')
+            name = colorize(host_or_item.name, "not_so_bold")
         else:
             indent_level = 4
             if isinstance(host_or_item, dict):
-                if 'key' in host_or_item.keys():
-                    host_or_item = host_or_item['key']
-            name = colorize(to_text(host_or_item), 'bold')
+                if "key" in host_or_item.keys():
+                    host_or_item = host_or_item["key"]
+            name = colorize(to_text(host_or_item), "bold")
 
         if error:
-            color = 'failed'
-            change_string = colorize('FAILED!!!', color)
+            color = "failed"
+            change_string = colorize("FAILED!!!", color)
         else:
-            color = 'changed' if changed else 'ok'
+            color = "changed" if changed else "ok"
             change_string = colorize(f"changed={changed}", color)
 
         msg = colorize(msg, color)
 
         line_length = 120
-        spaces = ' ' * (40 - len(name) - indent_level)
+        spaces = " " * (40 - len(name) - indent_level)
         line = f"{' ' * indent_level}  * {name}{spaces}- {change_string}"
 
         if len(msg) < 50:
-            line += f' -- {msg}'
+            line += f" -- {msg}"
             print(f"{line} {'-' * (line_length - len(line))}---------")
         else:
             print(f"{line} {'-' * (line_length - len(line))}")
@@ -164,10 +164,10 @@ class CallbackModule(CallbackBase):
         if diff:
             self._print_diff(diff, indent_level)
         if stdout:
-            stdout = colorize(stdout, 'failed')
+            stdout = colorize(stdout, "failed")
             print(self._indent_text(stdout, indent_level + 4))
         if stderr:
-            stderr = colorize(stderr, 'failed')
+            stderr = colorize(stderr, "failed")
             print(self._indent_text(stderr, indent_level + 4))
 
     def v2_playbook_on_play_start(self, play):
@@ -182,61 +182,61 @@ class CallbackModule(CallbackBase):
     def _print_task_result(self, result, error=False, **kwargs):
         """Run when a task finishes correctly."""
 
-        if 'print_action' in result._task.tags or error or self._display.verbosity > 1:
+        if "print_action" in result._task.tags or error or self._display.verbosity > 1:
             self._print_task()
             self.last_skipped = False
-            msg = to_text(result._result.get('msg', '')) or\
-                to_text(result._result.get('reason', ''))
+            msg = to_text(result._result.get("msg", "")) or to_text(result._result.get("reason", ""))
 
-            stderr = [result._result.get('exception', None),
-                      result._result.get('module_stderr', None)]
+            stderr = [result._result.get("exception", None), result._result.get("module_stderr", None)]
             stderr = "\n".join([e for e in stderr if e]).strip()
 
-            self._print_host_or_item(result._host,
-                                     result._result.get('changed', False),
-                                     msg,
-                                     result._result.get('diff', None),
-                                     is_host=True,
-                                     error=error,
-                                     stdout=result._result.get('module_stdout', None),
-                                     stderr=stderr.strip(),
-                                     )
-            if 'results' in result._result:
-                for r in result._result['results']:
-                    failed = 'failed' in r and r['failed']
+            self._print_host_or_item(
+                result._host,
+                result._result.get("changed", False),
+                msg,
+                result._result.get("diff", None),
+                is_host=True,
+                error=error,
+                stdout=result._result.get("module_stdout", None),
+                stderr=stderr.strip(),
+            )
+            if "results" in result._result:
+                for r in result._result["results"]:
+                    failed = "failed" in r and r["failed"]
 
-                    stderr = [r.get('exception', None), r.get('module_stderr', None)]
+                    stderr = [r.get("exception", None), r.get("module_stderr", None)]
                     stderr = "\n".join([e for e in stderr if e]).strip()
 
-                    self._print_host_or_item(r[r['ansible_loop_var']],
-                                             r.get('changed', False),
-                                             to_text(r.get('msg', '')),
-                                             r.get('diff', None),
-                                             is_host=False,
-                                             error=failed,
-                                             stdout=r.get('module_stdout', None),
-                                             stderr=stderr.strip(),
-                                             )
+                    self._print_host_or_item(
+                        r[r["ansible_loop_var"]],
+                        r.get("changed", False),
+                        to_text(r.get("msg", "")),
+                        r.get("diff", None),
+                        is_host=False,
+                        error=failed,
+                        stdout=r.get("module_stdout", None),
+                        stderr=stderr.strip(),
+                    )
         else:
             self.last_skipped = True
-            print('.', end="")
+            print(".", end="")
 
     def v2_playbook_on_stats(self, stats):
         """Display info about playbook statistics."""
         print()
         self.printed_last_task = False
-        self._print_task('STATS')
+        self._print_task("STATS")
 
         hosts = sorted(stats.processed.keys())
         for host in hosts:
             s = stats.summarize(host)
 
-            if s['failures'] or s['unreachable']:
-                color = 'failed'
-            elif s['changed']:
-                color = 'changed'
+            if s["failures"] or s["unreachable"]:
+                color = "failed"
+            elif s["changed"]:
+                color = "changed"
             else:
-                color = 'ok'
+                color = "ok"
 
             msg = (
                 f"{host}    : ok={s['ok']}\tchanged={s['changed']}\tfailed={s['failures']}\tunreachable="
@@ -251,14 +251,13 @@ class CallbackModule(CallbackBase):
             self.last_skipped = False
 
             line_length = 120
-            spaces = ' ' * (31 - len(result._host.name) - 4)
+            spaces = " " * (31 - len(result._host.name) - 4)
 
             line = f"  * {colorize(result._host.name, 'not_so_bold')}{spaces}- {colorize('skipped', 'skipped')}"
 
-            reason = result._result.get('skipped_reason', '') or \
-                result._result.get('skip_reason', '')
+            reason = result._result.get("skipped_reason", "") or result._result.get("skip_reason", "")
             if len(reason) < 50:
-                line += f' -- {reason}'
+                line += f" -- {reason}"
                 print(f"{line} {'-' * (line_length - len(line))}---------")
             else:
                 print(f"{line} {'-' * (line_length - len(line))}")

plugins/callback/slack.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2014-2015, Matt Martz <matt@sivel.net>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -71,6 +70,7 @@ from ansible.plugins.callback import CallbackBase
 
 try:
     import prettytable
+
     HAS_PRETTYTABLE = True
 except ImportError:
     HAS_PRETTYTABLE = False
@@ -80,20 +80,20 @@ class CallbackModule(CallbackBase):
     """This is an ansible callback plugin that sends status
     updates to a Slack channel during playbook execution.
     """
+
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.slack'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.slack"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
 
         if not HAS_PRETTYTABLE:
             self.disabled = True
-            self._display.warning('The `prettytable` python module is not '
-                                  'installed. Disabling the Slack callback '
-                                  'plugin.')
+            self._display.warning(
+                "The `prettytable` python module is not installed. Disabling the Slack callback plugin."
+            )
 
         self.playbook_name = None
 
@@ -103,34 +103,34 @@ class CallbackModule(CallbackBase):
         self.guid = uuid.uuid4().hex[:6]
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
-
-        self.webhook_url = self.get_option('webhook_url')
-        self.channel = self.get_option('channel')
-        self.username = self.get_option('username')
-        self.show_invocation = (self._display.verbosity > 1)
-        self.validate_certs = self.get_option('validate_certs')
-        self.http_agent = self.get_option('http_agent')
+        self.webhook_url = self.get_option("webhook_url")
+        self.channel = self.get_option("channel")
+        self.username = self.get_option("username")
+        self.show_invocation = self._display.verbosity > 1
+        self.validate_certs = self.get_option("validate_certs")
+        self.http_agent = self.get_option("http_agent")
         if self.webhook_url is None:
             self.disabled = True
-            self._display.warning('Slack Webhook URL was not provided. The '
-                                  'Slack Webhook URL can be provided using '
-                                  'the `SLACK_WEBHOOK_URL` environment '
-                                  'variable.')
+            self._display.warning(
+                "Slack Webhook URL was not provided. The "
+                "Slack Webhook URL can be provided using "
+                "the `SLACK_WEBHOOK_URL` environment "
+                "variable."
+            )
 
     def send_msg(self, attachments):
         headers = {
-            'Content-type': 'application/json',
+            "Content-type": "application/json",
         }
 
         payload = {
-            'channel': self.channel,
-            'username': self.username,
-            'attachments': attachments,
-            'parse': 'none',
-            'icon_url': ('https://cdn2.hubspot.net/hub/330046/'
-                         'file-449187601-png/ansible_badge.png'),
+            "channel": self.channel,
+            "username": self.username,
+            "attachments": attachments,
+            "parse": "none",
+            "icon_url": ("https://cdn2.hubspot.net/hub/330046/file-449187601-png/ansible_badge.png"),
         }
 
         data = json.dumps(payload)
@@ -146,67 +146,63 @@ class CallbackModule(CallbackBase):
             )
             return response.read()
         except Exception as e:
-            self._display.warning(f'Could not submit message to Slack: {e}')
+            self._display.warning(f"Could not submit message to Slack: {e}")
 
     def v2_playbook_on_start(self, playbook):
         self.playbook_name = os.path.basename(playbook._file_name)
 
-        title = [
-            f'*Playbook initiated* (_{self.guid}_)'
-        ]
+        title = [f"*Playbook initiated* (_{self.guid}_)"]
 
         invocation_items = []
         if context.CLIARGS and self.show_invocation:
-            tags = context.CLIARGS['tags']
-            skip_tags = context.CLIARGS['skip_tags']
-            extra_vars = context.CLIARGS['extra_vars']
-            subset = context.CLIARGS['subset']
-            inventory = [os.path.abspath(i) for i in context.CLIARGS['inventory']]
+            tags = context.CLIARGS["tags"]
+            skip_tags = context.CLIARGS["skip_tags"]
+            extra_vars = context.CLIARGS["extra_vars"]
+            subset = context.CLIARGS["subset"]
+            inventory = [os.path.abspath(i) for i in context.CLIARGS["inventory"]]
 
             invocation_items.append(f"Inventory:  {', '.join(inventory)}")
-            if tags and tags != ['all']:
+            if tags and tags != ["all"]:
                 invocation_items.append(f"Tags:       {', '.join(tags)}")
             if skip_tags:
                 invocation_items.append(f"Skip Tags:  {', '.join(skip_tags)}")
             if subset:
-                invocation_items.append(f'Limit:      {subset}')
+                invocation_items.append(f"Limit:      {subset}")
             if extra_vars:
                 invocation_items.append(f"Extra Vars: {' '.join(extra_vars)}")
 
             title.append(f"by *{context.CLIARGS['remote_user']}*")
 
-        title.append(f'\n\n*{self.playbook_name}*')
-        msg_items = [' '.join(title)]
+        title.append(f"\n\n*{self.playbook_name}*")
+        msg_items = [" ".join(title)]
         if invocation_items:
-            _inv_item = '\n'.join(invocation_items)
-            msg_items.append(f'```\n{_inv_item}\n```')
+            _inv_item = "\n".join(invocation_items)
+            msg_items.append(f"```\n{_inv_item}\n```")
 
-        msg = '\n'.join(msg_items)
+        msg = "\n".join(msg_items)
 
-        attachments = [{
-            'fallback': msg,
-            'fields': [
-                {
-                    'value': msg
-                }
-            ],
-            'color': 'warning',
-            'mrkdwn_in': ['text', 'fallback', 'fields'],
-        }]
+        attachments = [
+            {
+                "fallback": msg,
+                "fields": [{"value": msg}],
+                "color": "warning",
+                "mrkdwn_in": ["text", "fallback", "fields"],
+            }
+        ]
 
         self.send_msg(attachments=attachments)
 
     def v2_playbook_on_play_start(self, play):
         """Display Play start messages"""
 
-        name = play.name or f'Play name not specified ({play._uuid})'
-        msg = f'*Starting play* (_{self.guid}_)\n\n*{name}*'
+        name = play.name or f"Play name not specified ({play._uuid})"
+        msg = f"*Starting play* (_{self.guid}_)\n\n*{name}*"
         attachments = [
             {
-                'fallback': msg,
-                'text': msg,
-                'color': 'warning',
-                'mrkdwn_in': ['text', 'fallback', 'fields'],
+                "fallback": msg,
+                "text": msg,
+                "color": "warning",
+                "mrkdwn_in": ["text", "fallback", "fields"],
             }
         ]
         self.send_msg(attachments=attachments)
@@ -216,8 +212,7 @@ class CallbackModule(CallbackBase):
 
         hosts = sorted(stats.processed.keys())
 
-        t = prettytable.PrettyTable(['Host', 'Ok', 'Changed', 'Unreachable',
-                                     'Failures', 'Rescued', 'Ignored'])
+        t = prettytable.PrettyTable(["Host", "Ok", "Changed", "Unreachable", "Failures", "Rescued", "Ignored"])
 
         failures = False
         unreachable = False
@@ -225,38 +220,28 @@ class CallbackModule(CallbackBase):
         for h in hosts:
             s = stats.summarize(h)
 
-            if s['failures'] > 0:
+            if s["failures"] > 0:
                 failures = True
-            if s['unreachable'] > 0:
+            if s["unreachable"] > 0:
                 unreachable = True
 
-            t.add_row([h] + [s[k] for k in ['ok', 'changed', 'unreachable',
-                                            'failures', 'rescued', 'ignored']])
+            t.add_row([h] + [s[k] for k in ["ok", "changed", "unreachable", "failures", "rescued", "ignored"]])
 
         attachments = []
-        msg_items = [
-            f'*Playbook Complete* (_{self.guid}_)'
-        ]
+        msg_items = [f"*Playbook Complete* (_{self.guid}_)"]
         if failures or unreachable:
-            color = 'danger'
-            msg_items.append('\n*Failed!*')
+            color = "danger"
+            msg_items.append("\n*Failed!*")
         else:
-            color = 'good'
-            msg_items.append('\n*Success!*')
+            color = "good"
+            msg_items.append("\n*Success!*")
 
-        msg_items.append(f'```\n{t}\n```')
+        msg_items.append(f"```\n{t}\n```")
 
-        msg = '\n'.join(msg_items)
+        msg = "\n".join(msg_items)
 
-        attachments.append({
-            'fallback': msg,
-            'fields': [
-                {
-                    'value': msg
-                }
-            ],
-            'color': color,
-            'mrkdwn_in': ['text', 'fallback', 'fields']
-        })
+        attachments.append(
+            {"fallback": msg, "fields": [{"value": msg}], "color": color, "mrkdwn_in": ["text", "fallback", "fields"]}
+        )
 
         self.send_msg(attachments=attachments)

plugins/callback/splunk.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -84,11 +83,10 @@ examples: >-
     authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88
 """
 
-import json
-import uuid
-import socket
 import getpass
-
+import json
+import socket
+import uuid
 from os.path import basename
 
 from ansible.module_utils.ansible_release import __version__ as ansible_version
@@ -101,7 +99,7 @@ from ansible_collections.community.general.plugins.module_utils.datetime import
 )
 
 
-class SplunkHTTPCollectorSource(object):
+class SplunkHTTPCollectorSource:
     def __init__(self):
         self.ansible_check_mode = False
         self.ansible_playbook = ""
@@ -111,7 +109,7 @@ class SplunkHTTPCollectorSource(object):
         self.user = getpass.getuser()
 
     def send_event(self, url, authtoken, validate_certs, include_milliseconds, batch, state, result, runtime):
-        if result._task_fields['args'].get('_ansible_check_mode') is True:
+        if result._task_fields["args"].get("_ansible_check_mode") is True:
             self.ansible_check_mode = True
 
         if result._task._role:
@@ -119,33 +117,33 @@ class SplunkHTTPCollectorSource(object):
         else:
             ansible_role = None
 
-        if 'args' in result._task_fields:
-            del result._task_fields['args']
+        if "args" in result._task_fields:
+            del result._task_fields["args"]
 
         data = {}
-        data['uuid'] = result._task._uuid
-        data['session'] = self.session
+        data["uuid"] = result._task._uuid
+        data["session"] = self.session
         if batch is not None:
-            data['batch'] = batch
-        data['status'] = state
+            data["batch"] = batch
+        data["status"] = state
 
         if include_milliseconds:
-            time_format = '%Y-%m-%d %H:%M:%S.%f +0000'
+            time_format = "%Y-%m-%d %H:%M:%S.%f +0000"
         else:
-            time_format = '%Y-%m-%d %H:%M:%S +0000'
+            time_format = "%Y-%m-%d %H:%M:%S +0000"
 
-        data['timestamp'] = now().strftime(time_format)
-        data['host'] = self.host
-        data['ip_address'] = self.ip_address
-        data['user'] = self.user
-        data['runtime'] = runtime
-        data['ansible_version'] = ansible_version
-        data['ansible_check_mode'] = self.ansible_check_mode
-        data['ansible_host'] = result._host.name
-        data['ansible_playbook'] = self.ansible_playbook
-        data['ansible_role'] = ansible_role
-        data['ansible_task'] = result._task_fields
-        data['ansible_result'] = result._result
+        data["timestamp"] = now().strftime(time_format)
+        data["host"] = self.host
+        data["ip_address"] = self.ip_address
+        data["user"] = self.user
+        data["runtime"] = runtime
+        data["ansible_version"] = ansible_version
+        data["ansible_check_mode"] = self.ansible_check_mode
+        data["ansible_host"] = result._host.name
+        data["ansible_playbook"] = self.ansible_playbook
+        data["ansible_role"] = ansible_role
+        data["ansible_task"] = result._task_fields
+        data["ansible_result"] = result._result
 
         # This wraps the json payload in and outer json event needed by Splunk
         jsondata = json.dumps({"event": data}, cls=AnsibleJSONEncoder, sort_keys=True)
@@ -153,23 +151,20 @@ class SplunkHTTPCollectorSource(object):
         open_url(
             url,
             jsondata,
-            headers={
-                'Content-type': 'application/json',
-                'Authorization': f"Splunk {authtoken}"
-            },
-            method='POST',
-            validate_certs=validate_certs
+            headers={"Content-type": "application/json", "Authorization": f"Splunk {authtoken}"},
+            method="POST",
+            validate_certs=validate_certs,
         )
 
 
 class CallbackModule(CallbackBase):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.splunk'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.splunk"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.start_datetimes = {}  # Collect task start times
         self.url = None
         self.authtoken = None
@@ -179,41 +174,40 @@ class CallbackModule(CallbackBase):
         self.splunk = SplunkHTTPCollectorSource()
 
     def _runtime(self, result):
-        return (
-            now() -
-            self.start_datetimes[result._task._uuid]
-        ).total_seconds()
+        return (now() - self.start_datetimes[result._task._uuid]).total_seconds()
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.url = self.get_option('url')
+        self.url = self.get_option("url")
 
         if self.url is None:
             self.disabled = True
-            self._display.warning('Splunk HTTP collector source URL was '
-                                  'not provided. The Splunk HTTP collector '
-                                  'source URL can be provided using the '
-                                  '`SPLUNK_URL` environment variable or '
-                                  'in the ansible.cfg file.')
+            self._display.warning(
+                "Splunk HTTP collector source URL was "
+                "not provided. The Splunk HTTP collector "
+                "source URL can be provided using the "
+                "`SPLUNK_URL` environment variable or "
+                "in the ansible.cfg file."
+            )
 
-        self.authtoken = self.get_option('authtoken')
+        self.authtoken = self.get_option("authtoken")
 
         if self.authtoken is None:
             self.disabled = True
-            self._display.warning('Splunk HTTP collector requires an authentication'
-                                  'token. The Splunk HTTP collector '
-                                  'authentication token can be provided using the '
-                                  '`SPLUNK_AUTHTOKEN` environment variable or '
-                                  'in the ansible.cfg file.')
+            self._display.warning(
+                "Splunk HTTP collector requires an authentication"
+                "token. The Splunk HTTP collector "
+                "authentication token can be provided using the "
+                "`SPLUNK_AUTHTOKEN` environment variable or "
+                "in the ansible.cfg file."
+            )
 
-        self.validate_certs = self.get_option('validate_certs')
+        self.validate_certs = self.get_option("validate_certs")
 
-        self.include_milliseconds = self.get_option('include_milliseconds')
+        self.include_milliseconds = self.get_option("include_milliseconds")
 
-        self.batch = self.get_option('batch')
+        self.batch = self.get_option("batch")
 
     def v2_playbook_on_start(self, playbook):
         self.splunk.ansible_playbook = basename(playbook._file_name)
@@ -231,9 +225,9 @@ class CallbackModule(CallbackBase):
             self.validate_certs,
             self.include_milliseconds,
             self.batch,
-            'OK',
+            "OK",
             result,
-            self._runtime(result)
+            self._runtime(result),
         )
 
     def v2_runner_on_skipped(self, result, **kwargs):
@@ -243,9 +237,9 @@ class CallbackModule(CallbackBase):
             self.validate_certs,
             self.include_milliseconds,
             self.batch,
-            'SKIPPED',
+            "SKIPPED",
             result,
-            self._runtime(result)
+            self._runtime(result),
         )
 
     def v2_runner_on_failed(self, result, **kwargs):
@@ -255,21 +249,21 @@ class CallbackModule(CallbackBase):
             self.validate_certs,
             self.include_milliseconds,
             self.batch,
-            'FAILED',
+            "FAILED",
             result,
-            self._runtime(result)
+            self._runtime(result),
         )
 
-    def runner_on_async_failed(self, result, **kwargs):
+    def v2_runner_on_async_failed(self, result, **kwargs):
         self.splunk.send_event(
             self.url,
             self.authtoken,
             self.validate_certs,
             self.include_milliseconds,
             self.batch,
-            'FAILED',
+            "FAILED",
             result,
-            self._runtime(result)
+            self._runtime(result),
         )
 
     def v2_runner_on_unreachable(self, result, **kwargs):
@@ -279,7 +273,7 @@ class CallbackModule(CallbackBase):
             self.validate_certs,
             self.include_milliseconds,
             self.batch,
-            'UNREACHABLE',
+            "UNREACHABLE",
             result,
-            self._runtime(result)
+            self._runtime(result),
         )

plugins/callback/sumologic.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -41,11 +40,10 @@ examples: |-
     url = https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==
 """
 
-import json
-import uuid
-import socket
 import getpass
-
+import json
+import socket
+import uuid
 from os.path import basename
 
 from ansible.module_utils.ansible_release import __version__ as ansible_version
@@ -58,7 +56,7 @@ from ansible_collections.community.general.plugins.module_utils.datetime import
 )
 
 
-class SumologicHTTPCollectorSource(object):
+class SumologicHTTPCollectorSource:
     def __init__(self):
         self.ansible_check_mode = False
         self.ansible_playbook = ""
@@ -68,7 +66,7 @@ class SumologicHTTPCollectorSource(object):
         self.user = getpass.getuser()
 
     def send_event(self, url, state, result, runtime):
-        if result._task_fields['args'].get('_ansible_check_mode') is True:
+        if result._task_fields["args"].get("_ansible_check_mode") is True:
             self.ansible_check_mode = True
 
         if result._task._role:
@@ -76,67 +74,63 @@ class SumologicHTTPCollectorSource(object):
         else:
             ansible_role = None
 
-        if 'args' in result._task_fields:
-            del result._task_fields['args']
+        if "args" in result._task_fields:
+            del result._task_fields["args"]
 
         data = {}
-        data['uuid'] = result._task._uuid
-        data['session'] = self.session
-        data['status'] = state
-        data['timestamp'] = now().strftime('%Y-%m-%d %H:%M:%S +0000')
-        data['host'] = self.host
-        data['ip_address'] = self.ip_address
-        data['user'] = self.user
-        data['runtime'] = runtime
-        data['ansible_version'] = ansible_version
-        data['ansible_check_mode'] = self.ansible_check_mode
-        data['ansible_host'] = result._host.name
-        data['ansible_playbook'] = self.ansible_playbook
-        data['ansible_role'] = ansible_role
-        data['ansible_task'] = result._task_fields
-        data['ansible_result'] = result._result
+        data["uuid"] = result._task._uuid
+        data["session"] = self.session
+        data["status"] = state
+        data["timestamp"] = now().strftime("%Y-%m-%d %H:%M:%S +0000")
+        data["host"] = self.host
+        data["ip_address"] = self.ip_address
+        data["user"] = self.user
+        data["runtime"] = runtime
+        data["ansible_version"] = ansible_version
+        data["ansible_check_mode"] = self.ansible_check_mode
+        data["ansible_host"] = result._host.name
+        data["ansible_playbook"] = self.ansible_playbook
+        data["ansible_role"] = ansible_role
+        data["ansible_task"] = result._task_fields
+        data["ansible_result"] = result._result
 
         open_url(
             url,
             data=json.dumps(data, cls=AnsibleJSONEncoder, sort_keys=True),
-            headers={
-                'Content-type': 'application/json',
-                'X-Sumo-Host': data['ansible_host']
-            },
-            method='POST'
+            headers={"Content-type": "application/json", "X-Sumo-Host": data["ansible_host"]},
+            method="POST",
         )
 
 
 class CallbackModule(CallbackBase):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.sumologic'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.sumologic"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
+        super().__init__(display=display)
         self.start_datetimes = {}  # Collect task start times
         self.url = None
         self.sumologic = SumologicHTTPCollectorSource()
 
     def _runtime(self, result):
-        return (
-            now() -
-            self.start_datetimes[result._task._uuid]
-        ).total_seconds()
+        return (now() - self.start_datetimes[result._task._uuid]).total_seconds()
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
-        self.url = self.get_option('url')
+        self.url = self.get_option("url")
 
         if self.url is None:
             self.disabled = True
-            self._display.warning('Sumologic HTTP collector source URL was '
-                                  'not provided. The Sumologic HTTP collector '
-                                  'source URL can be provided using the '
-                                  '`SUMOLOGIC_URL` environment variable or '
-                                  'in the ansible.cfg file.')
+            self._display.warning(
+                "Sumologic HTTP collector source URL was "
+                "not provided. The Sumologic HTTP collector "
+                "source URL can be provided using the "
+                "`SUMOLOGIC_URL` environment variable or "
+                "in the ansible.cfg file."
+            )
 
     def v2_playbook_on_start(self, playbook):
         self.sumologic.ansible_playbook = basename(playbook._file_name)
@@ -148,41 +142,16 @@ class CallbackModule(CallbackBase):
         self.start_datetimes[task._uuid] = now()
 
     def v2_runner_on_ok(self, result, **kwargs):
-        self.sumologic.send_event(
-            self.url,
-            'OK',
-            result,
-            self._runtime(result)
-        )
+        self.sumologic.send_event(self.url, "OK", result, self._runtime(result))
 
     def v2_runner_on_skipped(self, result, **kwargs):
-        self.sumologic.send_event(
-            self.url,
-            'SKIPPED',
-            result,
-            self._runtime(result)
-        )
+        self.sumologic.send_event(self.url, "SKIPPED", result, self._runtime(result))
 
     def v2_runner_on_failed(self, result, **kwargs):
-        self.sumologic.send_event(
-            self.url,
-            'FAILED',
-            result,
-            self._runtime(result)
-        )
+        self.sumologic.send_event(self.url, "FAILED", result, self._runtime(result))
 
     def runner_on_async_failed(self, result, **kwargs):
-        self.sumologic.send_event(
-            self.url,
-            'FAILED',
-            result,
-            self._runtime(result)
-        )
+        self.sumologic.send_event(self.url, "FAILED", result, self._runtime(result))
 
     def v2_runner_on_unreachable(self, result, **kwargs):
-        self.sumologic.send_event(
-            self.url,
-            'UNREACHABLE',
-            result,
-            self._runtime(result)
-        )
+        self.sumologic.send_event(self.url, "UNREACHABLE", result, self._runtime(result))

plugins/callback/syslog_json.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -57,7 +56,6 @@ options:
 
 import logging
 import logging.handlers
-
 import socket
 
 from ansible.plugins.callback import CallbackBase
@@ -69,62 +67,89 @@ class CallbackModule(CallbackBase):
     """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.syslog_json'
+    CALLBACK_TYPE = "notification"
+    CALLBACK_NAME = "community.general.syslog_json"
     CALLBACK_NEEDS_WHITELIST = True
 
     def __init__(self):
-
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         syslog_host = self.get_option("server")
         syslog_port = int(self.get_option("port"))
         syslog_facility = self.get_option("facility")
 
-        self.logger = logging.getLogger('ansible logger')
+        self.logger = logging.getLogger("ansible logger")
         self.logger.setLevel(logging.DEBUG)
 
-        self.handler = logging.handlers.SysLogHandler(
-            address=(syslog_host, syslog_port),
-            facility=syslog_facility
-        )
+        self.handler = logging.handlers.SysLogHandler(address=(syslog_host, syslog_port), facility=syslog_facility)
         self.logger.addHandler(self.handler)
         self.hostname = socket.gethostname()
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
         res = result._result
         host = result._host.get_name()
-        self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
+        self.logger.error(
+            "%s ansible-command: task execution FAILED; host: %s; message: %s",
+            self.hostname,
+            host,
+            self._dump_results(res),
+        )
 
     def v2_runner_on_ok(self, result):
         res = result._result
         host = result._host.get_name()
         if result._task.action != "gather_facts" or self.get_option("setup"):
-            self.logger.info('%s ansible-command: task execution OK; host: %s; message: %s', self.hostname, host, self._dump_results(res))
+            self.logger.info(
+                "%s ansible-command: task execution OK; host: %s; message: %s",
+                self.hostname,
+                host,
+                self._dump_results(res),
+            )
 
     def v2_runner_on_skipped(self, result):
         host = result._host.get_name()
-        self.logger.info('%s ansible-command: task execution SKIPPED; host: %s; message: %s', self.hostname, host, 'skipped')
+        self.logger.info(
+            "%s ansible-command: task execution SKIPPED; host: %s; message: %s", self.hostname, host, "skipped"
+        )
 
     def v2_runner_on_unreachable(self, result):
         res = result._result
         host = result._host.get_name()
-        self.logger.error('%s ansible-command: task execution UNREACHABLE; host: %s; message: %s', self.hostname, host, self._dump_results(res))
+        self.logger.error(
+            "%s ansible-command: task execution UNREACHABLE; host: %s; message: %s",
+            self.hostname,
+            host,
+            self._dump_results(res),
+        )
 
     def v2_runner_on_async_failed(self, result):
         res = result._result
         host = result._host.get_name()
-        jid = result._result.get('ansible_job_id')
-        self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
+        # jid = result._result.get("ansible_job_id")
+        self.logger.error(
+            "%s ansible-command: task execution FAILED; host: %s; message: %s",
+            self.hostname,
+            host,
+            self._dump_results(res),
+        )
 
     def v2_playbook_on_import_for_host(self, result, imported_file):
         host = result._host.get_name()
-        self.logger.info('%s ansible-command: playbook IMPORTED; host: %s; message: imported file %s', self.hostname, host, imported_file)
+        self.logger.info(
+            "%s ansible-command: playbook IMPORTED; host: %s; message: imported file %s",
+            self.hostname,
+            host,
+            imported_file,
+        )
 
     def v2_playbook_on_not_import_for_host(self, result, missing_file):
         host = result._host.get_name()
-        self.logger.info('%s ansible-command: playbook NOT IMPORTED; host: %s; message: missing file %s', self.hostname, host, missing_file)
+        self.logger.info(
+            "%s ansible-command: playbook NOT IMPORTED; host: %s; message: missing file %s",
+            self.hostname,
+            host,
+            missing_file,
+        )

plugins/callback/tasks_only.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2025, Felix Fontein <felix@fontein.de>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
@@ -52,8 +50,8 @@ from ansible.plugins.callback.default import CallbackModule as Default
 
 class CallbackModule(Default):
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.tasks_only'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.tasks_only"
 
     def v2_playbook_on_play_start(self, play):
         pass
@@ -62,7 +60,7 @@ class CallbackModule(Default):
         pass
 
     def set_options(self, *args, **kwargs):
-        result = super(CallbackModule, self).set_options(*args, **kwargs)
+        result = super().set_options(*args, **kwargs)
         self.number_of_columns = self.get_option("number_of_columns")
         if self.number_of_columns is not None:
             self._display.columns = self.number_of_columns

plugins/callback/timestamp.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2024, kurokobo <kurokobo@protonmail.com>
 # Copyright (c) 2014, Michael DeHaan <michael.dehaan@gmail.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -7,7 +5,6 @@
 
 from __future__ import annotations
 
-
 DOCUMENTATION = r"""
 name: timestamp
 type: stdout
@@ -51,12 +48,13 @@ extends_documentation_fragment:
 """
 
 
+import sys
+import types
+from datetime import datetime
+
+from ansible.module_utils.common.text.converters import to_text
 from ansible.plugins.callback.default import CallbackModule as Default
 from ansible.utils.display import get_text_width
-from ansible.module_utils.common.text.converters import to_text
-from datetime import datetime
-import types
-import sys
 
 # Store whether the zoneinfo module is available
 _ZONEINFO_AVAILABLE = sys.version_info >= (3, 9)
@@ -91,7 +89,7 @@ def banner(self, msg, color=None, cows=True):
     msg = msg.strip()
     try:
         star_len = self.columns - get_text_width(msg) - timestamp_len
-    except EnvironmentError:
+    except OSError:
         star_len = self.columns - len(msg) - timestamp_len
     if star_len <= 3:
         star_len = 3
@@ -105,13 +103,13 @@ class CallbackModule(Default):
     CALLBACK_NAME = "community.general.timestamp"
 
     def __init__(self):
-        super(CallbackModule, self).__init__()
+        super().__init__()
 
         # Replace the banner method of the display object with the custom one
         self._display.banner = types.MethodType(banner, self._display)
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         # Store zoneinfo for specified timezone if available
         tzinfo = None
@@ -121,5 +119,5 @@ class CallbackModule(Default):
             tzinfo = ZoneInfo(self.get_option("timezone"))
 
         # Inject options into the display object
-        setattr(self._display, "timestamp_tzinfo", tzinfo)
-        setattr(self._display, "timestamp_format_string", self.get_option("format_string"))
+        self._display.timestamp_tzinfo = tzinfo
+        self._display.timestamp_format_string = self.get_option("format_string")

plugins/callback/unixy.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2023, Al Bowles <@akatch>
 # Copyright (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -21,16 +20,16 @@ requirements:
 """
 
 from os.path import basename
+
 from ansible import constants as C
 from ansible import context
 from ansible.module_utils.common.text.converters import to_text
-from ansible.utils.color import colorize, hostcolor
 from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
+from ansible.utils.color import colorize, hostcolor
 
 
 class CallbackModule(CallbackModule_default):
-
-    '''
+    """
     Design goals:
     - Print consolidated output that looks like a *NIX startup log
     - Defaults should avoid displaying unnecessary information wherever possible
@@ -40,14 +39,16 @@ class CallbackModule(CallbackModule_default):
     - Add option to display all hostnames on a single line in the appropriate result color (failures may have a separate line)
     - Consolidate stats display
     - Don't show play name if no hosts found
-    '''
+    """
 
     CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.unixy'
+    CALLBACK_TYPE = "stdout"
+    CALLBACK_NAME = "community.general.unixy"
 
     def _run_is_verbose(self, result):
-        return ((self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result)
+        return (
+            self._display.verbosity > 0 or "_ansible_verbose_always" in result._result
+        ) and "_ansible_verbose_override" not in result._result
 
     def _get_task_display_name(self, task):
         self.task_display_name = None
@@ -60,8 +61,8 @@ class CallbackModule(CallbackModule_default):
             self.task_display_name = task_display_name
 
     def _preprocess_result(self, result):
-        self.delegated_vars = result._result.get('_ansible_delegated_vars', None)
-        self._handle_exception(result._result, use_stderr=self.get_option('display_failed_stderr'))
+        self.delegated_vars = result._result.get("_ansible_delegated_vars", None)
+        self._handle_exception(result._result, use_stderr=self.get_option("display_failed_stderr"))
         self._handle_warnings(result._result)
 
     def _process_result_output(self, result, msg):
@@ -73,16 +74,16 @@ class CallbackModule(CallbackModule_default):
             return task_result
 
         if self.delegated_vars:
-            task_delegate_host = self.delegated_vars['ansible_host']
+            task_delegate_host = self.delegated_vars["ansible_host"]
             task_result = f"{task_host} -> {task_delegate_host} {msg}"
 
-        if result._result.get('msg') and result._result.get('msg') != "All items completed":
+        if result._result.get("msg") and result._result.get("msg") != "All items completed":
             task_result += f" | msg: {to_text(result._result.get('msg'))}"
 
-        if result._result.get('stdout'):
+        if result._result.get("stdout"):
             task_result += f" | stdout: {result._result.get('stdout')}"
 
-        if result._result.get('stderr'):
+        if result._result.get("stderr"):
             task_result += f" | stderr: {result._result.get('stderr')}"
 
         return task_result
@@ -90,7 +91,7 @@ class CallbackModule(CallbackModule_default):
     def v2_playbook_on_task_start(self, task, is_conditional):
         self._get_task_display_name(task)
         if self.task_display_name is not None:
-            if task.check_mode and self.get_option('check_mode_markers'):
+            if task.check_mode and self.get_option("check_mode_markers"):
                 self._display.display(f"{self.task_display_name} (check mode)...")
             else:
                 self._display.display(f"{self.task_display_name}...")
@@ -98,14 +99,14 @@ class CallbackModule(CallbackModule_default):
     def v2_playbook_on_handler_task_start(self, task):
         self._get_task_display_name(task)
         if self.task_display_name is not None:
-            if task.check_mode and self.get_option('check_mode_markers'):
+            if task.check_mode and self.get_option("check_mode_markers"):
                 self._display.display(f"{self.task_display_name} (via handler in check mode)... ")
             else:
                 self._display.display(f"{self.task_display_name} (via handler)... ")
 
     def v2_playbook_on_play_start(self, play):
         name = play.get_name().strip()
-        if play.check_mode and self.get_option('check_mode_markers'):
+        if play.check_mode and self.get_option("check_mode_markers"):
             if name and play.hosts:
                 msg = f"\n- {name} (in check mode) on hosts: {','.join(play.hosts)} -"
             else:
@@ -119,7 +120,7 @@ class CallbackModule(CallbackModule_default):
         self._display.display(msg)
 
     def v2_runner_on_skipped(self, result, ignore_errors=False):
-        if self.get_option('display_skipped_hosts'):
+        if self.get_option("display_skipped_hosts"):
             self._preprocess_result(result)
             display_color = C.COLOR_SKIP
             msg = "skipped"
@@ -138,12 +139,12 @@ class CallbackModule(CallbackModule_default):
             msg += f" | item: {item_value}"
 
         task_result = self._process_result_output(result, msg)
-        self._display.display(f"  {task_result}", display_color, stderr=self.get_option('display_failed_stderr'))
+        self._display.display(f"  {task_result}", display_color, stderr=self.get_option("display_failed_stderr"))
 
     def v2_runner_on_ok(self, result, msg="ok", display_color=C.COLOR_OK):
         self._preprocess_result(result)
 
-        result_was_changed = ('changed' in result._result and result._result['changed'])
+        result_was_changed = "changed" in result._result and result._result["changed"]
         if result_was_changed:
             msg = "done"
             item_value = self._get_item_label(result._result)
@@ -152,7 +153,7 @@ class CallbackModule(CallbackModule_default):
             display_color = C.COLOR_CHANGED
             task_result = self._process_result_output(result, msg)
             self._display.display(f"  {task_result}", display_color)
-        elif self.get_option('display_ok_hosts'):
+        elif self.get_option("display_ok_hosts"):
             task_result = self._process_result_output(result, msg)
             self._display.display(f"  {task_result}", display_color)
 
@@ -172,17 +173,17 @@ class CallbackModule(CallbackModule_default):
         display_color = C.COLOR_UNREACHABLE
         task_result = self._process_result_output(result, msg)
 
-        self._display.display(f"  {task_result}", display_color, stderr=self.get_option('display_failed_stderr'))
+        self._display.display(f"  {task_result}", display_color, stderr=self.get_option("display_failed_stderr"))
 
     def v2_on_file_diff(self, result):
-        if result._task.loop and 'results' in result._result:
-            for res in result._result['results']:
-                if 'diff' in res and res['diff'] and res.get('changed', False):
-                    diff = self._get_diff(res['diff'])
+        if result._task.loop and "results" in result._result:
+            for res in result._result["results"]:
+                if "diff" in res and res["diff"] and res.get("changed", False):
+                    diff = self._get_diff(res["diff"])
                     if diff:
                         self._display.display(diff)
-        elif 'diff' in result._result and result._result['diff'] and result._result.get('changed', False):
-            diff = self._get_diff(result._result['diff'])
+        elif "diff" in result._result and result._result["diff"] and result._result.get("changed", False):
+            diff = self._get_diff(result._result["diff"])
             if diff:
                 self._display.display(diff)
 
@@ -198,30 +199,30 @@ class CallbackModule(CallbackModule_default):
                 f"  {hostcolor(h, t)} : {colorize('ok', t['ok'], C.COLOR_OK)} {colorize('changed', t['changed'], C.COLOR_CHANGED)} "
                 f"{colorize('unreachable', t['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', t['failures'], C.COLOR_ERROR)} "
                 f"{colorize('rescued', t['rescued'], C.COLOR_OK)} {colorize('ignored', t['ignored'], C.COLOR_WARN)}",
-                screen_only=True
+                screen_only=True,
             )
 
             self._display.display(
                 f"  {hostcolor(h, t, False)} : {colorize('ok', t['ok'], None)} {colorize('changed', t['changed'], None)} "
                 f"{colorize('unreachable', t['unreachable'], None)} {colorize('failed', t['failures'], None)} {colorize('rescued', t['rescued'], None)} "
                 f"{colorize('ignored', t['ignored'], None)}",
-                log_only=True
+                log_only=True,
             )
-        if stats.custom and self.get_option('show_custom_stats'):
+        if stats.custom and self.get_option("show_custom_stats"):
             self._display.banner("CUSTOM STATS: ")
             # per host
             # TODO: come up with 'pretty format'
             for k in sorted(stats.custom.keys()):
-                if k == '_run':
+                if k == "_run":
                     continue
-                stat_val = self._dump_results(stats.custom[k], indent=1).replace('\n', '')
-                self._display.display(f'\t{k}: {stat_val}')
+                stat_val = self._dump_results(stats.custom[k], indent=1).replace("\n", "")
+                self._display.display(f"\t{k}: {stat_val}")
 
             # print per run custom stats
-            if '_run' in stats.custom:
+            if "_run" in stats.custom:
                 self._display.display("", screen_only=True)
-                stat_val_run = self._dump_results(stats.custom['_run'], indent=1).replace('\n', '')
-                self._display.display(f'\tRUN: {stat_val_run}')
+                stat_val_run = self._dump_results(stats.custom["_run"], indent=1).replace("\n", "")
+                self._display.display(f"\tRUN: {stat_val_run}")
             self._display.display("", screen_only=True)
 
     def v2_playbook_on_no_hosts_matched(self):
@@ -231,21 +232,24 @@ class CallbackModule(CallbackModule_default):
         self._display.display("  Ran out of hosts!", color=C.COLOR_ERROR)
 
     def v2_playbook_on_start(self, playbook):
-        if context.CLIARGS['check'] and self.get_option('check_mode_markers'):
+        if context.CLIARGS["check"] and self.get_option("check_mode_markers"):
             self._display.display(f"Executing playbook {basename(playbook._file_name)} in check mode")
         else:
             self._display.display(f"Executing playbook {basename(playbook._file_name)}")
 
         # show CLI arguments
         if self._display.verbosity > 3:
-            if context.CLIARGS.get('args'):
-                self._display.display(f"Positional arguments: {' '.join(context.CLIARGS['args'])}",
-                                      color=C.COLOR_VERBOSE, screen_only=True)
+            if context.CLIARGS.get("args"):
+                self._display.display(
+                    f"Positional arguments: {' '.join(context.CLIARGS['args'])}",
+                    color=C.COLOR_VERBOSE,
+                    screen_only=True,
+                )
 
-            for argument in (a for a in context.CLIARGS if a != 'args'):
+            for argument in (a for a in context.CLIARGS if a != "args"):
                 val = context.CLIARGS[argument]
                 if val:
-                    self._display.vvvv(f'{argument}: {val}')
+                    self._display.vvvv(f"{argument}: {val}")
 
     def v2_runner_retry(self, result):
         msg = f"  Retrying... ({result._result['attempts']} of {result._result['retries']})"

plugins/callback/yaml.py

@@ -1,195 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# Make coding more python3-ish
-from __future__ import annotations
-
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: yaml
-type: stdout
-short_description: YAML-ized Ansible screen output
-deprecated:
-  removed_in: 12.0.0
-  why: Starting in ansible-core 2.13, the P(ansible.builtin.default#callback) callback has support for printing output in
-    YAML format.
-  alternative: Use O(ansible.builtin.default#callback:result_format=yaml).
-description:
-  - Ansible output that can be quite a bit easier to read than the default JSON formatting.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout in configuration
-seealso:
-  - plugin: ansible.builtin.default
-    plugin_type: callback
-    description: >-
-      There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback) that allows
-      you to change the output format to YAML.
-notes:
-  - With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
-    in P(ansible.builtin.default#callback).
-"""
-
-import yaml
-import json
-import re
-import string
-from collections.abc import Mapping, Sequence
-
-from ansible.module_utils.common.text.converters import to_text
-from ansible.plugins.callback import strip_internal_keys, module_response_deepcopy
-from ansible.plugins.callback.default import CallbackModule as Default
-
-
-# from http://stackoverflow.com/a/15423007/115478
-def should_use_block(value):
-    """Returns true if string should be in block format"""
-    for c in "\u000a\u000d\u001c\u001d\u001e\u0085\u2028\u2029":
-        if c in value:
-            return True
-    return False
-
-
-def adjust_str_value_for_block(value):
-    # we care more about readable than accuracy, so...
-    # ...no trailing space
-    value = value.rstrip()
-    # ...and non-printable characters
-    value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
-    # ...tabs prevent blocks from expanding
-    value = value.expandtabs()
-    # ...and odd bits of whitespace
-    value = re.sub(r'[\x0b\x0c\r]', '', value)
-    # ...as does trailing space
-    value = re.sub(r' +\n', '\n', value)
-    return value
-
-
-def create_string_node(tag, value, style, default_style):
-    if style is None:
-        if should_use_block(value):
-            style = '|'
-            value = adjust_str_value_for_block(value)
-        else:
-            style = default_style
-    return yaml.representer.ScalarNode(tag, value, style=style)
-
-
-try:
-    from ansible.module_utils.common.yaml import HAS_LIBYAML
-    # import below was added in https://github.com/ansible/ansible/pull/85039,
-    # first contained in ansible-core 2.19.0b2:
-    from ansible.utils.vars import transform_to_native_types
-
-    if HAS_LIBYAML:
-        from yaml.cyaml import CSafeDumper as SafeDumper
-    else:
-        from yaml import SafeDumper
-
-    class MyDumper(SafeDumper):
-        def represent_scalar(self, tag, value, style=None):
-            """Uses block style for multi-line strings"""
-            node = create_string_node(tag, value, style, self.default_style)
-            if self.alias_key is not None:
-                self.represented_objects[self.alias_key] = node
-            return node
-
-except ImportError:
-    # In case transform_to_native_types cannot be imported, we either have ansible-core 2.19.0b1
-    # (or some random commit from the devel or stable-2.19 branch after merging the DT changes
-    # and before transform_to_native_types was added), or we have a version without the DT changes.
-
-    # Here we simply assume we have a version without the DT changes, and thus can continue as
-    # with ansible-core 2.18 and before.
-
-    transform_to_native_types = None
-
-    from ansible.parsing.yaml.dumper import AnsibleDumper
-
-    class MyDumper(AnsibleDumper):  # pylint: disable=inherit-non-class
-        def represent_scalar(self, tag, value, style=None):
-            """Uses block style for multi-line strings"""
-            node = create_string_node(tag, value, style, self.default_style)
-            if self.alias_key is not None:
-                self.represented_objects[self.alias_key] = node
-            return node
-
-
-def transform_recursively(value, transform):
-    # Since 2.19.0b7, this should no longer be needed:
-    # https://github.com/ansible/ansible/issues/85325
-    # https://github.com/ansible/ansible/pull/85389
-    if isinstance(value, Mapping):
-        return {transform(k): transform(v) for k, v in value.items()}
-    if isinstance(value, Sequence) and not isinstance(value, (str, bytes)):
-        return [transform(e) for e in value]
-    return transform(value)
-
-
-class CallbackModule(Default):
-
-    """
-    Variation of the Default output which uses nicely readable YAML instead
-    of JSON for printing results.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.yaml'
-
-    def __init__(self):
-        super(CallbackModule, self).__init__()
-
-    def _dump_results(self, result, indent=None, sort_keys=True, keep_invocation=False):
-        if result.get('_ansible_no_log', False):
-            return json.dumps(dict(censored="The output has been hidden due to the fact that 'no_log: true' was specified for this result"))
-
-        # All result keys stating with _ansible_ are internal, so remove them from the result before we output anything.
-        abridged_result = strip_internal_keys(module_response_deepcopy(result))
-
-        # remove invocation unless specifically wanting it
-        if not keep_invocation and self._display.verbosity < 3 and 'invocation' in result:
-            del abridged_result['invocation']
-
-        # remove diff information from screen output
-        if self._display.verbosity < 3 and 'diff' in result:
-            del abridged_result['diff']
-
-        # remove exception from screen output
-        if 'exception' in abridged_result:
-            del abridged_result['exception']
-
-        dumped = ''
-
-        # put changed and skipped into a header line
-        if 'changed' in abridged_result:
-            dumped += f"changed={str(abridged_result['changed']).lower()} "
-            del abridged_result['changed']
-
-        if 'skipped' in abridged_result:
-            dumped += f"skipped={str(abridged_result['skipped']).lower()} "
-            del abridged_result['skipped']
-
-        # if we already have stdout, we don't need stdout_lines
-        if 'stdout' in abridged_result and 'stdout_lines' in abridged_result:
-            abridged_result['stdout_lines'] = '<omitted>'
-
-        # if we already have stderr, we don't need stderr_lines
-        if 'stderr' in abridged_result and 'stderr_lines' in abridged_result:
-            abridged_result['stderr_lines'] = '<omitted>'
-
-        if abridged_result:
-            dumped += '\n'
-            if transform_to_native_types is not None:
-                abridged_result = transform_recursively(abridged_result, lambda v: transform_to_native_types(v, redact=False))
-            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=MyDumper, default_flow_style=False))
-
-        # indent by a couple of spaces
-        dumped = '\n  '.join(dumped.split('\n')).rstrip()
-        return dumped
-
-    def _serialize_diff(self, diff):
-        return to_text(yaml.dump(diff, allow_unicode=True, width=1000, Dumper=AnsibleDumper, default_flow_style=False))

plugins/connection/chroot.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 #
 # (c) 2013, Maykel Moya <mmoya@speedyrails.com>
@@ -81,26 +80,26 @@ from ansible.errors import AnsibleError
 from ansible.module_utils.basic import is_executable
 from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes
-from ansible.plugins.connection import ConnectionBase, BUFSIZE
+from ansible.plugins.connection import BUFSIZE, ConnectionBase
 from ansible.utils.display import Display
 
 display = Display()
 
 
 class Connection(ConnectionBase):
-    """ Local chroot based connections """
+    """Local chroot based connections"""
 
-    transport = 'community.general.chroot'
+    transport = "community.general.chroot"
     has_pipelining = True
     # su currently has an undiagnosed issue with calculating the file
     # checksums (so copy, for instance, doesn't work right)
     # Have to look into that before re-enabling this
     has_tty = False
 
-    default_user = 'root'
+    default_user = "root"
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         self.chroot = self._play_context.remote_addr
 
@@ -108,7 +107,7 @@ class Connection(ConnectionBase):
         if not os.path.isdir(self.chroot):
             raise AnsibleError(f"{self.chroot} is not a directory")
 
-        chrootsh = os.path.join(self.chroot, 'bin/sh')
+        chrootsh = os.path.join(self.chroot, "bin/sh")
         # Want to check for a usable bourne shell inside the chroot.
         # is_executable() == True is sufficient.  For symlinks it
         # gets really complicated really fast.  So we punt on finding that
@@ -117,46 +116,46 @@ class Connection(ConnectionBase):
             raise AnsibleError(f"{self.chroot} does not look like a chrootable dir (/bin/sh missing)")
 
     def _connect(self):
-        """ connect to the chroot """
-        if not self.get_option('disable_root_check') and os.geteuid() != 0:
+        """connect to the chroot"""
+        if not self.get_option("disable_root_check") and os.geteuid() != 0:
             raise AnsibleError(
                 "chroot connection requires running as root. "
-                "You can override this check with the `disable_root_check` option.")
+                "You can override this check with the `disable_root_check` option."
+            )
 
-        if os.path.isabs(self.get_option('chroot_exe')):
-            self.chroot_cmd = self.get_option('chroot_exe')
+        if os.path.isabs(self.get_option("chroot_exe")):
+            self.chroot_cmd = self.get_option("chroot_exe")
         else:
             try:
-                self.chroot_cmd = get_bin_path(self.get_option('chroot_exe'))
+                self.chroot_cmd = get_bin_path(self.get_option("chroot_exe"))
             except ValueError as e:
-                raise AnsibleError(str(e))
+                raise AnsibleError(str(e)) from e
 
-        super(Connection, self)._connect()
+        super()._connect()
         if not self._connected:
             display.vvv("THIS IS A LOCAL CHROOT DIR", host=self.chroot)
             self._connected = True
 
     def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
-        """ run a command on the chroot.  This is only needed for implementing
+        """run a command on the chroot.  This is only needed for implementing
         put_file() get_file() so that we don't have to read the whole file
         into memory.
 
         compared to exec_command() it looses some niceties like being able to
         return the process's exit code immediately.
         """
-        executable = self.get_option('executable')
-        local_cmd = [self.chroot_cmd, self.chroot, executable, '-c', cmd]
+        executable = self.get_option("executable")
+        local_cmd = [self.chroot_cmd, self.chroot, executable, "-c", cmd]
 
         display.vvv(f"EXEC {local_cmd}", host=self.chroot)
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
+        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
         return p
 
     def exec_command(self, cmd, in_data=None, sudoable=False):
-        """ run a command on the chroot """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """run a command on the chroot"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
         p = self._buffered_exec_command(cmd)
 
@@ -165,70 +164,70 @@ class Connection(ConnectionBase):
 
     @staticmethod
     def _prefix_login_path(remote_path):
-        """ Make sure that we put files into a standard path
+        """Make sure that we put files into a standard path
 
-            If a path is relative, then we need to choose where to put it.
-            ssh chooses $HOME but we aren't guaranteed that a home dir will
-            exist in any given chroot.  So for now we're choosing "/" instead.
-            This also happens to be the former default.
+        If a path is relative, then we need to choose where to put it.
+        ssh chooses $HOME but we aren't guaranteed that a home dir will
+        exist in any given chroot.  So for now we're choosing "/" instead.
+        This also happens to be the former default.
 
-            Can revisit using $HOME instead if it is a problem
+        Can revisit using $HOME instead if it is a problem
         """
         if not remote_path.startswith(os.path.sep):
             remote_path = os.path.join(os.path.sep, remote_path)
         return os.path.normpath(remote_path)
 
     def put_file(self, in_path, out_path):
-        """ transfer a file from local to chroot """
-        super(Connection, self).put_file(in_path, out_path)
+        """transfer a file from local to chroot"""
+        super().put_file(in_path, out_path)
         display.vvv(f"PUT {in_path} TO {out_path}", host=self.chroot)
 
         out_path = shlex_quote(self._prefix_login_path(out_path))
         try:
-            with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
+            with open(to_bytes(in_path, errors="surrogate_or_strict"), "rb") as in_file:
                 if not os.fstat(in_file.fileno()).st_size:
-                    count = ' count=0'
+                    count = " count=0"
                 else:
-                    count = ''
+                    count = ""
                 try:
-                    p = self._buffered_exec_command(f'dd of={out_path} bs={BUFSIZE}{count}', stdin=in_file)
-                except OSError:
-                    raise AnsibleError("chroot connection requires dd command in the chroot")
+                    p = self._buffered_exec_command(f"dd of={out_path} bs={BUFSIZE}{count}", stdin=in_file)
+                except OSError as e:
+                    raise AnsibleError("chroot connection requires dd command in the chroot") from e
                 try:
                     stdout, stderr = p.communicate()
-                except Exception:
+                except Exception as e:
                     traceback.print_exc()
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}") from e
                 if p.returncode != 0:
                     raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
-        except IOError:
-            raise AnsibleError(f"file or module does not exist at: {in_path}")
+        except OSError as e:
+            raise AnsibleError(f"file or module does not exist at: {in_path}") from e
 
     def fetch_file(self, in_path, out_path):
-        """ fetch a file from chroot to local """
-        super(Connection, self).fetch_file(in_path, out_path)
+        """fetch a file from chroot to local"""
+        super().fetch_file(in_path, out_path)
         display.vvv(f"FETCH {in_path} TO {out_path}", host=self.chroot)
 
         in_path = shlex_quote(self._prefix_login_path(in_path))
         try:
-            p = self._buffered_exec_command(f'dd if={in_path} bs={BUFSIZE}')
-        except OSError:
-            raise AnsibleError("chroot connection requires dd command in the chroot")
+            p = self._buffered_exec_command(f"dd if={in_path} bs={BUFSIZE}")
+        except OSError as e:
+            raise AnsibleError("chroot connection requires dd command in the chroot") from e
 
-        with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb+') as out_file:
+        with open(to_bytes(out_path, errors="surrogate_or_strict"), "wb+") as out_file:
             try:
                 chunk = p.stdout.read(BUFSIZE)
                 while chunk:
                     out_file.write(chunk)
                     chunk = p.stdout.read(BUFSIZE)
-            except Exception:
+            except Exception as e:
                 traceback.print_exc()
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}") from e
             stdout, stderr = p.communicate()
             if p.returncode != 0:
                 raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
 
     def close(self):
-        """ terminate the connection; nothing to do here """
-        super(Connection, self).close()
+        """terminate the connection; nothing to do here"""
+        super().close()
         self._connected = False

plugins/connection/funcd.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>
@@ -30,13 +29,14 @@ options:
 HAVE_FUNC = False
 try:
     import func.overlord.client as fc
+
     HAVE_FUNC = True
 except ImportError:
     pass
 
 import os
-import tempfile
 import shutil
+import tempfile
 
 from ansible.errors import AnsibleError
 from ansible.plugins.connection import ConnectionBase
@@ -46,7 +46,7 @@ display = Display()
 
 
 class Connection(ConnectionBase):
-    """ Func-based connections """
+    """Func-based connections"""
 
     has_pipelining = False
 
@@ -65,7 +65,7 @@ class Connection(ConnectionBase):
         return self
 
     def exec_command(self, cmd, in_data=None, sudoable=True):
-        """ run a command on the remote minion """
+        """run a command on the remote minion"""
 
         if in_data:
             raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
@@ -83,16 +83,16 @@ class Connection(ConnectionBase):
         return os.path.join(prefix, normpath[1:])
 
     def put_file(self, in_path, out_path):
-        """ transfer a file from local to remote """
+        """transfer a file from local to remote"""
 
-        out_path = self._normalize_path(out_path, '/')
+        out_path = self._normalize_path(out_path, "/")
         display.vvv(f"PUT {in_path} TO {out_path}", host=self.host)
         self.client.local.copyfile.send(in_path, out_path)
 
     def fetch_file(self, in_path, out_path):
-        """ fetch a file from remote to local """
+        """fetch a file from remote to local"""
 
-        in_path = self._normalize_path(in_path, '/')
+        in_path = self._normalize_path(in_path, "/")
         display.vvv(f"FETCH {in_path} TO {out_path}", host=self.host)
         # need to use a tmp dir due to difference of semantic for getfile
         # ( who take a # directory as destination) and fetch_file, who
@@ -103,5 +103,5 @@ class Connection(ConnectionBase):
         shutil.rmtree(tmpdir)
 
     def close(self):
-        """ terminate the connection; nothing to do here """
+        """terminate the connection; nothing to do here"""
         pass

plugins/connection/incus.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on lxd.py (c) 2016, Matt Clay <matt@mystile.com>
 # (c) 2023, Stephane Graber <stgraber@stgraber.org>
 # Copyright (c) 2023 Ansible Project
@@ -14,6 +13,9 @@ short_description: Run tasks in Incus instances using the Incus CLI
 description:
   - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
 version_added: "8.2.0"
+notes:
+  - When using this collection for Windows virtual machines, set C(ansible_shell_type) to C(powershell) or C(cmd) as a variable to the host in
+    the inventory.
 options:
   remote_addr:
     description:
@@ -76,78 +78,127 @@ options:
 """
 
 import os
-from subprocess import call, Popen, PIPE
+import re
+from subprocess import PIPE, Popen, call
 
-from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
+from ansible.errors import AnsibleConnectionFailure, AnsibleError, AnsibleFileNotFound
 from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.connection import ConnectionBase
 
 
 class Connection(ConnectionBase):
-    """ Incus based connections """
+    """Incus based connections"""
 
     transport = "incus"
     has_pipelining = True
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         self._incus_cmd = get_bin_path("incus")
 
         if not self._incus_cmd:
             raise AnsibleError("incus command not found in PATH")
 
+        if getattr(self._shell, "_IS_WINDOWS", False):
+            # Initializing regular expression patterns to match on a PowerShell or cmd command line.
+            self.powershell_regex_pattern = re.compile(
+                r'^"?(?P<executable>(?:[a-z]:\\)?[a-z0-9 ()\\.]*powershell(?:\.exe)?)"?\s+(?P<args>.*)(?P<command>-c(?:ommand)?)\s+(?P<post_args>.*(\n.*)*)',
+                re.IGNORECASE,
+            )
+            self.cmd_regex_pattern = re.compile(
+                r'^"?(?P<executable>(?:[a-z]:\\)?[a-z0-9 ()\\.]*cmd(?:\.exe)?)"?\s+(?P<args>.*)(?P<command>/c)\s+(?P<post_args>.*)',
+                re.IGNORECASE,
+            )
+
+            # Basic setup for a Windows host.
+            self.has_native_async = True
+            self.always_pipeline_modules = True
+            self.module_implementation_preferences = (".ps1", ".exe", "")
+            self.allow_executable = False
+
     def _connect(self):
-        """connect to Incus (nothing to do here) """
-        super(Connection, self)._connect()
+        """connect to Incus (nothing to do here)"""
+        super()._connect()
 
         if not self._connected:
-            self._display.vvv(f"ESTABLISH Incus CONNECTION FOR USER: {self.get_option('remote_user')}",
-                              host=self._instance())
+            self._display.vvv(
+                f"ESTABLISH Incus CONNECTION FOR USER: {self.get_option('remote_user')}", host=self._instance()
+            )
             self._connected = True
 
-    def _build_command(self, cmd) -> str:
+    def _build_command(self, cmd) -> list[str]:
         """build the command to execute on the incus host"""
 
-        exec_cmd = [
+        # Force pseudo-terminal allocation if the active become plugin
+        # requires one (e.g. community.general.machinectl), otherwise the
+        # become helper runs without a controlling tty and silently fails.
+        require_tty = self.become is not None and getattr(self.become, "require_tty", False)
+
+        exec_cmd: list[str] = [
             self._incus_cmd,
-            "--project", self.get_option("project"),
+            "--project",
+            self.get_option("project"),
             "exec",
+            *(["-T"] if getattr(self._shell, "_IS_WINDOWS", False) else []),
+            *(["-t"] if require_tty and not getattr(self._shell, "_IS_WINDOWS", False) else []),
             f"{self.get_option('remote')}:{self._instance()}",
-            "--"]
+            "--",
+        ]
 
-        if self.get_option("remote_user") != "root":
-            self._display.vvv(
-                f"INFO: Running as non-root user: {self.get_option('remote_user')}, \
-                trying to run 'incus exec' with become method: {self.get_option('incus_become_method')}",
-                host=self._instance(),
-            )
-            exec_cmd.extend(
-                [self.get_option("incus_become_method"), self.get_option("remote_user"), "-c"]
-            )
+        if getattr(self._shell, "_IS_WINDOWS", False):
+            if regex_match := self.powershell_regex_pattern.match(cmd):
+                regex_pattern = self.powershell_regex_pattern
+            elif regex_match := self.cmd_regex_pattern.match(cmd):
+                regex_pattern = self.cmd_regex_pattern
 
-        exec_cmd.extend([self.get_option("executable"), "-c", cmd])
+            if regex_match:
+                self._display.vvvvvv(
+                    f'Found keyword: "{regex_match.group("command")}" based on regex: {regex_pattern.pattern}',
+                    host=self._instance(),
+                )
+
+                # To avoid splitting on a space contained in the path, set the executable as the first argument.
+                exec_cmd.append(regex_match.group("executable"))
+                if args := regex_match.group("args"):
+                    exec_cmd.extend(args.strip().split(" "))
+                # Set the command argument depending on cmd or powershell and the rest of it
+                exec_cmd.append(regex_match.group("command"))
+                if post_args := regex_match.group("post_args"):
+                    exec_cmd.append(post_args.strip())
+            else:
+                # For anything else using -EncodedCommand or else, just split on space.
+                exec_cmd.extend(cmd.split(" "))
+        else:
+            if self.get_option("remote_user") != "root":
+                self._display.vvv(
+                    f"INFO: Running as non-root user: {self.get_option('remote_user')}, \
+                  trying to run 'incus exec' with become method: {self.get_option('incus_become_method')}",
+                    host=self._instance(),
+                )
+                exec_cmd.extend([self.get_option("incus_become_method"), self.get_option("remote_user"), "-c"])
+
+            exec_cmd.extend([self.get_option("executable"), "-c", cmd])
 
         return exec_cmd
 
     def _instance(self):
         # Return only the leading part of the FQDN as the instance name
         # as Incus instance names cannot be a FQDN.
-        return self.get_option('remote_addr').split(".")[0]
+        return self.get_option("remote_addr").split(".")[0]
 
     def exec_command(self, cmd, in_data=None, sudoable=True):
-        """ execute a command on the Incus host """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """execute a command on the Incus host"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
-        self._display.vvv(f"EXEC {cmd}",
-                          host=self._instance())
+        self._display.vvv(f"EXEC {cmd}", host=self._instance())
 
         local_cmd = self._build_command(cmd)
         self._display.vvvvv(f"EXEC {local_cmd}", host=self._instance())
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        in_data = to_bytes(in_data, errors='surrogate_or_strict', nonstring='passthru')
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
+        in_data = to_bytes(in_data, errors="surrogate_or_strict", nonstring="passthru")
 
         process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
         stdout, stderr = process.communicate(in_data)
@@ -155,32 +206,22 @@ class Connection(ConnectionBase):
         stdout = to_text(stdout)
         stderr = to_text(stderr)
 
-        if stderr.startswith("Error: ") and stderr.rstrip().endswith(
-            ": Instance is not running"
-        ):
+        if stderr.startswith("Error: ") and stderr.rstrip().endswith(": Instance is not running"):
             raise AnsibleConnectionFailure(
                 f"instance not running: {self._instance()} (remote={self.get_option('remote')}, project={self.get_option('project')})"
             )
 
-        if stderr.startswith("Error: ") and stderr.rstrip().endswith(
-            ": Instance not found"
-        ):
+        if stderr.startswith("Error: ") and stderr.rstrip().endswith(": Instance not found"):
             raise AnsibleConnectionFailure(
                 f"instance not found: {self._instance()} (remote={self.get_option('remote')}, project={self.get_option('project')})"
             )
 
-        if (
-            stderr.startswith("Error: ")
-            and ": User does not have permission " in stderr
-        ):
+        if stderr.startswith("Error: ") and ": User does not have permission " in stderr:
             raise AnsibleConnectionFailure(
                 f"instance access denied: {self._instance()} (remote={self.get_option('remote')}, project={self.get_option('project')})"
             )
 
-        if (
-            stderr.startswith("Error: ")
-            and ": User does not have entitlement " in stderr
-        ):
+        if stderr.startswith("Error: ") and ": User does not have entitlement " in stderr:
             raise AnsibleConnectionFailure(
                 f"instance access denied: {self._instance()} (remote={self.get_option('remote')}, project={self.get_option('project')})"
             )
@@ -192,31 +233,26 @@ class Connection(ConnectionBase):
 
         rc, uid_out, err = self.exec_command("/bin/id -u")
         if rc != 0:
-            raise AnsibleError(
-                f"Failed to get remote uid for user {self.get_option('remote_user')}: {err}"
-            )
+            raise AnsibleError(f"Failed to get remote uid for user {self.get_option('remote_user')}: {err}")
         uid = uid_out.strip()
 
         rc, gid_out, err = self.exec_command("/bin/id -g")
         if rc != 0:
-            raise AnsibleError(
-                f"Failed to get remote gid for user {self.get_option('remote_user')}: {err}"
-            )
+            raise AnsibleError(f"Failed to get remote gid for user {self.get_option('remote_user')}: {err}")
         gid = gid_out.strip()
 
         return int(uid), int(gid)
 
     def put_file(self, in_path, out_path):
-        """ put a file from local to Incus """
-        super(Connection, self).put_file(in_path, out_path)
+        """put a file from local to Incus"""
+        super().put_file(in_path, out_path)
 
-        self._display.vvv(f"PUT {in_path} TO {out_path}",
-                          host=self._instance())
+        self._display.vvv(f"PUT {in_path} TO {out_path}", host=self._instance())
 
-        if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
+        if not os.path.isfile(to_bytes(in_path, errors="surrogate_or_strict")):
             raise AnsibleFileNotFound(f"input path is not a file: {in_path}")
 
-        if self.get_option("remote_user") != "root":
+        if not getattr(self._shell, "_IS_WINDOWS", False) and self.get_option("remote_user") != "root":
             uid, gid = self._get_remote_uid_gid()
             local_cmd = [
                 self._incus_cmd,
@@ -246,30 +282,33 @@ class Connection(ConnectionBase):
 
         self._display.vvvvv(f"PUT {local_cmd}", host=self._instance())
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
 
         call(local_cmd)
 
     def fetch_file(self, in_path, out_path):
-        """ fetch a file from Incus to local """
-        super(Connection, self).fetch_file(in_path, out_path)
+        """fetch a file from Incus to local"""
+        super().fetch_file(in_path, out_path)
 
-        self._display.vvv(f"FETCH {in_path} TO {out_path}",
-                          host=self._instance())
+        self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self._instance())
 
         local_cmd = [
             self._incus_cmd,
-            "--project", self.get_option("project"),
-            "file", "pull", "--quiet",
+            "--project",
+            self.get_option("project"),
+            "file",
+            "pull",
+            "--quiet",
             f"{self.get_option('remote')}:{self._instance()}/{in_path}",
-            out_path]
+            out_path,
+        ]
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
 
         call(local_cmd)
 
     def close(self):
-        """ close the connection (nothing to do here) """
-        super(Connection, self).close()
+        """close the connection (nothing to do here)"""
+        super().close()
 
         self._connected = False

plugins/connection/iocage.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on jail.py
 # (c) 2013, Michael Scherer <misc@zarb.org>
 # (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
@@ -34,40 +33,43 @@ options:
 
 import subprocess
 
-from ansible_collections.community.general.plugins.connection.jail import Connection as Jail
-from ansible.module_utils.common.text.converters import to_native
 from ansible.errors import AnsibleError
+from ansible.module_utils.common.text.converters import to_native
 from ansible.utils.display import Display
 
+from ansible_collections.community.general.plugins.connection.jail import Connection as Jail
+
 display = Display()
 
 
 class Connection(Jail):
-    """ Local iocage based connections """
+    """Local iocage based connections"""
 
-    transport = 'community.general.iocage'
+    transport = "community.general.iocage"
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
         self.ioc_jail = play_context.remote_addr
 
-        self.iocage_cmd = Jail._search_executable('iocage')
+        self.iocage_cmd = Jail._search_executable("iocage")
 
         jail_uuid = self.get_jail_uuid()
 
-        kwargs[Jail.modified_jailname_key] = f'ioc-{jail_uuid}'
+        kwargs[Jail.modified_jailname_key] = f"ioc-{jail_uuid}"
 
         display.vvv(
             f"Jail {self.ioc_jail} has been translated to {kwargs[Jail.modified_jailname_key]}",
-            host=kwargs[Jail.modified_jailname_key]
+            host=kwargs[Jail.modified_jailname_key],
         )
 
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
     def get_jail_uuid(self):
-        p = subprocess.Popen([self.iocage_cmd, 'get', 'host_hostuuid', self.ioc_jail],
-                             stdin=subprocess.PIPE,
-                             stdout=subprocess.PIPE,
-                             stderr=subprocess.STDOUT)
+        p = subprocess.Popen(
+            [self.iocage_cmd, "get", "host_hostuuid", self.ioc_jail],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+        )
 
         stdout, stderr = p.communicate()
 
@@ -83,4 +85,4 @@ class Connection(Jail):
         if p.returncode != 0:
             raise AnsibleError(f"iocage returned an error: {stdout}")
 
-        return stdout.strip('\n')
+        return stdout.strip("\n")

plugins/connection/jail.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on local.py by Michael DeHaan <michael.dehaan@gmail.com>
 # and chroot.py by  Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>
@@ -43,25 +42,25 @@ from shlex import quote as shlex_quote
 from ansible.errors import AnsibleError
 from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
-from ansible.plugins.connection import ConnectionBase, BUFSIZE
+from ansible.plugins.connection import BUFSIZE, ConnectionBase
 from ansible.utils.display import Display
 
 display = Display()
 
 
 class Connection(ConnectionBase):
-    """ Local BSD Jail based connections """
+    """Local BSD Jail based connections"""
 
-    modified_jailname_key = 'conn_jail_name'
+    modified_jailname_key = "conn_jail_name"
 
-    transport = 'community.general.jail'
+    transport = "community.general.jail"
     # Pipelining may work.  Someone needs to test by setting this to True and
     # having pipelining=True in their ansible.cfg
     has_pipelining = True
     has_tty = False
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         self.jail = self._play_context.remote_addr
         if self.modified_jailname_key in kwargs:
@@ -70,8 +69,8 @@ class Connection(ConnectionBase):
         if os.geteuid() != 0:
             raise AnsibleError("jail connection requires running as root")
 
-        self.jls_cmd = self._search_executable('jls')
-        self.jexec_cmd = self._search_executable('jexec')
+        self.jls_cmd = self._search_executable("jls")
+        self.jexec_cmd = self._search_executable("jexec")
 
         if self.jail not in self.list_jails():
             raise AnsibleError(f"incorrect jail name {self.jail}")
@@ -80,27 +79,27 @@ class Connection(ConnectionBase):
     def _search_executable(executable):
         try:
             return get_bin_path(executable)
-        except ValueError:
-            raise AnsibleError(f"{executable} command not found in PATH")
+        except ValueError as e:
+            raise AnsibleError(f"{executable} command not found in PATH") from e
 
     def list_jails(self):
-        p = subprocess.Popen([self.jls_cmd, '-q', 'name'],
-                             stdin=subprocess.PIPE,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        p = subprocess.Popen(
+            [self.jls_cmd, "-q", "name"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+        )
 
         stdout, stderr = p.communicate()
 
-        return to_text(stdout, errors='surrogate_or_strict').split()
+        return to_text(stdout, errors="surrogate_or_strict").split()
 
     def _connect(self):
-        """ connect to the jail; nothing to do here """
-        super(Connection, self)._connect()
+        """connect to the jail; nothing to do here"""
+        super()._connect()
         if not self._connected:
             display.vvv(f"ESTABLISH JAIL CONNECTION FOR USER: {self._play_context.remote_user}", host=self.jail)
             self._connected = True
 
     def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
-        """ run a command on the jail.  This is only needed for implementing
+        """run a command on the jail.  This is only needed for implementing
         put_file() get_file() so that we don't have to read the whole file
         into memory.
 
@@ -109,25 +108,24 @@ class Connection(ConnectionBase):
         """
 
         local_cmd = [self.jexec_cmd]
-        set_env = ''
+        set_env = ""
 
         if self._play_context.remote_user is not None:
-            local_cmd += ['-U', self._play_context.remote_user]
+            local_cmd += ["-U", self._play_context.remote_user]
             # update HOME since -U does not update the jail environment
             set_env = f"HOME=~{self._play_context.remote_user} "
 
-        local_cmd += [self.jail, self._play_context.executable, '-c', set_env + cmd]
+        local_cmd += [self.jail, self._play_context.executable, "-c", set_env + cmd]
 
         display.vvv(f"EXEC {local_cmd}", host=self.jail)
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
+        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
         return p
 
     def exec_command(self, cmd, in_data=None, sudoable=False):
-        """ run a command on the jail """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """run a command on the jail"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
         p = self._buffered_exec_command(cmd)
 
@@ -136,70 +134,74 @@ class Connection(ConnectionBase):
 
     @staticmethod
     def _prefix_login_path(remote_path):
-        """ Make sure that we put files into a standard path
+        """Make sure that we put files into a standard path
 
-            If a path is relative, then we need to choose where to put it.
-            ssh chooses $HOME but we aren't guaranteed that a home dir will
-            exist in any given chroot.  So for now we're choosing "/" instead.
-            This also happens to be the former default.
+        If a path is relative, then we need to choose where to put it.
+        ssh chooses $HOME but we aren't guaranteed that a home dir will
+        exist in any given chroot.  So for now we're choosing "/" instead.
+        This also happens to be the former default.
 
-            Can revisit using $HOME instead if it is a problem
+        Can revisit using $HOME instead if it is a problem
         """
         if not remote_path.startswith(os.path.sep):
             remote_path = os.path.join(os.path.sep, remote_path)
         return os.path.normpath(remote_path)
 
     def put_file(self, in_path, out_path):
-        """ transfer a file from local to jail """
-        super(Connection, self).put_file(in_path, out_path)
+        """transfer a file from local to jail"""
+        super().put_file(in_path, out_path)
         display.vvv(f"PUT {in_path} TO {out_path}", host=self.jail)
 
         out_path = shlex_quote(self._prefix_login_path(out_path))
         try:
-            with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
+            with open(to_bytes(in_path, errors="surrogate_or_strict"), "rb") as in_file:
                 if not os.fstat(in_file.fileno()).st_size:
-                    count = ' count=0'
+                    count = " count=0"
                 else:
-                    count = ''
+                    count = ""
                 try:
-                    p = self._buffered_exec_command(f'dd of={out_path} bs={BUFSIZE}{count}', stdin=in_file)
-                except OSError:
-                    raise AnsibleError("jail connection requires dd command in the jail")
+                    p = self._buffered_exec_command(f"dd of={out_path} bs={BUFSIZE}{count}", stdin=in_file)
+                except OSError as e:
+                    raise AnsibleError("jail connection requires dd command in the jail") from e
                 try:
                     stdout, stderr = p.communicate()
-                except Exception:
+                except Exception as e:
                     traceback.print_exc()
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}") from e
                 if p.returncode != 0:
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}")
-        except IOError:
-            raise AnsibleError(f"file or module does not exist at: {in_path}")
+                    raise AnsibleError(
+                        f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}"
+                    )
+        except OSError as e:
+            raise AnsibleError(f"file or module does not exist at: {in_path}") from e
 
     def fetch_file(self, in_path, out_path):
-        """ fetch a file from jail to local """
-        super(Connection, self).fetch_file(in_path, out_path)
+        """fetch a file from jail to local"""
+        super().fetch_file(in_path, out_path)
         display.vvv(f"FETCH {in_path} TO {out_path}", host=self.jail)
 
         in_path = shlex_quote(self._prefix_login_path(in_path))
         try:
-            p = self._buffered_exec_command(f'dd if={in_path} bs={BUFSIZE}')
-        except OSError:
-            raise AnsibleError("jail connection requires dd command in the jail")
+            p = self._buffered_exec_command(f"dd if={in_path} bs={BUFSIZE}")
+        except OSError as e:
+            raise AnsibleError("jail connection requires dd command in the jail") from e
 
-        with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb+') as out_file:
+        with open(to_bytes(out_path, errors="surrogate_or_strict"), "wb+") as out_file:
             try:
                 chunk = p.stdout.read(BUFSIZE)
                 while chunk:
                     out_file.write(chunk)
                     chunk = p.stdout.read(BUFSIZE)
-            except Exception:
+            except Exception as e:
                 traceback.print_exc()
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}") from e
             stdout, stderr = p.communicate()
             if p.returncode != 0:
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}")
+                raise AnsibleError(
+                    f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}"
+                )
 
     def close(self):
-        """ terminate the connection; nothing to do here """
-        super(Connection, self).close()
+        """terminate the connection; nothing to do here"""
+        super().close()
         self._connected = False

plugins/connection/lxc.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # (c) 2015, Joerg Thalheim <joerg@higgsboson.tk>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -32,16 +31,17 @@ options:
       - name: ansible_lxc_executable
 """
 
+import errno
+import fcntl
 import os
+import select
 import shutil
 import traceback
-import select
-import fcntl
-import errno
 
 HAS_LIBLXC = False
 try:
     import lxc as _lxc
+
     HAS_LIBLXC = True
 except ImportError:
     pass
@@ -52,27 +52,27 @@ from ansible.plugins.connection import ConnectionBase
 
 
 class Connection(ConnectionBase):
-    """ Local lxc based connections """
+    """Local lxc based connections"""
 
-    transport = 'community.general.lxc'
+    transport = "community.general.lxc"
     has_pipelining = True
-    default_user = 'root'
+    default_user = "root"
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         self.container_name = None
         self.container = None
 
     def _connect(self):
-        """ connect to the lxc; nothing to do here """
-        super(Connection, self)._connect()
+        """connect to the lxc; nothing to do here"""
+        super()._connect()
 
         if not HAS_LIBLXC:
             msg = "lxc python bindings are not installed"
             raise errors.AnsibleError(msg)
 
-        container_name = self.get_option('remote_addr')
+        container_name = self.get_option("remote_addr")
         if self.container and self.container_name == container_name:
             return
 
@@ -94,12 +94,12 @@ class Connection(ConnectionBase):
         while len(read_fds) > 0 or len(write_fds) > 0:
             try:
                 ready_reads, ready_writes, dummy = select.select(read_fds, write_fds, [])
-            except select.error as e:
+            except OSError as e:
                 if e.args[0] == errno.EINTR:
                     continue
                 raise
             for fd in ready_writes:
-                in_data = in_data[os.write(fd, in_data):]
+                in_data = in_data[os.write(fd, in_data) :]
                 if len(in_data) == 0:
                     write_fds.remove(fd)
             for fd in ready_reads:
@@ -118,12 +118,12 @@ class Connection(ConnectionBase):
         return fd
 
     def exec_command(self, cmd, in_data=None, sudoable=False):
-        """ run a command on the chroot """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """run a command on the chroot"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
         # python2-lxc needs bytes. python3-lxc needs text.
-        executable = to_native(self.get_option('executable'), errors='surrogate_or_strict')
-        local_cmd = [executable, '-c', to_native(cmd, errors='surrogate_or_strict')]
+        executable = to_native(self.get_option("executable"), errors="surrogate_or_strict")
+        local_cmd = [executable, "-c", to_native(cmd, errors="surrogate_or_strict")]
 
         read_stdout, write_stdout = None, None
         read_stderr, write_stderr = None, None
@@ -134,14 +134,14 @@ class Connection(ConnectionBase):
             read_stderr, write_stderr = os.pipe()
 
             kwargs = {
-                'stdout': self._set_nonblocking(write_stdout),
-                'stderr': self._set_nonblocking(write_stderr),
-                'env_policy': _lxc.LXC_ATTACH_CLEAR_ENV
+                "stdout": self._set_nonblocking(write_stdout),
+                "stderr": self._set_nonblocking(write_stderr),
+                "env_policy": _lxc.LXC_ATTACH_CLEAR_ENV,
             }
 
             if in_data:
                 read_stdin, write_stdin = os.pipe()
-                kwargs['stdin'] = self._set_nonblocking(read_stdin)
+                kwargs["stdin"] = self._set_nonblocking(read_stdin)
 
             self._display.vvv(f"EXEC {local_cmd}", host=self.container_name)
             pid = self.container.attach(_lxc.attach_run_command, local_cmd, **kwargs)
@@ -154,82 +154,77 @@ class Connection(ConnectionBase):
             if read_stdin:
                 read_stdin = os.close(read_stdin)
 
-            return self._communicate(pid,
-                                     in_data,
-                                     write_stdin,
-                                     read_stdout,
-                                     read_stderr)
+            return self._communicate(pid, in_data, write_stdin, read_stdout, read_stderr)
         finally:
-            fds = [read_stdout,
-                   write_stdout,
-                   read_stderr,
-                   write_stderr,
-                   read_stdin,
-                   write_stdin]
+            fds = [read_stdout, write_stdout, read_stderr, write_stderr, read_stdin, write_stdin]
             for fd in fds:
                 if fd:
                     os.close(fd)
 
     def put_file(self, in_path, out_path):
-        ''' transfer a file from local to lxc '''
-        super(Connection, self).put_file(in_path, out_path)
+        """transfer a file from local to lxc"""
+        super().put_file(in_path, out_path)
         self._display.vvv(f"PUT {in_path} TO {out_path}", host=self.container_name)
-        in_path = to_bytes(in_path, errors='surrogate_or_strict')
-        out_path = to_bytes(out_path, errors='surrogate_or_strict')
+        in_path = to_bytes(in_path, errors="surrogate_or_strict")
+        out_path = to_bytes(out_path, errors="surrogate_or_strict")
 
         if not os.path.exists(in_path):
             msg = f"file or module does not exist: {in_path}"
             raise errors.AnsibleFileNotFound(msg)
         try:
             src_file = open(in_path, "rb")
-        except IOError:
+        except OSError as e:
             traceback.print_exc()
-            raise errors.AnsibleError(f"failed to open input file to {in_path}")
+            raise errors.AnsibleError(f"failed to open input file to {in_path}") from e
         try:
+
             def write_file(args):
-                with open(out_path, 'wb+') as dst_file:
+                with open(out_path, "wb+") as dst_file:
                     shutil.copyfileobj(src_file, dst_file)
+
             try:
                 self.container.attach_wait(write_file, None)
-            except IOError:
+            except OSError as e:
                 traceback.print_exc()
                 msg = f"failed to transfer file to {out_path}"
-                raise errors.AnsibleError(msg)
+                raise errors.AnsibleError(msg) from e
         finally:
             src_file.close()
 
     def fetch_file(self, in_path, out_path):
-        ''' fetch a file from lxc to local '''
-        super(Connection, self).fetch_file(in_path, out_path)
+        """fetch a file from lxc to local"""
+        super().fetch_file(in_path, out_path)
         self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self.container_name)
-        in_path = to_bytes(in_path, errors='surrogate_or_strict')
-        out_path = to_bytes(out_path, errors='surrogate_or_strict')
+        in_path = to_bytes(in_path, errors="surrogate_or_strict")
+        out_path = to_bytes(out_path, errors="surrogate_or_strict")
 
         try:
             dst_file = open(out_path, "wb")
-        except IOError:
+        except OSError as e:
             traceback.print_exc()
             msg = f"failed to open output file {out_path}"
-            raise errors.AnsibleError(msg)
+            raise errors.AnsibleError(msg) from e
         try:
+
             def write_file(args):
                 try:
-                    with open(in_path, 'rb') as src_file:
+                    with open(in_path, "rb") as src_file:
                         shutil.copyfileobj(src_file, dst_file)
                 finally:
                     # this is needed in the lxc child process
                     # to flush internal python buffers
                     dst_file.close()
+
             try:
                 self.container.attach_wait(write_file, None)
-            except IOError:
+            except OSError as e:
                 traceback.print_exc()
                 msg = f"failed to transfer file from {in_path} to {out_path}"
-                raise errors.AnsibleError(msg)
+                raise errors.AnsibleError(msg) from e
         finally:
             dst_file.close()
 
     def close(self):
-        ''' terminate the connection; nothing to do here '''
-        super(Connection, self).close()
+        """terminate the connection; nothing to do here"""
+        super().close()
         self._connected = False

plugins/connection/lxd.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2016 Matt Clay <matt@mystile.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -75,44 +74,44 @@ options:
 """
 
 import os
-from subprocess import Popen, PIPE
+from subprocess import PIPE, Popen
 
-from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
+from ansible.errors import AnsibleConnectionFailure, AnsibleError, AnsibleFileNotFound
 from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.connection import ConnectionBase
 
 
 class Connection(ConnectionBase):
-    """ lxd based connections """
+    """lxd based connections"""
 
-    transport = 'community.general.lxd'
+    transport = "community.general.lxd"
     has_pipelining = True
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         try:
             self._lxc_cmd = get_bin_path("lxc")
-        except ValueError:
-            raise AnsibleError("lxc command not found in PATH")
+        except ValueError as e:
+            raise AnsibleError("lxc command not found in PATH") from e
 
     def _host(self):
-        """ translate remote_addr to lxd (short) hostname """
+        """translate remote_addr to lxd (short) hostname"""
         return self.get_option("remote_addr").split(".", 1)[0]
 
     def _connect(self):
-        """connect to lxd (nothing to do here) """
-        super(Connection, self)._connect()
+        """connect to lxd (nothing to do here)"""
+        super()._connect()
 
         if not self._connected:
             self._display.vvv(f"ESTABLISH LXD CONNECTION FOR USER: {self.get_option('remote_user')}", host=self._host())
             self._connected = True
 
-    def _build_command(self, cmd) -> str:
+    def _build_command(self, cmd) -> list[str]:
         """build the command to execute on the lxd host"""
 
-        exec_cmd = [self._lxc_cmd]
+        exec_cmd: list[str] = [self._lxc_cmd]
 
         if self.get_option("project"):
             exec_cmd.extend(["--project", self.get_option("project")])
@@ -125,25 +124,23 @@ class Connection(ConnectionBase):
                 trying to run 'lxc exec' with become method: {self.get_option('lxd_become_method')}",
                 host=self._host(),
             )
-            exec_cmd.extend(
-                [self.get_option("lxd_become_method"), self.get_option("remote_user"), "-c"]
-            )
+            exec_cmd.extend([self.get_option("lxd_become_method"), self.get_option("remote_user"), "-c"])
 
         exec_cmd.extend([self.get_option("executable"), "-c", cmd])
 
         return exec_cmd
 
     def exec_command(self, cmd, in_data=None, sudoable=True):
-        """ execute a command on the lxd host """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """execute a command on the lxd host"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
         self._display.vvv(f"EXEC {cmd}", host=self._host())
 
         local_cmd = self._build_command(cmd)
         self._display.vvvvv(f"EXEC {local_cmd}", host=self._host())
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        in_data = to_bytes(in_data, errors='surrogate_or_strict', nonstring='passthru')
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
+        in_data = to_bytes(in_data, errors="surrogate_or_strict", nonstring="passthru")
 
         process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
         stdout, stderr = process.communicate(in_data)
@@ -166,27 +163,23 @@ class Connection(ConnectionBase):
 
         rc, uid_out, err = self.exec_command("/bin/id -u")
         if rc != 0:
-            raise AnsibleError(
-                f"Failed to get remote uid for user {self.get_option('remote_user')}: {err}"
-            )
+            raise AnsibleError(f"Failed to get remote uid for user {self.get_option('remote_user')}: {err}")
         uid = uid_out.strip()
 
         rc, gid_out, err = self.exec_command("/bin/id -g")
         if rc != 0:
-            raise AnsibleError(
-                f"Failed to get remote gid for user {self.get_option('remote_user')}: {err}"
-            )
+            raise AnsibleError(f"Failed to get remote gid for user {self.get_option('remote_user')}: {err}")
         gid = gid_out.strip()
 
         return int(uid), int(gid)
 
     def put_file(self, in_path, out_path):
-        """ put a file from local to lxd """
-        super(Connection, self).put_file(in_path, out_path)
+        """put a file from local to lxd"""
+        super().put_file(in_path, out_path)
 
         self._display.vvv(f"PUT {in_path} TO {out_path}", host=self._host())
 
-        if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
+        if not os.path.isfile(to_bytes(in_path, errors="surrogate_or_strict")):
             raise AnsibleFileNotFound(f"input path is not a file: {in_path}")
 
         local_cmd = [self._lxc_cmd]
@@ -219,33 +212,29 @@ class Connection(ConnectionBase):
 
         self._display.vvvvv(f"PUT {local_cmd}", host=self._host())
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
 
         process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
         process.communicate()
 
     def fetch_file(self, in_path, out_path):
-        """ fetch a file from lxd to local """
-        super(Connection, self).fetch_file(in_path, out_path)
+        """fetch a file from lxd to local"""
+        super().fetch_file(in_path, out_path)
 
         self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self._host())
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):
             local_cmd.extend(["--project", self.get_option("project")])
-        local_cmd.extend([
-            "file", "pull",
-            f"{self.get_option('remote')}:{self._host()}/{in_path}",
-            out_path
-        ])
+        local_cmd.extend(["file", "pull", f"{self.get_option('remote')}:{self._host()}/{in_path}", out_path])
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
 
         process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
         process.communicate()
 
     def close(self):
-        """ close the connection (nothing to do here) """
-        super(Connection, self).close()
+        """close the connection (nothing to do here)"""
+        super().close()
 
         self._connected = False

plugins/connection/qubes.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Based on the buildah connection plugin
 # Copyright (c) 2017 Ansible Project
 #               2018 Kushal Das
@@ -10,7 +9,6 @@
 
 from __future__ import annotations
 
-
 DOCUMENTATION = r"""
 name: qubes
 short_description: Interact with an existing QubesOS AppVM
@@ -41,9 +39,9 @@ options:
 
 import subprocess
 
+from ansible.errors import AnsibleConnectionFailure
 from ansible.module_utils.common.text.converters import to_bytes
 from ansible.plugins.connection import ConnectionBase, ensure_connect
-from ansible.errors import AnsibleConnectionFailure
 from ansible.utils.display import Display
 
 display = Display()
@@ -54,11 +52,11 @@ class Connection(ConnectionBase):
     """This is a connection plugin for qubes: it uses qubes-run-vm binary to interact with the containers."""
 
     # String used to identify this Connection class from other classes
-    transport = 'community.general.qubes'
+    transport = "community.general.qubes"
     has_pipelining = True
 
     def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        super().__init__(play_context, new_stdin, *args, **kwargs)
 
         self._remote_vmname = self._play_context.remote_addr
         self._connected = False
@@ -89,28 +87,29 @@ class Connection(ConnectionBase):
 
         local_cmd.append(shell)
 
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
 
         display.vvvv("Local cmd: ", local_cmd)
 
         display.vvv(f"RUN {local_cmd}", host=self._remote_vmname)
-        p = subprocess.Popen(local_cmd, shell=False, stdin=subprocess.PIPE,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        p = subprocess.Popen(
+            local_cmd, shell=False, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+        )
 
         # Here we are writing the actual command to the remote bash
-        p.stdin.write(to_bytes(cmd, errors='surrogate_or_strict'))
+        p.stdin.write(to_bytes(cmd, errors="surrogate_or_strict"))
         stdout, stderr = p.communicate(input=in_data)
         return p.returncode, stdout, stderr
 
     def _connect(self):
         """No persistent connection is being maintained."""
-        super(Connection, self)._connect()
+        super()._connect()
         self._connected = True
 
-    @ensure_connect
+    @ensure_connect  # type: ignore  # TODO: for some reason, the type infos for ensure_connect suck...
     def exec_command(self, cmd, in_data=None, sudoable=False):
-        """Run specified command in a running QubesVM """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+        """Run specified command in a running QubesVM"""
+        super().exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
         display.vvvv(f"CMD IS: {cmd}")
 
@@ -120,25 +119,25 @@ class Connection(ConnectionBase):
         return rc, stdout, stderr
 
     def put_file(self, in_path, out_path):
-        """ Place a local file located in 'in_path' inside VM at 'out_path' """
-        super(Connection, self).put_file(in_path, out_path)
+        """Place a local file located in 'in_path' inside VM at 'out_path'"""
+        super().put_file(in_path, out_path)
         display.vvv(f"PUT {in_path} TO {out_path}", host=self._remote_vmname)
 
         with open(in_path, "rb") as fobj:
             source_data = fobj.read()
 
-        retcode, dummy, dummy = self._qubes(f'cat > "{out_path}\"\n', source_data, "qubes.VMRootShell")
+        retcode, dummy, dummy = self._qubes(f'cat > "{out_path}"\n', source_data, "qubes.VMRootShell")
         # if qubes.VMRootShell service not supported, fallback to qubes.VMShell and
         # hope it will have appropriate permissions
         if retcode == 127:
-            retcode, dummy, dummy = self._qubes(f'cat > "{out_path}\"\n', source_data)
+            retcode, dummy, dummy = self._qubes(f'cat > "{out_path}"\n', source_data)
 
         if retcode != 0:
-            raise AnsibleConnectionFailure(f'Failed to put_file to {out_path}')
+            raise AnsibleConnectionFailure(f"Failed to put_file to {out_path}")
 
     def fetch_file(self, in_path, out_path):
-        """Obtain file specified via 'in_path' from the container and place it at 'out_path' """
-        super(Connection, self).fetch_file(in_path, out_path)
+        """Obtain file specified via 'in_path' from the container and place it at 'out_path'"""
+        super().fetch_file(in_path, out_path)
         display.vvv(f"FETCH {in_path} TO {out_path}", host=self._remote_vmname)
 
         # We are running in dom0
@@ -147,9 +146,9 @@ class Connection(ConnectionBase):
             p = subprocess.Popen(cmd_args_list, shell=False, stdout=fobj)
             p.communicate()
             if p.returncode != 0:
-                raise AnsibleConnectionFailure(f'Failed to fetch file to {out_path}')
+                raise AnsibleConnectionFailure(f"Failed to fetch file to {out_path}")
 
     def close(self):
-        """ Closing the connection """
-        super(Connection, self).close()
+        """Closing the connection"""
+        super().close()
         self._connected = False