bayesline.api.equity.AsyncUploaderApi.validate_staging_data

abstract async AsyncUploaderApi.validate_staging_data(names: list[str] | None = None, short: bool = False) → dict[str, DataFrame]

Validates the staging data for the optional list of names and returns a dict of error dataframes keyed by the name of the validation test.

Parameters

names: list[str] | None, optional

The names for which to carry out the validation. If None will use all staging data. Names that do not exist will be ignored.

short: bool, optional

If True will return a shorter dataframes which only contain a column _name to indicate the name of the staging file which has validation errors with other staging files. If False will return a dataframe with the _name (as above) and other columns to indicate the validation errors.

Returns

dict[str, pl.DataFrame]

Error dataframes for different validation checks. The dataframes will contain a column _name. If short is False then the _name column contains a comma separated list of staging names that are the cause of the respective validation error. If short is True then the _name column will be the only column and each row contains a staging file name that has validation errors.