polaris.run.events.EventStream

class polaris.run.events.EventStream(path: str | None = None)[source]

Somewhere to write what the scheduler decided.

Variables:

path (str or None) – The file being written, or None where nothing is recorded.

__init__(path: str | None = None)[source]
Parameters:

path (str, optional) – The file to append records to. A stream with no path discards them, which is what a test or a dry run wants.

Methods

__init__([path])

close()

Stop writing.

record(event, **fields)

Write one record.