openstack/swift
Code Issues Proposed changes

Fix stale docstring in SegmentedIterable.

Browse Source 
At some point, we added stuff to listing_iter, but didn't update the
docstring. I noticed this while trying to write code using a
SegmentedIterable when it wouldn't take my 3-tuples like the docstring
claimed it would.

Change-Id: I8f6667e97b1277f5b403a5f6fa7f9d708bb19249
This commit is contained in:
Samuel Merritt 2016-08-03 16:46:48 -07:00
parent d819ae00a5
commit 425bb0d8b0
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
swift/common/request_helpers.py
View File

@ -304,10 +304,18 @@ class SegmentedIterable(object):
:param req: original request object
:param app: WSGI application from which segments will come
:param listing_iter: iterable yielding the object segments to fetch,
along with the byte subranges to fetch, in the
form of a tuple (object-path, first-byte, last-byte)
or (object-path, None, None) to fetch the whole thing.
along with the byte subranges to fetch, in the form of a 5-tuple
(object-path, object-etag, object-size, first-byte, last-byte).
If object-etag is None, no MD5 verification will be done.
If object-size is None, no length verification will be done.
If first-byte and last-byte are None, then the entire object will be
fetched.
:param max_get_time: maximum permitted duration of a GET request (seconds)
:param logger: logger object
:param swift_source: value of swift.source in subrequest environ