httk.core.datastream.textstream_filename

Classes

TextstreamFilename

Backend for streaming text via operations on a file specfied by a filename

Module Contents

class httk.core.datastream.textstream_filename.TextstreamFilename(filename, **hints)

Bases: httk.core.datastream.textstream_common.TextstreamCommon, httk.core.datastream.textstream_backend.TextstreamBackend

Backend for streaming text via operations on a file specfied by a filename Compressed content is transparently decompressed before text decoding.

Parameters:

  • filename (str | pathlib.Path) – File path to open lazily for text reading.

  • **hints (Any) – Backend-selection, encoding, and compression hints.

Raises:

ValueError – If the compression hint is unknown.

property name: str | None

Return the configured filename.

property closed: bool

Report whether the filename backend is closed.