stanza.logger.session

Module Contents

Classes

NameDescription
LoggerSessionSession for the logger.

Data

logger

API

1stanza.logger.session.logger

Value: getLogger(...)

1class 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 = 1000)

Session for the logger.

1session_id: str
1routine_name: str
1initialize() -> None

Initialize the session.

Raises:

LoggerSessionError: If session is already initialized

1finalize() -> None

Finalize the session.

1log_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.

1log_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.

1log_sweep(
2 name: str,
3 x_data: 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.

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

Log parameters to a session.

1flush() -> None

Flush buffered data to all writers.

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