quantlab.dataset.sharadar.stores.StoreResult#

class quantlab.dataset.sharadar.stores.StoreResult(path, state, conversion=None, error=None, start=None, corrections=None, kept=None, removed=(), added=())[source]#

Bases: object

What build_stores or update_stores did to one store.

Attributes:

pathPath: The store.
stateStoreState: What happened to it.
conversionConversionResult or None, default None: The last conversion run on it; None when it failed before one.
errorstr or None, default None: For a failed store, its error (a traceback for an unexpected one).
startstr or None, default None: For a built or rebuilt store, the first day it was built from.
correctionsPath or None, default None: The vendor corrections a price store reported, when there are any.
keptPath or None, default None: For a rebuilt store, where its old store and ledger were kept.
removed, addedtuple, default (): For a rebuilt store, the symbols the rebuild removed and added.

Examples

>>> StoreResult(Path("/data/sharadar_sep_1d.zarr"), StoreState.FAILED, error="boom").summary
'sharadar_sep_1d.zarr: failed: boom'

property name#: The store’s file name, <name>.zarr.

property summary#

One line saying what happened to the store.

Examples

>>> StoreResult(Path("/data/x.zarr"), StoreState.BUILT, start="2024-01-02").summary
'x.zarr: built from 2024-01-02'