bayesline.api.equity.UploadParserApi.parse

abstract UploadParserApi.parse(raw_df: DataFrame, *, name: str | None = None) → tuple[DataFrame, UploadParserResult]

Parameters

raw_df: pl.DataFrame

The dataframe to parse.

name: str | None, optional

The name of the dataframe (which could be the filename). Some parsers might extract information (such as a date) from the name.

Returns

tuple[pl.DataFrame, UploadParserResult]:

A tuple of the parsed pl.DataFrame and a UploadParserResult. If the parser was unsuccessful the parsed dataframe will instead be a (possibly empty) error dataframe.