httk.core.datastream.bytestream_api¶

Classes¶

BytestreamAPI

Abstract base class for a bare minimum API for streamable byte data.

Module Contents¶

class httk.core.datastream.bytestream_api.BytestreamAPI¶

Bases: abc.ABC

Abstract base class for a bare minimum API for streamable byte data.

Supports: * read, close, name, and closed with the meanings defined by io.IOBase

Since it is a minimal streaming data API it deliberately omits: seek, tell, etc.; there should be no assumption that the underlying data source is seekable. However, many backend implementations may choose to support them.

abstractmethod read(size=-1)¶

Read up to size bytes, or all remaining bytes when size is negative.

Parameters:: size (int) – Maximum number of bytes to read.
Returns:: The bytes read from the stream.
Return type:: bytes

abstractmethod close()¶

Close the stream.

property name: str | None¶

Abstractmethod:

Expose the source name when one exists.

property closed: bool¶

Abstractmethod:

Report whether the stream is closed.