stanza.logger.writers.base

Module Contents

Classes

NameDescription
AbstractDataWriterAbstract base class for data writers.

API

1class stanza.logger.writers.base.AbstractDataWriter

Bases: abc.ABC

Abstract base class for data writers.

1initialize_session(session: stanza.logger.datatypes.SessionMetadata) -> None

Initialize the writer for a new session.

Parameters:

session
stanza.logger.datatypes.SessionMetadata

Session metadata containing routine info

Raises:

WriterError: If initialization fails

1write_measurement(data: stanza.logger.datatypes.MeasurementData) -> None

Write a single measurement data point.

Parameters:

data
stanza.logger.datatypes.MeasurementData

Measurement data to write

Raises:

WriterError: If write operation fails

1write_sweep(data: stanza.logger.datatypes.SweepData) -> None

Write a sweep of measurement data.

Parameters:

data
stanza.logger.datatypes.SweepData

Sweep data to write

Raises:

WriterError: If write operation fails

1finalize_session(session: stanza.logger.datatypes.SessionMetadata | None = None) -> None

Finalize the writer for a session.

Parameters:

session
stanza.logger.datatypes.SessionMetadata | None

Optional updated session metadata to write before finalizing

Raises:

WriterError: If finalization fails

1flush() -> None

Flush the writer to ensure data is written to storage.

Raises:

WriterError: If flush operation fails