Extractor

A type of Callable that performs data extraction.

Definition

Constructor

class controller.callable.extractor.Extractor(self, id: str, params: CallableParameters)

An abstract subclass of Callable where its implementations are Callables that perform data extraction.

Parameters:

id (str) – The unique identifier of this Callable. Also referred to as callable_id in documentations for specific Callables.
params (CallableParameters) – The parameters of this Callable. Refer to the documentation for a specific Callable for details.

Methods

abstract controller.callable.Callable.check_params(self, params: CallableParameters) → boolean: See Callable.

abstract controller.callable.Callable.exec(self, data: pd.DataFrame, **kwargs) → pd.DataFrame: See Callable.

Usage

A concrete implementation of a Callable may inherit this class and override its check_params() and exec() methods.

Output conventions

Refer to Callable for conventions on all Callable outputs.

There are no further restrictions on the column names of a Extractor’s output DataFrame.