status dictionary is passed to this callable, and is only
returned if the callable's return value does not
evaluate to False or a ValueError exception is raised. If the given
callable supports `**kwargs` it will additionally be passed the
keyword arguments of the original API call.""",
constraints=EnsureCallable() | EnsureNone()),
result_xfm=Parameter(
doc="""if given, each to-be-returned result
status dictionary is passed to this callable, and its return value
becomes the result instead. This is different from
`result_filter`, as it can perform arbitrary transformation of the
result value. This is mostly useful for top-level command invocations
that need to provide the results in a particular format. Instead of
a callable, a label for a pre-crafted result transformation can be
given.""",
constraints=EnsureChoice(*list(known_result_xfms.keys()))
| EnsureCallable() | EnsureNone()),
result_renderer=Parameter(doc="""select rendering mode command results.
'tailored' enables a command-specific rendering style that is typically
tailored to human consumption, if there is one for a specific
command, or otherwise falls back on the the 'generic' result renderer;
'generic' renders each result in one line with key info like action,
status, path, and an optional message);
'json' a complete JSON line serialization of the full result record;
'json_pp' like 'json', but pretty-printed spanning multiple lines;
'disabled' turns off result rendering entirely;
'<template>' reports any value(s) of any result properties in any
format indicated by the template (e.g. '{path}', compare with JSON
output for all key-value choices). The template syntax follows the
Python "format() language". It is possible to report individual
dictionary values, e.g. '{metadata[name]}'. If a 2nd-level key contains
status dictionary is passed to this callable, and is only
returned if the callable's return value does not
evaluate to False or a ValueError exception is raised. If the given
callable supports `**kwargs` it will additionally be passed the
keyword arguments of the original API call.""",
constraints=EnsureCallable() | EnsureNone()),
result_xfm=Parameter(
doc="""if given, each to-be-returned result
status dictionary is passed to this callable, and its return value
becomes the result instead. This is different from
`result_filter`, as it can perform arbitrary transformation of the
result value. This is mostly useful for top-level command invocations
that need to provide the results in a particular format. Instead of
a callable, a label for a pre-crafted result transformation can be
given.""",
constraints=EnsureChoice(*list(known_result_xfms.keys())) | EnsureCallable() | EnsureNone()),
result_renderer=Parameter(
doc="""format of return value rendering on stdout""",
constraints=EnsureChoice('default', 'json', 'json_pp', 'tailored') | EnsureNone()),
on_failure=Parameter(
doc="""behavior to perform on failure: 'ignore' any failure is reported,
but does not cause an exception; 'continue' if any failure occurs an
exception will be raised at the end, but processing other actions will
continue for as long as possible; 'stop': processing will stop on first
failure and an exception is raised. A failure is any result with status
'impossible' or 'error'. Raised exception is an IncompleteResultsError
that carries the result dictionaries of the failures in its `failed`
attribute.""",
constraints=EnsureChoice('ignore', 'continue', 'stop')),
run_before=Parameter(
doc="""DataLad plugin to run before the command. PLUGINSPEC is a list
status dictionary is passed to this callable, and is only
returned if the callable's return value does not
evaluate to False or a ValueError exception is raised. If the given
callable supports `**kwargs` it will additionally be passed the
keyword arguments of the original API call.""",
constraints=EnsureCallable() | EnsureNone()),
result_xfm=Parameter(
doc="""if given, each to-be-returned result
status dictionary is passed to this callable, and its return value
becomes the result instead. This is different from
`result_filter`, as it can perform arbitrary transformation of the
result value. This is mostly useful for top-level command invocations
that need to provide the results in a particular format. Instead of
a callable, a label for a pre-crafted result transformation can be
given.""",
constraints=EnsureChoice(*list(known_result_xfms.keys())) | EnsureCallable() | EnsureNone()),
result_renderer=Parameter(
doc="""format of return value rendering on stdout""",
constraints=EnsureChoice('default', 'json', 'json_pp', 'tailored') | EnsureNone()),
on_failure=Parameter(
doc="""behavior to perform on failure: 'ignore' any failure is reported,
but does not cause an exception; 'continue' if any failure occurs an
exception will be raised at the end, but processing other actions will
continue for as long as possible; 'stop': processing will stop on first
failure and an exception is raised. A failure is any result with status
'impossible' or 'error'. Raised exception is an IncompleteResultsError
that carries the result dictionaries of the failures in its `failed`
attribute.""",
constraints=EnsureChoice('ignore', 'continue', 'stop')),
proc_pre=Parameter(
doc="""DataLad procedure to run prior to the main command. The argument