# "Working with projects":#working-with-projects
## "Create a project":#create-a-project
## "List the contents of a project":#list-project-contents
+# "Working with permissions":#working-with-permissions
+## "Grant permission to an object":#grant-permission
+## "Modify permission on an object":#modify-permission
+## "Revoke permission from an object":#revoke-permission
+# "Working with properties":#working-with-properties
+## "Update the properties of an object":#update-properties
+## "Translate between vocabulary identifiers and labels":#translating-between-vocabulary-identifiers-and-labels
+## "Query the vocabulary definition":#querying-the-vocabulary-definition
# "Working with collections":#working-with-collections
## "Load and update an existing collection":#load-collection
## "Create and save a new collection":#create-collection
-## "Read a file from a collection":#download-a-file-from-a-collection
-## "Write a file to a collection":#upload-a-file-into-a-new-collection
+## "Read a file from a collection":#read-a-file-from-a-collection
+## "Download a file from a collection":#download-a-file-from-a-collection
+## "Write a file to a collection":#write-a-file-into-a-new-collection
+## "Upload a file to a collection":#upload-a-file-into-a-new-collection
## "Delete a file from a collection":#delete-a-file-from-an-existing-collection
+## "Delete a directory from a collection recursively":#delete-a-directory-from-a-collection
+## "Walk over all files in a collection":#walk-collection
## "Copy a file between collections":#copy-files-from-a-collection-to-another-collection
## "Combine two or more collections":#combine-two-or-more-collections
## "Create a collection sharing link":#sharing-link
# "Working with containers and workflow runs":#working-with-containers
-## "Get input of a container or CWL workflow run":#get-input-of-a-cwl-workflow
-## "Get output of a container or CWL workflow run":#get-output-of-a-cwl-workflow
+## "Get input of a container":#get-input-of-a-container
+## "Get input of a CWL workflow run":#get-input-of-a-cwl-workflow
+## "Get output of a container":#get-output-of-a-container
+## "Get output of a CWL workflow run":#get-output-of-a-cwl-workflow
## "Get logs of a container or CWL workflow run":#get-log-of-a-child-request
## "Get status of a container or CWL workflow run":#get-state-of-a-cwl-workflow
## "List child requests of a container or CWL workflow run":#list-failed-child-requests
+## "List child requests of a container request":#list-child-requests-of-container-request
# "Working with the container request queue":#working-with-container-request-queue
## "List completed container requests":#list-completed-container-requests
## "Cancel a container request":#cancel-a-container-request
-# "Working with vocabularies":#working-with-vocabularies
-## "Query the vocabulary definition":#querying-the-vocabulary-definition
-## "Translate between vocabulary identifiers and labels":#translating-between-vocabulary-identifiers-and-labels
+## "Cancel multiple pending container requests":#cancel-all-container-requests
h2(#introduction). Introduction
-This page assumes you've already read the "API client documentation":{{ site.baseurl }}/sdk/python/api-client.html and understand the basics of using the Python SDK client. You don't have to have the details of every API method memorized, but you should at least be comfortable with the pattern of calling a resource type, API method, and @execute()@, as well as the dictionaries these methods return.
+This page provides example code to perform various high-level tasks using Arvados' Python SDK. This page assumes you've already read the "API client documentation":{{ site.baseurl }}/sdk/python/api-client.html and understand the basics of using the Python SDK client. You don't have to have the details of every API method memorized, but you should at least be comfortable with the pattern of calling a resource type, API method, and @execute()@, as well as the dictionaries these methods return.
The code examples assume you've built the @arv_client@ object by doing something like:
{% codeblock as python %}
for item in arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.groups().shared,
# Pass filters to limit what objects are returned.
# This example returns only subprojects.
{% codeblock as python %}
current_user = arv_client.users().current().execute()
for item in arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.groups().contents,
# The UUID of the project whose contents we're listing.
# Pass a user UUID to list their home project.
... # Work on item as desired
{% endcodeblock %}
+h2(#working-with-permissions). Working with permissions
+
+In brief, a permission is represented in Arvados as a link object with the following values:
+
+* @link_class@ is @"permission"@.
+* @name@ is one of @"can_read"@, @"can_write"@, @"can_manage"@, or @"can_login"@.
+* @tail_uuid@ identifies the user or role group that receives the permission.
+* @head_uuid@ identifies the Arvados object this permission grants access to.
+
+For details, refer to the "Permissions model documentation":{{ site.baseurl }}/api/permission-model.html. Managing permissions is just a matter of ensuring the desired links exist using the standard @create@, @update@, and @delete@ methods.
+
+h3(#grant-permission). Grant permission to an object
+
+Create a link with values as documented above.
+
+{% codeblock as python %}
+permission = arv_client.links().create(
+ body={
+ 'link': {
+ 'link_class': 'permission',
+ # Adjust name for the level of permission you want to grant
+ 'name': 'can_read',
+ # tail_uuid must identify a user or role group
+ 'tail_uuid': 'zzzzz-tpzed-12345abcde67890',
+ # head_uuid can identify any Arvados object
+ 'head_uuid': 'zzzzz-4zz18-12345abcde67890',
+ },
+ },
+).execute()
+{% endcodeblock %}
+
+h3(#modify-permission). Modify permission on an object
+
+To modify an existing permission—for example, to change its access level—find the existing link object for the permission, then update it with the new values you want. This example shows changing all read-write permissions on a specific collection to read-only. Adjust the filters appropriately to find the permission(s) you want to modify.
+
+{% codeblock as python %}
+import arvados.util
+for permission in arvados.util.keyset_list_all(
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
+ arv_client.links().list,
+ filters=[
+ # You should use this filter for all permission searches,
+ # to exclude other kinds of links.
+ ['link_class', '=', 'permission'],
+ # Add other filters as desired.
+ ['name', '=', 'can_write'],
+ ['head_uuid', '=', 'zzzzz-4zz18-12345abcde67890'],
+ ...,
+ ],
+):
+ arv_client.links().update(
+ uuid=permission['uuid'],
+ body={
+ 'link': {
+ 'name': 'can_read',
+ },
+ },
+ ).execute()
+{% endcodeblock %}
+
+h3(#revoke-permission). Revoke permission from an object
+
+To revoke an existing permission, find the existing link object for the permission, then delete it. This example shows revoking one user's permission to log into any virtual machines. Adjust the filters appropriately to find the permission(s) you want to revoke.
+
+{% codeblock as python %}
+import arvados.util
+for permission in arvados.util.keyset_list_all(
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
+ arv_client.links().list,
+ filters=[
+ # You should use this filter for all permission searches,
+ # to exclude other kinds of links.
+ ['link_class', '=', 'permission'],
+ # Add other filters as desired.
+ ['name', '=', 'can_login'],
+ ['tail_uuid', '=', 'zzzzz-tpzed-12345abcde67890'],
+ ...,
+ ],
+):
+ arv_client.links().delete(
+ uuid=permission['uuid'],
+ ).execute()
+{% endcodeblock %}
+
+h2(#working-with-properties). Working with properties
+
+Container requests, collections, groups, and links can have metadata properties set through their @properties@ field. For details, refer to the "Metadata properties API reference":{{ site.baseurl }}/api/properties.html.
+
+An Arvados cluster can be configured to use a metadata vocabulary. If this is set up, the vocabulary defines standard identifiers and specific properties and their values. These identifiers can also have more human-friendly aliases. The cluster can also be configured to use the vocabulary strictly, so clients may _only_ set properties on objects that are defined in the vocabulary. For more information about configuring a metadata vocabulary, refer to the "Metadata vocabulary administration documentation":{{ site.baseurl }}/admin/metadata-vocabulary.html.
+
+h3(#update-properties). Update the properties of an object
+
+To set an object's properties to a new value, just call the resource's @update@ method with a new @properties@ field in the body. If you want to make changes to the current set of properties, @get@ the object, build a new dictionary based on its @properties@ field, then call the resource's @update@ method with your new dictionary as the @properties@. Below is an example for a container request.
+
+{% codeblock as python %}
+container_request = arv_client.container_requests().get(
+ uuid='zzzzz-xvhdp-12345abcde67890',
+).execute()
+new_properties = dict(container_request['properties'])
+... # Make your desired changes to new_proprties
+container_request = arv_client.container_requests().update(
+ uuid=container_request['uuid'],
+ body={
+ 'container_request': {
+ 'properties': new_properties,
+ },
+ },
+).execute()
+{% endcodeblock %}
+
+h3(#translating-between-vocabulary-identifiers-and-labels). Translate between vocabulary identifiers and labels
+
+Client software might need to present properties to the user in a human-readable form or take input from the user without requiring them to remember identifiers. The "@Vocabulary.convert_to_labels@":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary.convert_to_labels and "@Vocabulary.convert_to_identifiers@":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary.convert_to_identifiers methods help with these tasks, respectively.
+
+{% codeblock as python %}
+import arvados.vocabulary
+vocabulary = arvados.vocabulary.load_vocabulary(arv_client)
+
+# The argument should be a mapping of vocabulary keys and values using any
+# defined aliases, like this:
+# {'Creature': 'Human', 'Priority': 'Normal'}
+# The return value will be an analogous mapping where all the aliases have
+# been translated to identifiers, like this:
+# {'IDTAGANIMALS': 'IDVALANIMALS2', 'IDTAGIMPORTANCES': 'IDTAGIMPORTANCES1'}
+properties_by_identifier = vocabulary.convert_to_identifiers({...})
+
+# You can use this to set metadata properties on objects that support them.
+project = arv_client.groups().update(
+ uuid='zzzzz-j7d0g-12345abcde67890',
+ body={
+ 'group': {
+ 'properties': properties_by_identifier,
+ },
+ },
+).execute()
+
+# You can report properties to the user by their preferred name.
+print(f"{project['name']} ({project['group_class']} {project['uuid']}) updated with properties:")
+for key, value in vocabulary.convert_to_labels(project['properties']).items():
+ print(f"↳ {key}: {value}")
+{% endcodeblock %}
+
+h3(#querying-the-vocabulary-definition). Query the vocabulary definition
+
+The @arvados.vocabulary@ module provides facilities to interact with the "active metadata vocabulary":{{ site.baseurl }}/admin/metadata-vocabulary.html in the system. The "@Vocabulary@ class":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary provides a mapping-like view of a cluster's configured vocabulary.
+
+{% codeblock as python %}
+import arvados.vocabulary
+vocabulary = arvados.vocabulary.load_vocabulary(arv_client)
+
+# You can use the vocabulary object to access specific keys and values by
+# case-insensitive mapping, like this:
+# vocabulary_value = vocabulary[key_alias][value_alias]
+# You can also access the `key_aliases` and `value_aliases` mapping
+# attributes directly to view the entire vocabulary. The example below
+# writes a plaintext table of the vocabulary.
+for vocabulary_key in set(vocabulary.key_aliases.values()):
+ print(
+ vocabulary_key.identifier,
+ vocabulary_key.preferred_label,
+ ', '.join(vocabulary_key.aliases[1:]),
+ sep='\t',
+ )
+ for vocabulary_value in set(vocabulary_key.value_aliases.values()):
+ print(
+ f'↳ {vocabulary_value.identifier}',
+ vocabulary_value.preferred_label,
+ ', '.join(vocabulary_value.aliases[1:]),
+ sep='\t',
+ )
+{% endcodeblock %}
+
h2(#working-with-collections). Working with collections
The "@arvados.collection.Collection@ class":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.Collection provides a high-level interface to read, create, and update collections. It orchestrates multiple requests to API and Keep so you don't have to worry about the low-level details of keeping everything in sync. It uses threads to make multiple requests to Keep in parallel.
)
{% endcodeblock %}
-h3(#download-a-file-from-a-collection). Read a file from a collection
+h3(#read-a-file-from-a-collection). Read a file from a collection
-Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. It returns a file-like object that you can use in many of the same ways you would use any other file object.
+Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. It returns a file-like object that you can use in many of the same ways you would use any other file object. This example prints all non-empty lines from @ExampleFile@ in your collection:
{% codeblock as python %}
import arvados.collection
collection = arvados.collection.Collection(...)
with collection.open('ExampleFile') as my_file:
- ...
-{% endcodeblock %}
-
-For a low-level example, this code prints all non-empty lines from @ExampleFile@ in your collection:
-
-{% codeblock as python %}
-with collection.open('ExampleFile') as my_file:
+ # Read from my_file as desired.
+ # This example prints all non-empty lines from the file to stdout.
for line in my_file:
if not line.isspace():
print(line, end='')
{% endcodeblock %}
-For a higher-level example, you can pass the returned file object as a source for Python's standard "@shutil.copyfileobj@ function":https://docs.python.org/3/library/shutil.html#shutil.copyfileobj to download it. This code downloads @ExampleFile@ from your collection and saves it to the current working directory as @ExampleDownload@:
+h3(#download-a-file-from-a-collection). Download a file from a collection
+
+Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. You pass a second mode argument like @'rb'@ to open the file in binary mode. It returns a file-like object that you can use in many of the same ways you would use any other file object. You can pass it as a source to Python's standard "@shutil.copyfileobj@ function":https://docs.python.org/3/library/shutil.html#shutil.copyfileobj to download it. This code downloads @ExampleFile@ from your collection and saves it to the current working directory as @ExampleDownload@:
{% codeblock as python %}
+import arvados.collection
import shutil
+collection = arvados.collection.Collection(...)
with (
- collection.open('ExampleFile') as src_file,
- open('ExampleDownload', 'w') as dst_file,
+ collection.open('ExampleFile', 'rb') as src_file,
+ open('ExampleDownload', 'wb') as dst_file,
):
shutil.copyfileobj(src_file, dst_file)
{% endcodeblock %}
-h3(#upload-a-file-into-a-new-collection). Write a file to a collection
+h3(#write-a-file-into-a-new-collection). Write a file to a collection
-Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. Pass a second mode argument like @'w'@ or @'a'@ to write a file in the collection. It returns a file-like object that you can use in many of the same ways you would use any other file object.
+Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. Pass a second mode argument like @'w'@, @'a'@, or @'wb'@ to write a file in the collection. It returns a file-like object that you can use in many of the same ways you would use any other file object. This example writes @Hello, Arvados!@ to a file named @ExampleHello@ in your collection:
{% codeblock as python %}
import arvados.collection
collection = arvados.collection.Collection(...)
with collection.open('ExampleFile', 'w') as my_file:
- ...
-{% endcodeblock %}
-
-For a low-level example, this code writes @Hello, world!@ to a file named @ExampleHello@ in your collection:
-
-{% codeblock as python %}
-with collection.open('ExampleHello', 'w') as my_file:
- print("Hello, world!", file=my_file)
+ # Write to my_file as desired.
+ # This example writes "Hello, Arvados!" to the file.
+ print("Hello, Arvados!", file=my_file)
collection.save_new(...) # or collection.save() to update an existing collection
{% endcodeblock %}
-For a higher-level example, you can pass the returned file object as a destination for Python's standard "@shutil.copyfileobj@ function":https://docs.python.org/3/library/shutil.html#shutil.copyfileobj to upload a file to a collection. This code reads @ExampleFile@ from the current working directory and uploads it into your collection as @ExampleUpload@:
+h3(#upload-a-file-into-a-new-collection). Upload a file to a collection
+
+Once you have a @Collection@ object, the "@Collection.open@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.open lets you open files from a collection the same way you would open files from disk using Python's built-in @open@ function. Pass a second mode argument like @'w'@, @'a'@, or @'wb'@ to write a file in the collection. It returns a file-like object that you can use in many of the same ways you would use any other file object. You can pass it as a destination to Python's standard "@shutil.copyfileobj@ function":https://docs.python.org/3/library/shutil.html#shutil.copyfileobj to upload data from a source file. This example reads @ExampleFile@ from the current working directory and uploads it into your collection as @ExampleUpload@:
{% codeblock as python %}
+import arvados.collection
import shutil
+collection = arvados.collection.Collection(...)
with (
- open('ExampleFile') as src_file,
- collection.open('ExampleUpload', 'w') as dst_file,
+ open('ExampleFile', 'rb') as src_file,
+ collection.open('ExampleUpload', 'wb') as dst_file,
):
shutil.copyfileobj(src_file, dst_file)
collection.save_new(...) # or collection.save() to update an existing collection
collection.save_new(...) # or collection.save() to update an existing collection
{% endcodeblock %}
-Like most Unix tools, @Collection.remove@ will raise an error if you try to remove a non-empty directory. Pass @recursive=True@ to delete everything under that directory from the collection:
+h3(#delete-a-directory-from-a-collection). Delete a directory from a collection recursively
+
+Once you have a @Collection@ object, call the "@Collection.remove@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.Collection.remove with a directory path and @recursive=True@ to delete everything under that directory from the collection.
{% codeblock as python %}
import arvados.collection
collection.save_new(...) # or collection.save() to update an existing collection
{% endcodeblock %}
+h3(#walk-collection). Walk over all files in a collection
+
+Once you have a @Collection@ object, you can iterate over it to retrieve the names of all files and streams in it. Streams are like subdirectories: you can open them using the "@Collection.find@ method":{{ site.baseurl }}/sdk/python/python.html, and work with the files in them just like you would in the original collection. This example shows how to combine these techniques to iterate all files in a collection, including its streams.
+
+{% codeblock as python %}
+import arvados.collection
+import collections
+import pathlib
+root_collection = arvados.collection.Collection(...)
+# Start work from the base stream.
+stream_queue = collections.deque(['.'])
+while stream_queue:
+ stream_name = stream_queue.popleft()
+ collection = root_collection.find(stream_name)
+ for item_name in collection:
+ try:
+ my_file = collection.open(item_name)
+ except IsADirectoryError:
+ # item_name refers to a stream. Queue it to walk later.
+ stream_path = pathlib.Path(stream_name, item_name)
+ stream_queue.append(stream_path.as_posix())
+ continue
+ with my_file:
+ ... # Work with my_file as desired
+{% endcodeblock %}
+
h3(#copy-files-from-a-collection-to-another-collection). Copy a file between collections
Once you have one or more @Collection@ objects, call the "@Collection.copy@ method":{{ site.baseurl }}/sdk/python/arvados/collection.html#arvados.collection.RichCollectionBase.copy on the destination collection to copy files to it. This method doesn't re-upload data, so it's very efficient.
The UUID of the CWL runner container is recorded in the @requesting_container_uuid@ field of each container request it creates. You can list container requests with a filter on this field to inspect each step of the workflow individually, as shown below.
-The next few sections include two examples: a high-level example that describes how to work with any container request, and a more specific example that provides more detail about how to work with CWL workflow runs.
+The next few examples show how to perform a task with a container request generally, and then provide a more specific example of working with a CWL runner container.
-h3(#get-input-of-a-cwl-workflow). Get input of a container or CWL workflow run
+h3(#get-input-of-a-container). Get input of a container
A container request's most varied inputs are recorded in the @mounts@ field, which can include data from Keep, specific collections, Git checkouts, and static files. You might also be interested in the @environment@, @command@, @container_image@, and @secret_mounts@ fields. Refer to the "container requests API documentation":{{ site.baseurl }}/api/methods/container_requests.html for details.
pprint.pprint(mount_source.get('content'))
{% endcodeblock %}
-When you run a CWL workflow, the CWL inputs are stored in a JSON mount named @/var/lib/cwl/cwl.input.json@.
+h3(#get-input-of-a-cwl-workflow). Get input of a CWL workflow run
+
+When you run a CWL workflow, the CWL inputs are stored in the container request's @mounts@ field as a JSON mount named @/var/lib/cwl/cwl.input.json@.
{% codeblock as python %}
container_request = arv_client.container_requests().get(
... # Work with the cwl_input dictionary
{% endcodeblock %}
-h3(#get-output-of-a-cwl-workflow). Get output of a container or CWL workflow run
+h3(#get-output-of-a-container). Get output of a container
A container's output files are saved in a collection. The UUID of that collection is recorded in the @output_uuid@ of the container request, which you can load as you like.
... # Work with the container_output collection object
{% endcodeblock %}
-When you run a CWL workflow, the output collection includes a file named @cwl.output.json@ that provides additional information about other files in the output.
+h3(#get-output-of-a-cwl-workflow). Get output of a CWL workflow run
+
+When you run a CWL workflow, the container request's output collection includes a file named @cwl.output.json@ that provides additional information about other files in the output.
{% codeblock as python %}
import arvados.collection
{% codeblock as python %}
import arvados.util
for child_container_requests in arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.container_requests().list,
filters=[
# Note this is a container UUID, *not* a container request UUID
... # Work with each child container request
{% endcodeblock %}
-If your input only provides the UUID for a container request rather than a container, you can get that container request, then follow the @container_uuid@ field if it is set. (It might not be if the container request has not been dispatched yet.)
+h3(#list-child-requests-of-container-request). List child requests of a container request
+
+When a running container creates a container request to do additional work, the UUID of the source container is recorded in the @requesting_container_uuid@ field of the new container request. If all you have is the UUID of a container request, you can get that request, then list container requests with a filter where @requesting_container_uuid@ matches the @container_uuid@ of your request to find all its children.
{% codeblock as python %}
import arvados.util
child_container_requests = ()
else:
child_container_requests = arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.container_requests().list,
filters=[
['requesting_container_uuid', '=', parent_container_uuid],
time_filter -= datetime.timedelta(days=7)
for container_request in arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.container_requests().list,
filters=[
# This is the filter you need to find completed container requests.
).execute()
{% endcodeblock %}
-p(#cancel-all-container-requests). If you want to cancel many container requests, you can list container requests with the @state@ field set to @"Committed"@, a @priority@ greater than zero, and any other filters you like. Then update each container request in turn.
+h3(#cancel-all-container-requests). Cancel multiple pending container requests
+
+If you want to cancel multiple pending container requests, you can list container requests with the @state@ field set to @"Committed"@, a @priority@ greater than zero, and any other filters you like. Then update each container request to set its @priority@ field to 0. See the "containers API reference":{{ site.baseurl }}/api/methods/containers.html for details.
{% codeblock as python %}
import arvados.util
for container_request in arvados.util.keyset_list_all(
- # Do *not* call the method here, just pass it.
+ # Pass the method keyset_list_all will call to retrieve items.
+ # Do not call it yourself.
arv_client.container_requests().list,
filters=[
# These are the filters you need to find cancellable container requests.
},
).execute()
{% endcodeblock %}
-
-h2(#working-with-vocabularies). Working with vocabularies
-
-h3(#querying-the-vocabulary-definition). Query the vocabulary definition
-
-The @arvados.vocabulary@ module provides facilities to interact with the "active metadata vocabulary":{{ site.baseurl }}/admin/metadata-vocabulary.html in the system. The "@Vocabulary@ class":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary provides a mapping-like view of a cluster's configured vocabulary.
-
-{% codeblock as python %}
-import arvados.vocabulary
-vocabulary = arvados.vocabulary.load_vocabulary(arv_client)
-
-# You can use the vocabulary object to access specific keys and values by
-# case-insensitive mapping, like this:
-# vocabulary_value = vocabulary[key_alias][value_alias]
-# You can also access the `key_aliases` and `value_aliases` mapping
-# attributes directly to view the entire vocabulary. The example below
-# writes a plaintext table of the vocabulary.
-for vocabulary_key in set(vocabulary.key_aliases.values()):
- print(
- vocabulary_key.identifier,
- vocabulary_key.preferred_label,
- ', '.join(vocabulary_key.aliases[1:]),
- sep='\t',
- )
- for vocabulary_value in set(vocabulary_key.value_aliases.values()):
- print(
- f'↳ {vocabulary_value.identifier}',
- vocabulary_value.preferred_label,
- ', '.join(vocabulary_value.aliases[1:]),
- sep='\t',
- )
-{% endcodeblock %}
-
-h3(#translating-between-vocabulary-identifiers-and-labels). Translate between vocabulary identifiers and labels
-
-Client software might need to present properties to the user in a human-readable form or take input from the user without requiring them to remember identifiers. The "@Vocabulary.convert_to_labels@":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary.convert_to_labels and "@Vocabulary.convert_to_identifiers@":{{ site.baseurl }}/sdk/python/arvados/vocabulary.html#arvados.vocabulary.Vocabulary.convert_to_identifiers methods help with these tasks, respectively.
-
-{% codeblock as python %}
-import arvados.vocabulary
-vocabulary = arvados.vocabulary.load_vocabulary(arv_client)
-
-# The argument should be a mapping of vocabulary keys and values using any
-# defined aliases, like this:
-# {'Creature': 'Human', 'Priority': 'Normal'}
-# The return value will be an analogous mapping where all the aliases have
-# been translated to identifiers, like this:
-# {'IDTAGANIMALS': 'IDVALANIMALS2', 'IDTAGIMPORTANCES': 'IDTAGIMPORTANCES1'}
-properties_by_identifier = vocabulary.convert_to_identifiers({...})
-
-# You can use this to set metadata properties on objects that support them.
-project = arv_client.groups().update(
- uuid='zzzzz-j7d0g-12345abcde67890',
- body={
- 'group': {
- 'properties': properties_by_identifier,
- },
- },
-).execute()
-
-# You can report properties to the user by their preferred name.
-print(f"{project['name']} ({project['group_class']} {project['uuid']}) updated with properties:")
-for key, value in vocabulary.convert_to_labels(project['properties']).items():
- print(f"↳ {key}: {value}")
-{% endcodeblock %}
projects / arvados.git / blobdiff