b2sdk.stream.chained ChainedStream

class b2sdk.stream.chained.ChainedStream(stream_openers)

Bases: b2sdk.stream.base.ReadOnlyStreamMixin, io.IOBase

Chains multiple streams in single stream, sort of what itertools.chain does for iterators.

Cleans up buffers of underlying streams when closed.

Can be seeked to beginning (when retrying upload, for example). Closes underlying streams as soon as they reaches EOF, but clears their buffers when the chained stream is closed for underlying streams that follow b2sdk.v1.StreamOpener cleanup interface, for example b2sdk.v1.CachedBytesStreamOpener

__init__(stream_openers)

Parameters

stream_openeres (list) – list of callables that return opened streams

property stream

Return currently processed stream.

seekable()

Return whether object supports random access.

If False, seek(), tell() and truncate() will raise OSError. This method may need to do a test seek().

tell()

Return current stream position.

seek(pos, whence=0)

Resets stream to the beginning.

Parameters

• pos (int) – only allowed value is 0

• whence (int) – only allowed value is 0

readable()

Return whether object was opened for reading.

If False, read() will raise OSError.

read(size=None)

Read at most size bytes from underlying streams, or all available data, if size is None or negative. Open the streams only when their data is needed, and possibly leave them open and part-way read for further reading - by subsequent calls to this method.

Parameters

size (int,None) – number of bytes to read. If omitted, None, or negative data is read and returned until EOF from final stream is reached

Returns

data read from the stream

close()

Flush and close the IO object.

This method has no effect if the file is already closed.

class b2sdk.stream.chained.StreamOpener

Bases: object

Abstract class to define stream opener with cleanup.

cleanup()

Clean up stream opener after chained stream closes.

Can be used for cleaning cached data that are stored in memory to allow resetting chained stream without getting this data more than once, eg. data downloaded from external source.