For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
OverviewCodaControlAPI ReferenceChangelog
OverviewCodaControlAPI ReferenceChangelog
  • Coda API
  • Control API
  • Stanza API
    • stanza
    • cli
    • context
    • device
    • exceptions
      • logger
      • data_logger
      • datatypes
      • session
        • writers
        • base
        • bokeh_writer
        • hdf5_writer
        • jsonl_writer
    • models
    • pyvisa
    • registry
    • timing
    • utils
LogoLogo
On this page
  • Module Contents
  • Classes
  • API
Stanza APIloggerwriters

stanza.logger.writers.base

Was this page helpful?
Built with

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