neclib.recorders.file_writer

Aliases

TextLike	None
Writer	None
get_logger	Get logger instance which prints operation logs to console.

class FileWriter(*args, **kwargs)

Bases: Writer

start_recording(record_dir)

Parameters:

record_dir (Path) –

Return type:

None

append(path, contents, *args, **kwargs)

Append a chunk of data.

Returns:

Whether the data is handled by this writer.

Return type:

handled

Parameters:

• path (str) –

• contents (TextLike) –

Notes

The subclass should check the input type, as Writer would handle some essentially different data, and Recorder won’t implement the type checking for extensibility.

stop_recording()

Return type:

None