From 4a93b81d44d5b7c8bacead57f2b3b08c106ace12 Mon Sep 17 00:00:00 2001 From: garciart Date: Wed, 1 May 2024 18:25:22 -0400 Subject: [PATCH] Updated the docstring for the v2_runner_on_failed method in the CallbackBase class. --- lib/ansible/plugins/callback/__init__.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/lib/ansible/plugins/callback/__init__.py b/lib/ansible/plugins/callback/__init__.py index 5659887b731..482f9b97f27 100644 --- a/lib/ansible/plugins/callback/__init__.py +++ b/lib/ansible/plugins/callback/__init__.py @@ -28,6 +28,7 @@ from collections.abc import MutableMapping from copy import deepcopy from ansible import constants as C +from ansible.executor.task_result import TaskResult from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.six import text_type from ansible.parsing.ajson import AnsibleJSONEncoder @@ -502,6 +503,20 @@ class CallbackBase(AnsiblePlugin): self.on_any(args, kwargs) def v2_runner_on_failed(self, result, ignore_errors=False): + # type: (TaskResult, bool) -> None + """Show result, output, and optional information, based on verbosity level, vars, and + ansible.cfg settings, if a task failed. + + Customization notes - In this method: + - You can access TaskResult class methods and attributes like result.is_changed() + and result.task_name + - The ansible.executor.task_result.TaskResult class is defined in + lib/ansible/executor/task_result.py + + :param TaskResult result: The result and output of a task + :param bool ignore_errors: The value of the ignore_errors vars + :return: None + """ host = result._host.get_name() self.runner_on_failed(host, result._result, ignore_errors)