quantlab.utils.resample.validate_resample_config#

quantlab.utils.resample.validate_resample_config(freq, how, owner)[source]#

Check a config’s resample_freq and resample_how pair.

Parameters:
freqstr or None

The resample_freq field.

howdict[str, str] or str or None

The resample_how field.

ownerstr

Class name quoted in error messages.

Raises:
ValueError

If freq is not a ResampleFrequency token, if how is set without freq or freq without how, or if any method is not a ResampleMethod token.

Examples

>>> validate_resample_config("1d", {"close": "last"}, "StockDataset")
>>> validate_resample_config("1d", None, "StockDataset")
Traceback (most recent call last):
ValueError: StockDataset: resample_freq='1d' needs resample_how ...