X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ee908b109a95ea962425b435a8a317231829b115..e46caaf835e32106e2da5aa7f895435bd4718da6:/doc/sdk/python/cookbook.html.textile.liquid diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid index 75c51ee5a8..ff3bcf90e0 100644 --- a/doc/sdk/python/cookbook.html.textile.liquid +++ b/doc/sdk/python/cookbook.html.textile.liquid @@ -47,7 +47,7 @@ h2. Get input of a CWL workflow {% codeblock as python %} import arvados api = arvados.api() -container_request_uuid="qr1hi-xvhdp-zzzzzzzzzzzzzzz" +container_request_uuid="zzzzz-xvhdp-zzzzzzzzzzzzzzz" container_request = api.container_requests().get(uuid=container_request_uuid).execute() print(container_request["mounts"]["/var/lib/cwl/cwl.input.json"]) {% endcodeblock %} @@ -58,7 +58,7 @@ h2. Get output of a CWL workflow import arvados import arvados.collection api = arvados.api() -container_request_uuid="qr1hi-xvhdp-zzzzzzzzzzzzzzz" +container_request_uuid="zzzzz-xvhdp-zzzzzzzzzzzzzzz" container_request = api.container_requests().get(uuid=container_request_uuid).execute() collection = arvados.collection.CollectionReader(container_request["output_uuid"]) print(collection.open("cwl.output.json").read()) @@ -89,7 +89,7 @@ def get_cr_state(cr_uuid): elif c['runtime_status'].get('warning', None): return 'Warning' return c['state'] -container_request_uuid = 'qr1hi-xvhdp-zzzzzzzzzzzzzzz' +container_request_uuid = 'zzzzz-xvhdp-zzzzzzzzzzzzzzz' print(get_cr_state(container_request_uuid)) {% endcodeblock %} @@ -98,7 +98,7 @@ h2. List input of child requests {% codeblock as python %} import arvados api = arvados.api() -parent_request_uuid = "qr1hi-xvhdp-zzzzzzzzzzzzzzz" +parent_request_uuid = "zzzzz-xvhdp-zzzzzzzzzzzzzzz" namefilter = "bwa%" # the "like" filter uses SQL pattern match syntax container_request = api.container_requests().get(uuid=parent_request_uuid).execute() parent_container_uuid = container_request["container_uuid"] @@ -117,7 +117,7 @@ h2. List output of child requests {% codeblock as python %} import arvados api = arvados.api() -parent_request_uuid = "qr1hi-xvhdp-zzzzzzzzzzzzzzz" +parent_request_uuid = "zzzzz-xvhdp-zzzzzzzzzzzzzzz" namefilter = "bwa%" # the "like" filter uses SQL pattern match syntax container_request = api.container_requests().get(uuid=parent_request_uuid).execute() parent_container_uuid = container_request["container_uuid"] @@ -136,7 +136,7 @@ h2. List failed child requests {% codeblock as python %} import arvados api = arvados.api() -parent_request_uuid = "qr1hi-xvhdp-zzzzzzzzzzzzzzz" +parent_request_uuid = "zzzzz-xvhdp-zzzzzzzzzzzzzzz" container_request = api.container_requests().get(uuid=parent_request_uuid).execute() parent_container_uuid = container_request["container_uuid"] child_requests = api.container_requests().list(filters=[ @@ -155,7 +155,7 @@ h2. Get log of a child request import arvados import arvados.collection api = arvados.api() -container_request_uuid = "qr1hi-xvhdp-zzzzzzzzzzzzzzz" +container_request_uuid = "zzzzz-xvhdp-zzzzzzzzzzzzzzz" container_request = api.container_requests().get(uuid=container_request_uuid).execute() collection = arvados.collection.CollectionReader(container_request["log_uuid"]) for c in collection: @@ -169,7 +169,7 @@ h2(#sharing_link). Create a collection sharing link import arvados api = arvados.api() download="https://your.download.server" -collection_uuid="qr1hi-4zz18-zzzzzzzzzzzzzzz" +collection_uuid="zzzzz-4zz18-zzzzzzzzzzzzzzz" token = api.api_client_authorizations().create(body={"api_client_authorization":{"scopes": [ "GET /arvados/v1/collections/%s" % collection_uuid, "GET /arvados/v1/collections/%s/" % collection_uuid, @@ -185,8 +185,8 @@ Note, if two collections have files of the same name, the contents will be conca import arvados import arvados.collection api = arvados.api() -project_uuid = "qr1hi-tpzed-zzzzzzzzzzzzzzz" -collection_uuids = ["qr1hi-4zz18-aaaaaaaaaaaaaaa", "qr1hi-4zz18-bbbbbbbbbbbbbbb"] +project_uuid = "zzzzz-tpzed-zzzzzzzzzzzzzzz" +collection_uuids = ["zzzzz-4zz18-aaaaaaaaaaaaaaa", "zzzzz-4zz18-bbbbbbbbbbbbbbb"] combined_manifest = "" for u in collection_uuids: c = api.collections().get(uuid=u).execute() @@ -201,7 +201,7 @@ h2. Upload a file into a new collection import arvados import arvados.collection -project_uuid = "qr1hi-j7d0g-zzzzzzzzzzzzzzz" +project_uuid = "zzzzz-j7d0g-zzzzzzzzzzzzzzz" collection_name = "My collection" filename = "file1.txt" @@ -223,7 +223,7 @@ h2. Download a file from a collection import arvados import arvados.collection -collection_uuid = "qr1hi-4zz18-zzzzzzzzzzzzzzz" +collection_uuid = "zzzzz-4zz18-zzzzzzzzzzzzzzz" filename = "file1.txt" api = arvados.api() @@ -237,7 +237,7 @@ with c.open(filename, "rb") as reader: print("Finished downloading %s" % filename) {% endcodeblock %} -h2. Copy files from a collection a new collection +h2. Copy files from a collection to a new collection {% codeblock as python %} import arvados.collection @@ -257,3 +257,34 @@ for f in files_to_copy: target.save_new(name=target_name, owner_uuid=target_project) print("Created collection %s" % target.manifest_locator()) {% endcodeblock %} + +h2. Copy files from a collection to another collection + +{% codeblock as python %} +import arvados.collection + +source_collection = "x1u39-4zz18-krzg64ufvehgitl" +target_collection = "x1u39-4zz18-67q94einb8ptznm" +files_to_copy = ["folder1/sample1/sample1_R1.fastq", + "folder1/sample2/sample2_R1.fastq"] + +source = arvados.collection.CollectionReader(source_collection) +target = arvados.collection.Collection(target_collection) + +for f in files_to_copy: + target.copy(f, "", source_collection=source) + +target.save() +{% endcodeblock %} + +h2. Listing records with paging + +Use the @arvados.util.keyset_list_all@ helper method to iterate over all the records matching an optional filter. This method handles paging internally and returns results incrementally using a Python iterator. The first parameter of the method takes a @list@ method of an Arvados resource (@collections@, @container_requests@, etc). + +{% codeblock as python %} +import arvados.util + +api = arvados.api() +for c in arvados.util.keyset_list_all(api.collections().list, filters=[["name", "like", "%sample123%"]]): + print("got collection " + c["uuid"]) +{% endcodeblock %}