parameterize_jobs package

Submodules

parameterize_jobs.parameterize_jobs module

class parameterize_jobs.parameterize_jobs.Component(values)[source]

Bases: object

class parameterize_jobs.parameterize_jobs.ComponentSet(**kwargs)[source]

Bases: object

Indexable combinatorial product job specification

class parameterize_jobs.parameterize_jobs.Constant(**kwargs)[source]

Bases: ComponentSet

A ComponentSet where each iterable has only one element

class parameterize_jobs.parameterize_jobs.MultiComponentSet(components)[source]

Bases: object

A list of multiple ComponentSet objects

class parameterize_jobs.parameterize_jobs.ParallelComponentSet(**kwargs)[source]

Bases: MultiComponentSet

A MultiComponentSet object created by multiple lists of the same length, where each job will take the nth element of each list

parameterize_jobs.parameterize_jobs.expand_kwargs(func)[source]

Decorator to expand an kwargs in function calls

Parameters:

func (function) – Function to have arguments expanded. Func can have any number of keyword arguments.

Returns:

wrapped – Wrapped version of func which accepts a single kwargs dict.

Return type:

function

Examples

>>> @expand_kwargs
... def my_func(a, b, exp=1):
...     return (a * b)**exp
...
>>> my_func({'a': 2, 'b': 3})
6
>>> my_func({'a': 2, 'b': 3, 'exp': 2})
36

Module contents

Top-level package for Parameterize Jobs.

class parameterize_jobs.Component(values)[source]

Bases: object

class parameterize_jobs.ComponentSet(**kwargs)[source]

Bases: object

Indexable combinatorial product job specification

class parameterize_jobs.Constant(**kwargs)[source]

Bases: ComponentSet

A ComponentSet where each iterable has only one element

class parameterize_jobs.MultiComponentSet(components)[source]

Bases: object

A list of multiple ComponentSet objects

class parameterize_jobs.ParallelComponentSet(**kwargs)[source]

Bases: MultiComponentSet

A MultiComponentSet object created by multiple lists of the same length, where each job will take the nth element of each list

parameterize_jobs.expand_kwargs(func)[source]

Decorator to expand an kwargs in function calls

Parameters:

func (function) – Function to have arguments expanded. Func can have any number of keyword arguments.

Returns:

wrapped – Wrapped version of func which accepts a single kwargs dict.

Return type:

function

Examples

>>> @expand_kwargs
... def my_func(a, b, exp=1):
...     return (a * b)**exp
...
>>> my_func({'a': 2, 'b': 3})
6
>>> my_func({'a': 2, 'b': 3, 'exp': 2})
36