nvflare.fuel.hci.client.file_transfer module

class FileTransferModule(upload_dir: str, download_dir: str)[source]

Bases: CommandModule

Command module with commands relevant to file transfer.

download_binary_file(args, ctx: CommandContext)[source]
download_file(args, ctx: CommandContext, cmd_name, str_to_file_func)[source]
download_folder(args, ctx: CommandContext)[source]
download_text_file(args, ctx: CommandContext)[source]
generate_module_spec(server_cmd_spec: CommandSpec)[source]

Generate a new module spec based on a server command

Parameters:

server_cmd_spec

Returns:

get_spec()[source]
info(args, ctx: CommandContext)[source]
pull_binary_file(args, ctx: CommandContext)[source]

Args: cmd_name, ctl_id, folder_name, file_name, [end]

pull_folder(args, ctx: CommandContext)[source]
push_folder(args, ctx: CommandContext)[source]
upload_binary_file(args, ctx: CommandContext)[source]
upload_file(args, ctx: CommandContext, cmd_name, file_to_str_func)[source]
upload_text_file(args, ctx: CommandContext)[source]