bayesline.api.equity.AsyncUploaderApi.stage_file

abstract async AsyncUploaderApi.stage_file(path: Path, name: str | None = None, parser: str | None = None, replace: bool = False) → UploadStagingResult

Stages the dataframe from the given file for upload under the given name.

Parameters

path: Path

File path for the file to stage.

name: str, optional

The name of the dataframe to stage. If None will use the file name.

parser: str, optional

The parser to use. If None will check all parsers.

replace: bool, optional

If True will replace a possible existing staging with the same name. If False a name clash will result in a failed staging result.

Raises

UploadError

if the file could not be staged

Returns

UploadStagingResult