aiflows.interfaces package

Submodules

aiflows.interfaces.abstract module

class aiflows.interfaces.abstract.Interface

Bases: ABC

This class is the base class for all interfaces.

aiflows.interfaces.key_interface module

class aiflows.interfaces.key_interface.KeyInterface(keys_to_rename: Dict[str, str] = {}, keys_to_copy: Dict[str, str] = {}, keys_to_set: Dict[str, Any] = {}, additional_transformations: List = [], keys_to_select: List[str] = [], keys_to_delete: List[str] = [])

Bases: ABC

This class is the base class for all key interfaces. It applies a list of transformations to a data dictionary.

Parameters:

  • keys_to_rename (Dict[str, str], optional) – A dictionary mapping old keys to new keys (used to instantiate the transformation defined in the KeyRename class)

  • keys_to_copy (Dict[str, str], optional) – A dictionary mapping old keys to new keys (used to instantiate the transformation defined in the KeyCopy class)

  • keys_to_set (Dict[str, str], optional) – A dictionary mapping keys to values (used to instantiate the transformation defined in the KeySet class)

  • additional_transformations (List, optional) – A list of additional transformations to apply to the data dictionary

  • keys_to_select (List[str], optional) – A list of keys to select (used to instantiate the transformation defined in the KeySelect class)

  • keys_to_delete (List[str], optional) – A list of keys to delete (used to instantiate the transformation defined in the KeyDelete class)

Module contents