[arvados] updated: 2.7.0-4984-ge9ed1eb8ec
git repository hosting
git at public.arvados.org
Thu Oct 12 18:07:39 UTC 2023
Summary of changes:
sdk/python/arvados/collection.py | 86 +++++++++++++++++++++-------------------
1 file changed, 46 insertions(+), 40 deletions(-)
via e9ed1eb8ec39f40d859489cc2b66687328b3adbc (commit)
via 85ec07b3d4f0a14285a0d20db682c282e490e7e7 (commit)
from ade2c46d4922fff269f4708a0f5a623a3d10bc6c (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 e9ed1eb8ec39f40d859489cc2b66687328b3adbc
Author: Brett Smith <brett.smith at curii.com>
Date: Thu Oct 12 14:06:19 2023 -0400
19821: Convert CollectionWriter.open docstring to Markdown
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/sdk/python/arvados/collection.py b/sdk/python/arvados/collection.py
index d03790411a..e6b816816d 100644
--- a/sdk/python/arvados/collection.py
+++ b/sdk/python/arvados/collection.py
@@ -2059,12 +2059,12 @@ class CollectionWriter(CollectionBase):
You may only have one file object from the Collection open at a time,
so be sure to close the object when you're done. Using the object in
- a with statement makes that easy::
+ a with statement makes that easy:
- with cwriter.open('./doc/page1.txt') as outfile:
- outfile.write(page1_data)
- with cwriter.open('./doc/page2.txt') as outfile:
- outfile.write(page2_data)
+ with cwriter.open('./doc/page1.txt') as outfile:
+ outfile.write(page1_data)
+ with cwriter.open('./doc/page2.txt') as outfile:
+ outfile.write(page2_data)
"""
if filename is None:
streampath, filename = split(streampath)
commit 85ec07b3d4f0a14285a0d20db682c282e490e7e7
Author: Brett Smith <brett.smith at curii.com>
Date: Thu Oct 12 14:00:49 2023 -0400
19821: Fully qualify docstring types
This gets pdoc to hyperlink the type.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/sdk/python/arvados/collection.py b/sdk/python/arvados/collection.py
index 0f2ec4c96f..d03790411a 100644
--- a/sdk/python/arvados/collection.py
+++ b/sdk/python/arvados/collection.py
@@ -567,7 +567,7 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * source_obj: ArvadosFile | Subcollection --- The file or subcollection
+ * source_obj: arvados.arvfile.ArvadosFile | Subcollection --- The file or subcollection
to add to this collection
* target_name: str --- The path inside this collection where
@@ -660,17 +660,18 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * source: str | ArvadosFile | Subcollection --- The file or
- subcollection to add to this collection. If `source` is a str, the
- object will be found by looking up this path from `source_collection`
- (see below).
+ * source: str | arvados.arvfile.ArvadosFile |
+ arvados.collection.Subcollection --- The file or subcollection to
+ add to this collection. If `source` is a str, the object will be
+ found by looking up this path from `source_collection` (see
+ below).
* target_path: str --- The path inside this collection where the
source object should be added.
- * source_collection: Collection | None --- The collection to find the
- source object from when `source` is a path. Defaults to the current
- collection (`self`).
+ * source_collection: arvados.collection.Collection | None --- The
+ collection to find the source object from when `source` is a
+ path. Defaults to the current collection (`self`).
* overwrite: bool --- Controls the behavior of this method when the
collection already contains an object at `target_path`. If `False`
@@ -693,17 +694,18 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * source: str | ArvadosFile | Subcollection --- The file or
- subcollection to add to this collection. If `source` is a str, the
- object will be found by looking up this path from `source_collection`
- (see below).
+ * source: str | arvados.arvilfe.ArvadosFile |
+ arvados.collection.Subcollection --- The file or subcollection to
+ add to this collection. If `source` is a str, the object will be
+ found by looking up this path from `source_collection` (see
+ below).
* target_path: str --- The path inside this collection where the
source object should be added.
- * source_collection: Collection | None --- The collection to find the
- source object from when `source` is a path. Defaults to the current
- collection (`self`).
+ * source_collection: arvados.collection.Collection | None --- The
+ collection to find the source object from when `source` is a
+ path. Defaults to the current collection (`self`).
* overwrite: bool --- Controls the behavior of this method when the
collection already contains an object at `target_path`. If `False`
@@ -846,16 +848,17 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * end_collection: RichCollectionBase --- A collection object with the
- desired end state. The returned diff list will describe how to go
- from the current collection object `self` to `end_collection`.
+ * end_collection: arvados.collection.RichCollectionBase --- A
+ collection object with the desired end state. The returned diff
+ list will describe how to go from the current collection object
+ `self` to `end_collection`.
* prefix: str --- The name to use for this collection's stream in
the diff list. Default `'.'`.
- * holding_collection: Collection | None --- A collection object used to
- hold objects for the returned diff list. By default, a new empty
- collection is created.
+ * holding_collection: arvados.collection.Collection | None --- A
+ collection object used to hold objects for the returned diff
+ list. By default, a new empty collection is created.
"""
changes = []
if holding_collection is None:
@@ -889,8 +892,8 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * changes: ChangeList --- The list of differences generated by
- `RichCollectionBase.diff`.
+ * changes: arvados.collection.ChangeList --- The list of differences
+ generated by `RichCollectionBase.diff`.
"""
if changes:
self.set_committed(False)
@@ -948,8 +951,8 @@ class RichCollectionBase(CollectionBase):
Arguments:
- * callback: ChangeCallback --- The callable to call each time the
- collection is changed.
+ * callback: arvados.collection.ChangeCallback --- The callable to
+ call each time the collection is changed.
"""
if self._callback is None:
self._callback = callback
@@ -984,12 +987,14 @@ class RichCollectionBase(CollectionBase):
* event: Literal[ADD, DEL, MOD, TOK] --- The type of modification to
the collection.
- * collection: RichCollectionBase --- The collection that was modified.
+ * collection: arvados.collection.RichCollectionBase --- The
+ collection that was modified.
* name: str --- The name of the file or stream within `collection` that
was modified.
- * item: ArvadosFile | Subcollection --- The new contents at `name`
+ * item: arvados.arvfile.ArvadosFile |
+ arvados.collection.Subcollection --- The new contents at `name`
within `collection`.
"""
if self._callback:
@@ -1231,17 +1236,17 @@ class Collection(RichCollectionBase):
Arguments:
- * other: Collection | None --- The collection whose contents should be
- merged into this instance. When not provided, this method reloads this
- collection's API record and constructs a Collection object from it.
- If this instance does not have a corresponding API record, this method
- raises `arvados.errors.ArgumentError`.
+ * other: arvados.collection.Collection | None --- The collection
+ whose contents should be merged into this instance. When not
+ provided, this method reloads this collection's API record and
+ constructs a Collection object from it. If this instance does not
+ have a corresponding API record, this method raises
+ `arvados.errors.ArgumentError`.
* num_retries: int | None --- The number of times to retry reloading
the collection's API record from the API server. If not specified,
uses the `num_retries` provided when this instance was constructed.
"""
-
if other is None:
if self._manifest_locator is None:
raise errors.ArgumentError("`other` is None but collection does not have a manifest_locator uuid")
@@ -1379,8 +1384,9 @@ class Collection(RichCollectionBase):
Arguments:
- * new_parent: Collection | None --- This value is passed to the new
- Collection's constructor as the `parent` argument.
+ * new_parent: arvados.collection.Collection | None --- This value is
+ passed to the new Collection's constructor as the `parent`
+ argument.
* new_name: str | None --- This value is unused.
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list