doc/sdk/python/cookbook.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: Python
   5 title: Code cookbook
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 h2. Cancel a container request
  14
  15 <code>
  16 import arvados
  17 arvados.api().container_requests().update(uuid=container_request_uuid, body={"priority": 0}).execute()
  18 </code>
  19
  20 h2. Cancel all container requests
  21
  22 <code>
  23 import arvados
  24 api = arvados.api()
  25 result = api.container_requests().list(filters=[["state", "=", "Committed"], ["priority", ">", "0"]]).execute()["items"]
  26 for container_request in result:
  27     api.container_requests().update(uuid=container_request["uuid"], body={"priority": 0}).execute()
  28 </code>
  29
  30 h2. List completed container requests
  31
  32 <code>
  33 import arvados
  34 api = arvados.api()
  35 result = api.container_requests().list(filters=[["name", "like", name], ["state", "=", "Final"]]).execute()["items"]
  36 container_uuids = [cr["container_uuid"] for cr in result]
  37 containers = api.containers().list(filters=[["uuid", "in", container_uuids]]).execute()["items"]
  38 container_dict = {c["uuid"]: c for c in containers}
  39
  40 for container_request in result:
  41     container = container_dict[container_request["container_uuid"]]
  42     print("%s, %s, %s" % (container_request["uuid"], container_request["name"], "Success" if container["exit_code"] == 0 else "Failed"))
  43 </code>
  44
  45 h2. Get input of a CWL workflow
  46
  47 <code>
  48 import arvados
  49 api = arvados.api()
  50 container_request = arvados.api().container_requests().get(uuid=container_request_uuid).execute()
  51 print(container_request["mounts"]["/var/lib/cwl/cwl.input.json"])
  52 </code>
  53
  54 h2. Get output of a CWL workflow
  55
  56 <code>
  57 import arvados
  58 import arvados.collection
  59 api = arvados.api()
  60 container_request = arvados.api().container_requests().get(uuid=container_request_uuid).execute()
  61 collection = arvados.collection.CollectionReader(container_request["output_uuid"])
  62 print(collection.open("cwl.output.json").read())
  63 </code>
  64
  65 h2. List input of child requests
  66
  67 <code>
  68 import arvados
  69 api = arvados.api()
  70 parent_request_uuid = "qr1hi-xvhdp-zzzzzzzzzzzzzzz"
  71 namefilter = "bwa%"
  72 container_request = arvados.api().container_requests().get(uuid=parent_request_uuid).execute()
  73 parent_container_uuid = container_request["container_uuid"]
  74 child_requests = arvados.api().container_requests().list(filters=[
  75     ["requesting_container_uuid", "=", parent_container_uuid],
  76     ["name", "like", namefilter]]).execute()
  77 for c in child_requests["items"]:
  78     print("%s" % c["name"])
  79     for m in c["mounts"].values():
  80         if "portable_data_hash" in m:
  81             print("  %s" % m["portable_data_hash"])
  82 </code>
  83
  84 h2. List output of child requests
  85
  86 <code>
  87 import arvados
  88 api = arvados.api()
  89 parent_request_uuid = "qr1hi-xvhdp-61y7cjymnhyp7yu"
  90 namefilter = "bwa%"
  91 container_request = arvados.api().container_requests().get(uuid=parent_request_uuid).execute()
  92 parent_container_uuid = container_request["container_uuid"]
  93 child_requests = arvados.api().container_requests().list(filters=[
  94     ["requesting_container_uuid", "=", parent_container_uuid],
  95     ["name", "like", namefilter]]).execute()
  96 output_uuids = [c["output_uuid"] for c in child_requests["items"]]
  97 collections = arvados.api().collections().list(filters=[["uuid", "in", output_uuids]]).execute()
  98 uuid_to_pdh = {c["uuid"]: c["portable_data_hash"] for c in collections["items"]}
  99 for c in child_requests["items"]:
 100     print("%s -> %s" % (c["name"], uuid_to_pdh[c["output_uuid"]]))
 101 </code>
 102
 103 h2. List failed child requests
 104
 105 <code>
 106 import arvados
 107 api = arvados.api()
 108 parent_request_uuid = "qr1hi-xvhdp-3d8f1zatx1xio36"
 109 container_request = arvados.api().container_requests().get(uuid=parent_request_uuid).execute()
 110 parent_container_uuid = container_request["container_uuid"]
 111 child_requests = arvados.api().container_requests().list(filters=[
 112     ["requesting_container_uuid", "=", parent_container_uuid]], limit=1000).execute()
 113 child_containers = {c["container_uuid"]: c for c in child_requests["items"]}
 114 cancelled_child_containers = arvados.api().containers().list(filters=[
 115     ["exit_code", "!=", "0"],
 116     ["uuid", "in", child_containers.keys()]], limit=1000).execute()
 117 for c in cancelled_child_containers["items"]:
 118     print("%s (%s)" % (child_containers[c["uuid"]]["name"], child_containers[c["uuid"]]["uuid"]))
 119 </code>
 120
 121 h2. Get log of a child request
 122
 123 <code>
 124 import arvados
 125 import arvados.collection
 126 api = arvados.api()
 127 container_request_uuid = "qr1hi-xvhdp-3d8f1zatx1xio36"
 128 container_request = arvados.api().container_requests().get(uuid=container_request_uuid).execute()
 129 collection = arvados.collection.CollectionReader(container_request["log_uuid"])
 130 for c in collection:
 131     print(collection.open(c).read())
 132 </code>
 133
 134 h2. Create a collection sharing link
 135
 136 <code>
 137 import arvados
 138 api = arvados.api()
 139 download="https://your.download.server"
 140 collection_uuid="your-4zz18-collectionuuid"
 141 token = api.api_client_authorizations().create(body={"api_client_authorization":{"scopes": [
 142     "GET /arvados/v1/collections/%s" % collection_uuid,
 143     "GET /arvados/v1/collections/%s/" % collection_uuid,
 144     "GET /arvados/v1/keep_services/accessible"]}}).execute()
 145 print("%s/c=%s/t=%s/_/" % (download, collection_uuid, token["api_token"]))
 146 </code>