sdk/python/arvados/commands/ls.py

   1 #!/usr/bin/env python
   2
   3 from __future__ import print_function
   4
   5 import argparse
   6 import collections
   7 import logging
   8 import sys
   9
  10 import arvados
  11 import arvados.commands._util as arv_cmd
  12
  13 from arvados._version import __version__
  14
  15 FileInfo = collections.namedtuple('FileInfo', ['stream_name', 'name', 'size'])
  16
  17 def parse_args(args):
  18     parser = argparse.ArgumentParser(
  19         description='List contents of a manifest',
  20         parents=[arv_cmd.retry_opt])
  21
  22     parser.add_argument('locator', type=str,
  23                         help="""Collection UUID or locator""")
  24     parser.add_argument('-s', action='store_true',
  25                         help="""List file sizes, in KiB.""")
  26     parser.add_argument('--version', action='version',
  27                         version="%s %s" % (sys.argv[0], __version__),
  28                         help='Print version and exit.')
  29
  30     return parser.parse_args(args)
  31
  32 def size_formatter(coll_file):
  33     return "{:>10}".format((coll_file.size + 1023) / 1024)
  34
  35 def name_formatter(coll_file):
  36     return "{}/{}".format(coll_file.stream_name, coll_file.name)
  37
  38 def main(args, stdout, stderr, api_client=None, logger=None):
  39     args = parse_args(args)
  40
  41     if api_client is None:
  42         api_client = arvados.api('v1')
  43
  44     if logger is None:
  45         logger = logging.getLogger('arvados.arv-ls')
  46
  47     try:
  48         cr = arvados.CollectionReader(args.locator, api_client=api_client,
  49                                       num_retries=args.retries)
  50     except (arvados.errors.ArgumentError,
  51             arvados.errors.NotFoundError) as error:
  52         logger.error("error fetching collection: {}".format(error))
  53         return 1
  54
  55     formatters = []
  56     if args.s:
  57         formatters.append(size_formatter)
  58     formatters.append(name_formatter)
  59
  60     for f in files_in_collection(cr):
  61         print(*(info_func(f) for info_func in formatters), file=stdout)
  62
  63     return 0
  64
  65 def files_in_collection(c, stream_name='.'):
  66     # Sort first by file type, then alphabetically by file path.
  67     for i in sorted(c.keys(),
  68                     key=lambda k: (
  69                         isinstance(c[k], arvados.collection.Subcollection),
  70                         k.upper())):
  71         if isinstance(c[i], arvados.arvfile.ArvadosFile):
  72             yield FileInfo(stream_name=stream_name,
  73                            name=i,
  74                            size=c[i].size())
  75         elif isinstance(c[i], arvados.collection.Subcollection):
  76             for f in files_in_collection(c[i], "{}/{}".format(stream_name, i)):
  77                 yield f