shapepipe.modules.module_decorator

shapepipe.modules.module_decorator

MODULE DECORATOR.

This module defines the module runner dectorator.

Author

Samuel Farrens <samuel.farrens@cea.fr>

module_runner(version='0.0', input_module=None, file_pattern='', file_ext='', depends=[], executes=[], numbering_scheme=None, run_method='parallel')[source]

Wrap Module Runners.

This method adds properties to module runners.

Parameters

  • version (str, optional) – Module version string, default is 0.0

  • input_module (str or list, optional) – Input module name, default is None

  • file_pattern (str or list, optional) – File pattern, default is ''

  • file_ext (str or list, optional) – File extension, default is ''

  • depends (str or list, optional) – Module dependencies, default is []

  • executes (str or list, optional) – Module executables, default is []

  • numbering_scheme (str, optional) – Module numbering scheme, default is None

  • run_method ({'parallel', 'serial'}, optional) – Module run method, default is 'parallel'

Raises

  • TypeError – If version is not a string

  • TypeError – If input_module is not a list or a string

  • TypeError – If file_pattern is not a list or a string

  • TypeError – If file_ext is not a list or a string

  • TypeError – If depends is not a list or a string

  • TypeError – If executes is not a list or a string

  • TypeError – If numbering_scheme is not a string

  • ValueError – If run_method is not valid

  • ValueError – If length of file_pattern and file_ext lists do not match

previous

shapepipe.modules.vignetmaker_package.vignetmaker

next

shapepipe.modules.module_runners