Function update_example

tests/autogenerate-rpc-examples.py:398–420

Add example request, response and other details in json array for future use

(node, method, params, response=None, description=None)

def update_example(node, method, params, response=None, description=None):
    """Add example request, response and other details in json array for future use"""
    method_examples = EXAMPLES_JSON.get(method, {'examples': []})
    method_id = len(method_examples['examples']) + 1
    req = {
        'id': f'example:{method}#{method_id}',
        'method': method,
        'params': params
    }
    logger.info(f'Method \'{method}\', Params {params}')
    # Execute the RPC call and get the response
    if response is None:
        response = node.rpc.call(method, params)
    logger.info(f'{method} response: {response}')
    # Return response without updating the file because user doesn't want to update the example
    # Executing the method and returning the response is useful for further example updates
    if method not in REGENERATING_RPCS:
        return response
    else:
        method_examples['examples'].append({'request': req, 'response': response} if description is None else {'description': description, 'request': req, 'response': response})
        EXAMPLES_JSON[method] = method_examples
    logger.info(f'Updated {method}#{method_id} example json')
    return response


def setup_test_nodes(node_factory, bitcoind):