algorithms.py 7.42 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

###############################################################################
#                                                                             #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.cmdline module of the BEAT platform.          #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform is distributed in the hope that it will be useful, but    #
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################


"""Usage:
  %(prog)s algorithms list [--remote]
  %(prog)s algorithms check [<name>]...
  %(prog)s algorithms pull [--force] [<name>]...
  %(prog)s algorithms push [--force] [--dry-run] [<name>]...
  %(prog)s algorithms diff <name>
  %(prog)s algorithms status
  %(prog)s algorithms create <name>...
  %(prog)s algorithms version <name>
  %(prog)s algorithms fork <src> <dst>
  %(prog)s algorithms rm [--remote] <name>...
  %(prog)s algorithms --help


Commands:
  list      Lists all the algorithms available on the platform
  check     Checks a local algorithm for validity
  pull      Downloads the specified algorithms from the server
  push      Uploads algorithms to the server
  diff      Shows changes between the local algorithm and the remote version
  status    Shows (editing) status for all available algorithms
  create    Creates a new local algorithm
  version   Creates a new version of an existing algorithm
  fork      Forks a local algorithm
  rm        Deletes a local algorithm (unless --remote is specified)


Options:
  --force    Performs operation regardless of conflicts
  --dry-run  Doesn't really perform the task, just comments what would do
  --remote   Only acts on the remote copy of the algorithm
  --help     Display this screen


Examples:

  To list all algorithms available locally:

    $ %(prog)s al list

  To list all algorithms available at the platform:

    $ %(prog)s al list --remote

"""

import logging
logger = logging.getLogger(__name__)

from . import common

from beat.core import algorithm


def pull(webapi, prefix, names, force, indentation, format_cache, lib_cache):
  """Copies algorithms (and required libraries/dataformats) from the server.

  Parameters:

    webapi (object): An instance of our WebAPI class, prepared to access the
      BEAT server of interest

    prefix (str): A string representing the root of the path in which the user
      objects are stored

    names (list): A list of strings, each representing the unique relative path
      of the objects to retrieve or a list of usernames from which to retrieve
      objects. If the list is empty, then we pull all available objects of a
      given type. If no user is set, then pull all public objects of a given
      type.

    force (bool): If set to ``True``, then overwrites local changes with the
      remotely retrieved copies.

    indentation (int): The indentation level, useful if this function is called
      recursively while downloading different object types. This is normally
      set to ``0`` (zero).

    format_cache (dict): A dictionary containing all dataformats already
      downloaded.

    lib_cache (dict): A dictionary containing all libraries already
      downloaded.


  Returns:

    int: Indicating the exit status of the command, to be reported back to the
      calling process. This value should be zero if everything works OK,
      otherwise, different than zero (POSIX compliance).

  """

  from .dataformats import pull as dataformats_pull
  from .libraries import pull as libraries_pull

  status, names = common.pull(webapi, prefix, 'algorithm', names,
          ['declaration', 'code', 'description'], force, indentation)

  if status != 0: return status

  # see what dataformats one needs to pull
  indent = indentation * ' '

  dataformats = []
  libraries = []
  for name in names:
    obj = algorithm.Algorithm(prefix, name)
    dataformats.extend(obj.dataformats.keys())
    libraries.extend(obj.libraries.keys())

  # downloads any formats to which we depend on
  df_status = dataformats_pull(webapi, prefix, dataformats, force,
          indentation + 2, format_cache)

  lib_status = libraries_pull(webapi, prefix, libraries, force,
          indentation + 2, lib_cache)

  return status + df_status + lib_status


def process(args):

  if args['list']:
    if args['--remote']:
      with common.make_webapi(args['config']) as webapi:
        return common.display_remote_list(webapi, 'algorithm')
    else:
      return common.display_local_list(args['config'].path, 'algorithm')

  elif args['check']:
    return common.check(args['config'].path, 'algorithm', args['<name>'])

  elif args['pull']:
    with common.make_webapi(args['config']) as webapi:
      return pull(webapi, args['config'].path, args['<name>'],
              args['--force'], 0, {}, {})

  elif args['push']:
    with common.make_webapi(args['config']) as webapi:
      return common.push(webapi, args['config'].path, 'algorithm',
              args['<name>'], ['name', 'declaration', 'code', 'description'],
              {}, args['--force'], args['--dry-run'], 0)

  elif args['diff']:
    with common.make_webapi(args['config']) as webapi:
      return common.diff(webapi, args['config'].path, 'algorithm',
              args['<name>'][0], ['declaration', 'code', 'description'])

  elif args['status']:
    with common.make_webapi(args['config']) as webapi:
      return common.status(webapi, args['config'].path, 'algorithm')[0]

  elif args['create']:
    return common.create(args['config'].path, 'algorithm', args['<name>'])

  elif args['version']:
    return common.new_version(args['config'].path, 'algorithm',
            args['<name>'][0])

  elif args['fork']:
    return common.fork(args['config'].path, 'algorithm',
            args['<src>'], args['<dst>'])

  elif args['rm']:
    if args['--remote']:
      with common.make_webapi(args['config']) as webapi:
        return common.delete_remote(webapi, 'algorithm', args['<name>'])
    else:
      return common.delete_local(args['config'].path, 'algorithm',
              args['<name>'])

  # Should not happen
  logger.error("unrecognized `algorithms' subcommand")
  return 1