session | Conductor Quantum

Module Contents

Classes

Name	Description
`LoggerSession`	Session for the logger.

Data

logger

API

1 stanza.logger.session.logger

Value: getLogger(...)

1 class stanza.logger.session.LoggerSession(metadata: stanza.logger.datatypes.SessionMetadata, writer_pool: dict[str, stanza.logger.writers.base.AbstractDataWriter], writer_refs: list[str], base_dir: str | pathlib.Path, buffer_size: int, auto_flush_interval: float | None = 30.0)

Session for the logger.

1 session_id: str

1 routine_name: str

1 _check_buffer_size_warning() -> None

Check if buffer has grown too large and log warning once.

1 initialize() -> None

Initialize the session.

Raises:

LoggerSessionError: If session is already initialized

1 finalize() -> None

Finalize the session.

1 log_measurement(
2     name: str,
3     data: dict[str, typing.Any],
4     metadata: dict[str, typing.Any] | None = None,
5     routine_name: str | None = None
6 ) -> None

Log measurement data to a session.

1 log_analysis(
2     name: str,
3     data: dict[str, typing.Any],
4     metadata: dict[str, typing.Any] | None = None,
5     routine_name: str | None = None
6 ) -> None

Log analysis data to a session.

1 log_sweep(
2     name: str,
3     x_data: list[float] | list[list[float]] | numpy.ndarray,
4     y_data: list[float] | numpy.ndarray,
5     x_label: str,
6     y_label: str,
7     metadata: dict[str, typing.Any] | None = None
8 ) -> None

Log sweep data to a session.

1 log_parameters(parameters: dict[str, typing.Any]) -> None

Log parameters to a session.

1 flush() -> None

Flush buffered data to all writers.

Raises:

LoggerSessionError: If any writer fails to write or flush data

1 __enter__() -> stanza.logger.session.LoggerSession

Enter the session context.

1 __exit__(
2     exc_type: type[BaseException] | None,
3     exc_value: BaseException | None,
4     traceback: typing.Any
5 ) -> None

Exit the session context.

1 __repr__() -> str