quantlab.utils.cli.print_conversion_result#

quantlab.utils.cli.print_conversion_result(result, *, print_fn=<built-in function print>)[source]#

Print the ConversionResult returned by quantlab.acquisition.registry.convert.

Every line comes off the returned object, not the config and not a read-back of the store, so the printed path is the one actually written and windows_skipped / resumed describe this run rather than whatever the chunk ledger (the resume record of written windows) holds. Only paths, integer counts and booleans are printed. The argument is left unannotated so this module does not import the result class.

Parameters:

resultConversionResult: The conversion result to render.
print_fncallable, default print: Output function, injectable for tests.

Returns:

ConversionResult: result, unchanged, so a call site can compose.

Examples

With result a ConversionResult whose run wrote five yearly windows:

>>> _ = print_conversion_result(result)
Zarr store written at: /mnt/quant/data/us_equity/1d/stock.zarr
  windows:           5 written, 0 skipped of 5 planned (year)
  symbols pinned:    2
  rows appended:     2,516
  peak window:       0.00 GiB
  chunk ledger:      /mnt/quant/data/us_equity/1d/stock.zarr.chunks.json