From ab0985a83aab651f6bd30e2c551d47865c8eaa88 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Mon, 21 Jan 2019 11:21:06 -0600 Subject: [PATCH] Update the example for API use to reflect new context object (#50723) --- docs/docsite/rst/dev_guide/developing_api.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_api.rst b/docs/docsite/rst/dev_guide/developing_api.rst index 3f06f8eba56..6d76865d5d2 100644 --- a/docs/docsite/rst/dev_guide/developing_api.rst +++ b/docs/docsite/rst/dev_guide/developing_api.rst @@ -29,13 +29,14 @@ This example is a simple demonstration that shows how to minimally run a couple import json import shutil - from collections import namedtuple + from ansible.module_utils.common.collections import ImmutableDict from ansible.parsing.dataloader import DataLoader from ansible.vars.manager import VariableManager from ansible.inventory.manager import InventoryManager from ansible.playbook.play import Play from ansible.executor.task_queue_manager import TaskQueueManager from ansible.plugins.callback import CallbackBase + from ansible import context import ansible.constants as C class ResultCallback(CallbackBase): @@ -53,9 +54,9 @@ This example is a simple demonstration that shows how to minimally run a couple host = result._host print(json.dumps({host.name: result._result}, indent=4)) - # since API is constructed for CLI it expects certain options to always be set, named tuple 'fakes' the args parsing options object - Options = namedtuple('Options', ['connection', 'module_path', 'forks', 'become', 'become_method', 'become_user', 'check', 'diff']) - options = Options(connection='local', module_path=['/to/mymodules'], forks=10, become=None, become_method=None, become_user=None, check=False, diff=False) + # since the API is constructed for CLI it expects certain options to always be set in the context object + context.CLIARGS = ImmutableDict(connection='local', module_path=['/to/mymodules'], forks=10, become=None, + become_method=None, become_user=None, check=False, diff=False) # initialize needed objects loader = DataLoader() # Takes care of finding and reading yaml, json and ini files @@ -92,7 +93,6 @@ This example is a simple demonstration that shows how to minimally run a couple inventory=inventory, variable_manager=variable_manager, loader=loader, - options=options, passwords=passwords, stdout_callback=results_callback, # Use our custom callback instead of the ``default`` callback plugin, which prints to stdout )