copyxnat.xnat.commands module

Commands defining actions that can be performed with copyxnat

class copyxnat.xnat.commands.Command(inputs, scope)

Bases: object

Wraps a command function and its input variables

print_results()

Output results to user

run(xnat_item)

Run this command recursively on the xnat_item and its children

Xnat_item

The source server XnatItem to process

Returns

True if the command was actually run on any item

run_next(xnat_item, from_parent=None)

Run this command recursively on the xnat_item and its children. This method is called recursively from within the _run() method

Xnat_item

The source server XnatItem to process

From_parent

The value returned by this function when it was run on

this xnat_item’s parent :returns: True if the command was actually run on any item

class copyxnat.xnat.commands.CommandInputs(dst_xnat, reporter, app_settings, rsync, processed_counts, dst_project=None)

Bases: object

Wrap global input variables for a command