pacman.executor.algorithm_decorators package

Submodules

pacman.executor.algorithm_decorators.abstract_input module

class pacman.executor.algorithm_decorators.abstract_input.AbstractInput

Bases: object

An abstract input to an algorithm

get_inputs_by_name(inputs)

Get the inputs that match this input by parameter name

Parameters:inputs – A dict of type to value Returns:A dict of parameter name to value Return type:dict

input_matches(inputs)

Determine if this input is in the set of inputs

Parameters:inputs – A set of input types Returns:True if this input type is in the list

name

The name of the input

param_types

The types of the input

pacman.executor.algorithm_decorators.algorithm_decorator module

pacman.executor.algorithm_decorators.all_of_input module

class pacman.executor.algorithm_decorators.all_of_input.AllOfInput(inputs)

Bases: pacman.executor.algorithm_decorators.abstract_input.AbstractInput

A composite input for which all input parameters must be matched

Parameters:inputs – The inputs that make up this input

get_inputs_by_name(inputs)

Get the inputs that match this input by parameter name

Parameters:inputs – A dict of type to value Returns:A dict of parameter name to value Return type:dict

input_matches(inputs)

Determine if this input is in the set of inputs

Parameters:inputs – A set of input types Returns:True if this input type is in the list

name

The name of the input

param_types

The types of the input

pacman.executor.algorithm_decorators.one_of_input module

class pacman.executor.algorithm_decorators.one_of_input.OneOfInput(inputs)

Bases: pacman.executor.algorithm_decorators.abstract_input.AbstractInput

An input for which one of the input parameters must be matched

Parameters:inputs – The inputs that make up this input

get_inputs_by_name(inputs)

Get the inputs that match this input by parameter name

Parameters:inputs – A dict of type to value Returns:A dict of parameter name to value Return type:dict

input_matches(inputs)

Determine if this input is in the set of inputs

Parameters:inputs – A set of input types Returns:True if this input type is in the list

name

The name of the input

param_types

The types of the input

pacman.executor.algorithm_decorators.output module

class pacman.executor.algorithm_decorators.output.Output(output_type, file_name_type=None)

Bases: object

Represents an output from an algorithm

Parameters:

• output_type – The type of the output
• file_name_type – If the output is file based, the type of the input holding the file name

file_name_type

output_type

pacman.executor.algorithm_decorators.single_input module

class pacman.executor.algorithm_decorators.single_input.SingleInput(name, param_types)

Bases: pacman.executor.algorithm_decorators.abstract_input.AbstractInput

An input that is just one item

Parameters:

• name (str) – The name of the input parameter
• param_types (list of str) – The ordered possible types of the input parameter

get_inputs_by_name(inputs)

Get the inputs that match this input by parameter name

Parameters:inputs – A dict of type to value Returns:A dict of parameter name to value Return type:dict

input_matches(inputs)

Determine if this input is in the set of inputs

Parameters:inputs – A set of input types Returns:True if this input type is in the list

name

The name of the input

param_types

The types of the input

Module contents