ConsoleWriter Class

Wrapper for file objects to ensure flushing.

Construct a ConsoleWriter.

Constructor

ConsoleWriter(f: TextIO | None = None, show_output: bool = True)

Name	Description
f	the underlying file stream Default value: None
show_output	Default value: True

flush	Flush the underlying file.
print	Write to the underlying file. The file is flushed.
print_run_info	Print the run id and a link to azure portal. For ipython contexts, format it via html.
println	Write to the underlying file. A newline character is also written and the file is flushed. If the text provided is None, just a new line character will be written.
write	Write directly to the underlying file.

Flush the underlying file.

flush() -> None

Write to the underlying file. The file is flushed.

print(text: str, carriage_return: bool = False) -> None

Name	Description
text Required	the text to write
carriage_return	Add the carriage return. Default value: False

Print the run id and a link to azure portal. For ipython contexts, format it via html.

print_run_info(run: Run) -> None

Name	Description
run Required	The run to print.

Type	Description
	None

Write to the underlying file. A newline character is also written and the file is flushed.

If the text provided is None, just a new line character will be written.

println(text: str | None = None) -> None

Name	Description
text	the text to write Default value: None

Write directly to the underlying file.

write(text: str) -> None

Name	Description
text Required	the text to write