tapis_cli.commands.taccapis.v2.files package¶

Files service commands

Subpackages¶

Submodules¶

tapis_cli.commands.taccapis.v2.files.copy module¶

class tapis_cli.commands.taccapis.v2.files.copy.FilesCopy(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Copy a Files path between locations within Tapis'¶

LEGACY_COMMMAND_STRING = 'files-copy'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.delete module¶

class tapis_cli.commands.taccapis.v2.files.delete.FilesDelete(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions, tapis_cli.commands.taccapis.v2.files.mixins.ReportProgress

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Delete a file or directory from Tapis'¶

LEGACY_COMMMAND_STRING = 'files-delete'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.download module¶

class tapis_cli.commands.taccapis.v2.files.download.FilesDownload(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.clients.services.mixins.DownloadDirectoryArg, tapis_cli.commands.taccapis.v2.files.mixins.IncludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.ExcludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.OverwritePolicy, tapis_cli.commands.taccapis.v2.files.mixins.ReportProgress

HELP_STRING = 'Download from Tapis to the local host'¶

LEGACY_COMMMAND_STRING = 'files-get'¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.formatters module¶

Formatters customized for system records and listings

class tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatOne

class tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

class tapis_cli.commands.taccapis.v2.files.formatters.FilesHistoryFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

class tapis_cli.commands.taccapis.v2.files.formatters.FilesPemsFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

tapis_cli.commands.taccapis.v2.files.history module¶

class tapis_cli.commands.taccapis.v2.files.history.FilesHistory(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany, tapis_cli.clients.services.mixins.AgaveURI

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List history for a Files'¶

LEGACY_COMMMAND_STRING = 'files-history'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.list module¶

class tapis_cli.commands.taccapis.v2.files.list.FilesList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FilesOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List contents of a Files path'¶

LEGACY_COMMMAND_STRING = 'files-list'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.mixins module¶

Files-specfic mixins

class tapis_cli.commands.taccapis.v2.files.mixins.ExcludeFiles¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to accept a list of files to exclude

Sets ‘parsed_args.exclude_files’

extend_parser(parser)¶

class tapis_cli.commands.taccapis.v2.files.mixins.FileOptions¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to accept rendering options for a single file

extend_parser(parser)¶

class tapis_cli.commands.taccapis.v2.files.mixins.FilesOptions¶

Bases: tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

Configures a Command to accept rendering options for a list of files

Extends parser to set ‘parsed_args.ls_sort_reverse’, ‘parsed_args.ls_sort_size’, and ‘parsed_args.ls_sort_time’. Also provides a ‘sort_table’ function to sort a table by designated header.

extend_parser(parser)¶

classmethod sort_table(rows, headers, header='name', reverse=False)¶

class tapis_cli.commands.taccapis.v2.files.mixins.FilesCallbackURI¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to accept a URI to call when a files action is complete

Sets ‘parsed_args.files_callback_uri’

extend_parser(parser)¶

class tapis_cli.commands.taccapis.v2.files.mixins.IncludeFiles¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to accept a list of files to include

Sets ‘parsed_args.include_files’

extend_parser(parser)¶

class tapis_cli.commands.taccapis.v2.files.mixins.OverwritePolicy¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to allow specification of file overwrite policy

Sets ‘parsed_args.overwrite’ or ‘parsed_args.sync’

extend_parser(parser)¶

class tapis_cli.commands.taccapis.v2.files.mixins.ReportProgress¶

Bases: tapis_cli.clients.services.mixins.ParserExtender

Configures a Command to report progress to STDERR

Sets ‘parsed_args.progress’

extend_parser(parser)¶

tapis_cli.commands.taccapis.v2.files.mkdir module¶

class tapis_cli.commands.taccapis.v2.files.mkdir.FilesMakeDir(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Create a directory on a System'¶

LEGACY_COMMMAND_STRING = 'files-mkdir'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.move module¶

class tapis_cli.commands.taccapis.v2.files.move.FilesMove(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Move a Files path from one location to another on a System'¶

LEGACY_COMMMAND_STRING = 'files-move'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.pems_drop module¶

class tapis_cli.commands.taccapis.v2.files.pems_drop.FilesPemsDrop(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany, tapis_cli.clients.services.mixins.AgaveURI

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Drop all granted permissions from a Files path'¶

LEGACY_COMMMAND_STRING = 'files-pems-update'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.pems_grant module¶

class tapis_cli.commands.taccapis.v2.files.pems_grant.FilesPemsGrant(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Grant permissions on a Files path to a User'¶

LEGACY_COMMMAND_STRING = 'files-pems-update'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.pems_list module¶

class tapis_cli.commands.taccapis.v2.files.pems_list.FilesPemsList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesPemsFormatMany, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List permissions for an specific Files path'¶

LEGACY_COMMMAND_STRING = 'files-pems-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.pems_revoke module¶

class tapis_cli.commands.taccapis.v2.files.pems_revoke.FilesPemsRevoke(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatMany, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Revoke permissions on a Files path for a User'¶

LEGACY_COMMMAND_STRING = 'files-pems-update'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.files.pems_show module¶

class tapis_cli.commands.taccapis.v2.files.pems_show.FilesPemsShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show permissions on a Files path for a User'¶

LEGACY_COMMMAND_STRING = 'files-pems-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.show module¶

class tapis_cli.commands.taccapis.v2.files.show.FilesShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.commands.taccapis.v2.files.mixins.FileOptions

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show details of a Files path'¶

LEGACY_COMMMAND_STRING = 'files-list'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.files.upload module¶

class tapis_cli.commands.taccapis.v2.files.upload.FilesUpload(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.clients.services.mixins.AgaveURI, tapis_cli.clients.services.mixins.LocalFilePath, tapis_cli.commands.taccapis.v2.files.mixins.ExcludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.IncludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.FilesCallbackURI, tapis_cli.commands.taccapis.v2.files.mixins.OverwritePolicy, tapis_cli.commands.taccapis.v2.files.mixins.ReportProgress

HELP_STRING = 'Upload from local host to Tapis'¶

LEGACY_COMMMAND_STRING = 'files-upload'¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.