[arvados] updated: 2.5.0-55-g1da341c2d
git repository hosting
git at public.arvados.org
Sun Jan 29 18:47:48 UTC 2023
Summary of changes:
doc/sdk/python/cookbook.html.textile.liquid | 140 +++++++++++++++++++---------
1 file changed, 96 insertions(+), 44 deletions(-)
via 1da341c2da87314a7d42a653fcdfb3d51d332ce2 (commit)
via 4d347fd29f4f7767bc7e9e4af49eda877a5f488c (commit)
via 9e674938db7e1a92497ffb0cc97cfb92ea37a885 (commit)
via ddbae2e44ddf1f0cd2209fa77d9ab808632726ce (commit)
via e94156e4f8e96bef62387910003d0f10339d8308 (commit)
via 09e8bd30b84bbeb25ab8e3630c448f6e174ac37f (commit)
via daf69c3eba0f80aa6f18b46bc4fa797a57190fc4 (commit)
via e074cb71b521f11531f3c8059bf752cfec5e02a8 (commit)
from daab28c11f17210a29b2cd3cd2b0cd4797d8e013 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 1da341c2da87314a7d42a653fcdfb3d51d332ce2
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:23:32 2023 -0500
19792: Improve wording of keyset_list_all first argument comment
Explain the purpose of the argument in addition to giving the reader
guardrails to help them use it correctly.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index 2ee0ee4d7..72c779894 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -85,7 +85,8 @@ The API provides a "dedicated groups method named @shared@":{{ site.baseurl }}/a
{% 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.
@@ -130,7 +131,8 @@ The API provides a "dedicated groups method named @contents@":{{ site.baseurl }}
{% 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.
@@ -189,7 +191,8 @@ To modify an existing permission—for example, to change its access level—fin
{% codeblock as python %}
import arvados.util
for permission 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.links().list,
filters=[
# You should use this filter for all permission searches,
@@ -218,7 +221,8 @@ To revoke an existing permission, find the existing link object for the permissi
{% codeblock as python %}
import arvados.util
for permission 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.links().list,
filters=[
# You should use this filter for all permission searches,
@@ -715,7 +719,8 @@ When a running container creates a container request to do additional work, the
{% 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
@@ -744,7 +749,8 @@ if parent_container_uuid is None:
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],
@@ -773,7 +779,8 @@ time_filter = datetime.datetime.utcnow()
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.
@@ -818,7 +825,8 @@ If you want to cancel multiple pending container requests, you can list containe
{% 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.
commit 4d347fd29f4f7767bc7e9e4af49eda877a5f488c
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:22:52 2023 -0500
19792: Split container request queue recipes into separate sections
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index 22aa711db..2ee0ee4d7 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -50,6 +50,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
# "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
+## "Cancel multiple pending container requests":#cancel-all-container-requests
h2(#introduction). Introduction
@@ -810,7 +811,9 @@ cancelled_container_request = arv_client.container_requests().update(
).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
commit 9e674938db7e1a92497ffb0cc97cfb92ea37a885
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:28:51 2023 -0500
19792: Add PySDK cookbook recipe to walk a collection
After working on the container request recipes, I realized this was a
gap in the cookbook: how do you work on a collection if you don't know
its structure? This starts to document that.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index 43556e3fa..22aa711db 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -34,6 +34,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
## "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
@@ -455,6 +456,32 @@ collection.remove('ExampleDirectoryPath', recursive=True)
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.
commit ddbae2e44ddf1f0cd2209fa77d9ab808632726ce
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:03:48 2023 -0500
19792: Split container request recipes into separate cookbook sections
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index 96bb121f2..43556e3fa 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -38,11 +38,14 @@ SPDX-License-Identifier: CC-BY-SA-3.0
## "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
@@ -554,9 +557,9 @@ If you have experience running CWL workflows on Workbench 2, it runs through thi
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.
@@ -581,7 +584,9 @@ for mount_name, mount_source in container_request['mounts'].items():
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 at .
+h3(#get-input-of-a-cwl-workflow). Get input of a container or 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 at .
{% codeblock as python %}
container_request = arv_client.container_requests().get(
@@ -591,7 +596,7 @@ cwl_input = container_request['mounts']['/var/lib/cwl/cwl.input.json']['content'
... # 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.
@@ -606,7 +611,9 @@ container_output = arvados.collection.Collection(
... # 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
@@ -694,7 +701,9 @@ for child_container_requests in arvados.util.keyset_list_all(
... # 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
commit e94156e4f8e96bef62387910003d0f10339d8308
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:01:53 2023 -0500
19792: Split collection recipes into separate cookbook sections
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index f77bbfcd5..96bb121f2 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -28,9 +28,12 @@ SPDX-License-Identifier: CC-BY-SA-3.0
# "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
## "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
@@ -367,30 +370,29 @@ new_collection.save_new(
)
{% 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. 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,
@@ -398,29 +400,28 @@ with (
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'@ 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. 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, world!" 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'@ 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. 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,
@@ -440,7 +441,9 @@ collection.remove('ExamplePath')
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
commit 09e8bd30b84bbeb25ab8e3630c448f6e174ac37f
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 13:00:28 2023 -0500
19792: Expand explanation of vocabulary in PySDK cookbook
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index aaf23a284..f77bbfcd5 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -229,7 +229,9 @@ for permission in arvados.util.keyset_list_all(
h2(#working-with-properties). Working with properties
-Container requests, collections, groups, and links can have metadata properties set through their @properties@ field. These properties may be standardized or limited to a defined vocabulary on your cluster. This section provides basic recipes for working with all kinds of properties. For details, refer to the "Metadata properties API reference":{{ site.baseurl }}/api/properties.html.
+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
commit daf69c3eba0f80aa6f18b46bc4fa797a57190fc4
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 12:59:20 2023 -0500
19792: Remove "none" from list of permission names
I misunderstood the API documentation. When it described "none" as a
possible permission level, I took that to mean it was a possible
permission name.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index 2804f13dd..aaf23a284 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -148,7 +148,7 @@ 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 @"none"@, @"can_read"@, @"can_write"@, @"can_manage"@, or @"can_login"@.
+* @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.
commit e074cb71b521f11531f3c8059bf752cfec5e02a8
Author: Brett Smith <brett.smith at curii.com>
Date: Sun Jan 29 12:59:00 2023 -0500
19792: Add overview sentence to PySDK cookbook introduction
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index e8512a3a7..2804f13dd 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -46,7 +46,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
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:
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list