DestinationPlugin

classView source ↗

class DestinationPlugin(*args, **kwargs)

Bases: ABC

Categories: plugin

Abstract class for output plugins.

Methods: trigger_output(working_dir, *args, **kwargs) Trigger the exporting of the data. This function will receive the resulting data from the dataset function and must store it in the desired location.

Methods

method

View source ↗

to_dict

def to_dict() -> dict

Return a dictionary representation of the object. This is used to save the object in a file.

Returns:

dict: A dictionary with the object's attributes.

method

View source ↗

trigger_output

def trigger_output(working_dir: str, *args, **kwargs)

Trigger the exporting of the data. This function will receive the resulting data from the dataset function and must store it in the desired location.

Parameters:

parameter

working_dirstr

The folder where any intermediate files generated must be stored (this refers to temporary files that will be deleted after the execution of the plugin, not the final destination of the data)

parameter

*args

The data to be exported

parameter

**kwargs

Additional parameters to be used in the export

Returns:

None