quantlab.acquisition.refresh.RawTierRefresh#
- class quantlab.acquisition.refresh.RawTierRefresh(*args, **kwargs)[source]#
Bases:
ProtocolKeep a vendor’s raw tier current from its watermarks up to
end.- Parameters:
- download_dirstr or Path
The download root; the vendor’s raw tier sits under it.
- enddate or None, default None
The last day to pull;
Noneis the vendor’s today.- **options
The vendor’s own settings (Sharadar’s
trading_days, Massive’sendpoints, FRED’sseriesandstart).
- Returns:
- RawTierRefreshResult
Every part tried. A part the vendor or the transport failed is listed with its error and the other parts still run (see the module docstring for which errors count).
- Raises:
- Exception
The vendor’s credential error, before any part is asked for, when a credential is missing; any error that is not the vendor failing a part (a bug of ours), from the part it happened on.
Examples
Any function of this shape serves; the registry calls it:
def refresh(download_dir, *, end=None, **options): return RawTierRefreshResult("example", ())