Generic steps¶

PipelineStep¶

class DebugStep(state=False, context=False, err=False)[source]¶

Debug step.

Print parts of or the entire current state and or context.

class NotifyStep(template=None, template_error=None)[source]¶

Send a notification.

Parameters:	template (str) – A format string that receives the context for building the success notification message. template_error (str) – A format string that receives the context for building the error notification message.

Sends a notification about the successful import or export.

Arguments:

This step takes no arguments.

Added context:

class ProgressStep(step_size=5)[source]¶

Progress step.

Shows a progressbar when stderr is a terminal, or the progress in percent when stderr is a file.

Parameters:	step_size (int) – Step size in percent (defaults to 5).

Shows a progressbar when stderr is a terminal, or the progress in percent when stderr is a file.

Arguments:

Added context:

This step adds no context.

class FlattenStep(depth=-1)[source]¶

Convert nested dicts to flat dicts.

Parameters:	depth (int) – Number of nested levels to flatten. Set to -1 for infinite depth.

Examples:

Input:

{
  'fields': {
    'name': {
      'de': 'Deutsch',
      'en': 'English',
    },
  },
}

Output:

{
  'fields.name.de': 'Deutsch',
  'fields.name.en': 'English',
}

class ExpandStep(depth=-1)[source]¶

Convert flattened dicts into nested dicts.

Parameters:	depth (int) – Number of levels to expand. Set to -1 for infinite depth.

Examples:

Input:

{
  'fields.name.de': 'Deutsch',
  'fields.name.en': 'English',
}

Output:

{
  'fields': {
    'name': {
      'de': 'Deutsch',
      'en': 'English',
    },
  },
}

class RebuildIndexStep(model, raw=False)[source]¶

RebuildIndex step.

Rebuilds the Elasticsearch index for a given model.

Parameters:	model (str\|type) – Model class name or concrete class. raw (bool) – Use raw method to index data. Please use with caution, model links are not indexed!