From: Tom Clegg <tom@curoverse.com>
Date: Wed, 4 Feb 2015 18:56:33 +0000 (-0500)
Subject: 5011: Sync local_store_put/get() signatures to put/get(). Add docstrings.
X-Git-Tag: 1.1.0~1837^2~9
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/3d0c0753efb6e2b610d23d16038db218b491a70f?ds=sidebyside

5011: Sync local_store_put/get() signatures to put/get(). Add docstrings.
---

diff --git a/sdk/python/arvados/keep.py b/sdk/python/arvados/keep.py
index 4698789757..8a275745eb 100644
--- a/sdk/python/arvados/keep.py
+++ b/sdk/python/arvados/keep.py
@@ -736,10 +736,16 @@ class KeepClient(object):
                 "failed to write {} (wanted {} copies but wrote {})".format(
                     data_hash, copies, thread_limiter.done()), service_errors)
 
-    # Local storage methods need no-op num_retries arguments to keep
-    # integration tests happy.  With better isolation they could
-    # probably be removed again.
-    def local_store_put(self, data, num_retries=0, copies=1):
+    def local_store_put(self, data, copies=1, num_retries=None):
+        """A stub for put(), for use in test cases.
+
+        copies and num_retries arguments are ignored: they are here
+        only for the sake of offering the same call signature as
+        put().
+
+        Data stored this way can be retrieved via local_store_get().
+
+        """
         md5 = hashlib.md5(data).hexdigest()
         locator = '%s+%d' % (md5, len(data))
         with open(os.path.join(self.local_store, md5 + '.tmp'), 'w') as f:
@@ -748,7 +754,9 @@ class KeepClient(object):
                   os.path.join(self.local_store, md5))
         return locator
 
-    def local_store_get(self, loc_s, num_retries=0, copies=1):
+    def local_store_get(self, loc_s, num_retries=None):
+        """Companion to local_store_put(), for use in test cases.
+        """
         try:
             locator = KeepLocator(loc_s)
         except ValueError: