Python SDKPythonPythonAistoreSdkObjContent Iterator

aistore.sdk.obj.content_iterator.base

View as Markdown

Module Contents

Classes

NameDescription
BaseContentIterProviderAbstract base class for content iterator providers.

API

class aistore.sdk.obj.content_iterator.base.BaseContentIterProvider(
    client: aistore.sdk.obj.object_client.ObjectClient,
    chunk_size: int
)
Abstract

Abstract base class for content iterator providers.

Parameters:

client
ObjectClient

Client for accessing contents of an individual object.

chunk_size
int

Size of each chunk of data yielded.

_expected_end_position
Optional[int] = None
client
ObjectClient

Get the client associated with this content iterator.

expected_end_position
Optional[int]

Expected logical byte position at EOF, if known from response metadata.

aistore.sdk.obj.content_iterator.base.BaseContentIterProvider.create_iter(
    offset: int = 0
) -> typing.Generator[bytes, None, None]
abstract

Create an iterator over the object content.

Parameters:

offset
intDefaults to 0

The offset in bytes to apply. Defaults to 0.

aistore.sdk.obj.content_iterator.base.BaseContentIterProvider.read_all() -> typing.Union[bytes, aistore.sdk.obj.content_iterator.buffer.ParallelBuffer]
abstract

Read all object content into memory and return it.