stanza.logger.writers.jsonl_writer

Module Contents

Classes

Data

logger

API

1
stanza.logger.writers.jsonl_writer.logger

Value: getLogger(...)

1
class stanza.logger.writers.jsonl_writer.JSONLEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.JSONEncoder

Encoder for JSONL files.

Initialization

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (’, ’, ’: ’) if indent is None and (’,’, ’: ’) otherwise. To get the most compact JSON representation, you should specify (’,’, ’:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

1
default(obj: typing.Any) -> typing.Any

1
class stanza.logger.writers.jsonl_writer.JSONLWriter(base_directory: str | pathlib.Path, compression: str | None = None, compression_level: int = 6)

Bases: stanza.logger.writers.base.AbstractDataWriter

Writer for JSONL files.

1
_get_file_extension(base_name: str) -> str

Get file extension with optional compression suffix.

1
_open_file(
2
    file_path: pathlib.Path, mode: str = 'w'
3
) -> typing.IO[str]

Open a file with optional compression.

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

Initialize a new session and create session directory.

Parameters:

Raises:

WriterError: If session is already initialized or file creation fails

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

Finalize the writer for a session.

Parameters:

Raises:

WriterError: If no active session or finalization fails

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

Write a single measurement data point.

Parameters:

Raises:

WriterError: If no active session or write operation fails

1
_write_measurement(measurement: stanza.logger.datatypes.MeasurementData) -> None

Write a single measurement data point in structured format.

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

Write a sweep of measurement data.

Parameters:

Raises:

WriterError: If no active session or write operation fails

1
_write_sweep(sweep: stanza.logger.datatypes.SweepData) -> None

Write a sweep of measurement data in structured format.

1
flush() -> None

Flush the writer to ensure data is written to storage.