seaflow.hooks package

Submodules

seaflow.hooks.hook module

Module Introduction

This is a hook mount management class, with the main function of managing the mount hook functions and the main technical static methods.

  • Design mode:

    nothing

  • Key points:

    1. Hook technology

  • Main functions:

    1. Plug-in Manager

Usage examples

Class description

class seaflow.hooks.hook.HookManager

Bases: object

Class Introduction:

This is a hook mount management class, with the main function of managing the mount hook functions and the main technical static methods.

Attribute Function:

Define an attribute function initialization method.

Parameters:

  • hook_manager_instance (object) - Hook Mount Management Object Instance.

create_hook_manager()

Method Function:

Define a method for creating a mount manager.

Returns:

  • hook_manager (object) - hook manager object.

get_hook_manager_instance()

Method Function:

Define a method for obtaining mount manager instances

Returns:

  • hook_manager (object) - The hook manager object that has been matched with the relevant plugin object.

register_plugins(hook_manager)

Method Function:

Define a method for registering plugin objects.

Parameters:

  • hook_manager (object) - hook manager object.

Returns:

  • hook_manager (object) - The hook manager object for which the plugin object has been registered.

class seaflow.hooks.hook.LocalDataCatalogPlugin

Bases: object

Class Introduction:

This is a local data directory plugin class, mainly used for data caching, saving, and loading operations.

collect_parameter_data_before_node_run_locally(catalog, inputs)

Method Function:

Define a method for collecting parameters before running.

Parameters:

  • catalog (object) - Data directory object.

  • inputs (list) - List of input parameters.

Returns:

  • data_dict (dict) - Data dictionary.

store_cache_data_after_node_run_locally(catalog, outputs, data_objects)

Method function:

Define a method for saving cached data after running.

Parameters:

  • catalog (object) - Data directory object.

  • outputs (list) - Output parameter list.

  • data_objects (list) - List of data objects.

Returns:

  • result (str) - Run result information.

class seaflow.hooks.hook.LocalDatacatalogSpecs

Bases: object

Class Introduction:

This is a local data directory interface class.

collect_parameter_data_before_node_run_locally(catalog, inputs)

Method Function:

Define a method for collecting parameters before running.

Parameters:

  • catalog (object) - Data directory object.

  • inputs (list) - List of input parameters.

Returns:

  • data_dict (dict) - Data dictionary.

store_cache_data_after_node_run_locally(catalog, outputs, data_objects)

Method function:

Define a method for saving cached data after running.

Parameters:

  • catalog (object) - Data directory object.

  • outputs (list) - Output parameter list.

  • data_objects (list) - List of data objects.

Returns:

  • result (str) - Run result information.

Module contents