summaryrefslogtreecommitdiff
path: root/ricky/params.py
blob: 2b5e6eee473ee4ea18e909cef210e57ebfa9703a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
"""base class for all params"""
import sys
import pprint


class Params(object):
    def __init__(self):
        self._api = None
        self._params = []

    def param(self, name):
        """getter for the param by name"""
        for param in self._params:
            if param.name == name:
                return param
        return None

    def __str__(self):
        """string representation"""
        return pprint.pformat({"params": map(lambda x: vars(x), self._params)})

    def randomize(self):
        """assign random values to all params, taking into account weight"""
        for param in self._params:
            if param.set_by_user:
                continue
            param.randomize()


    @property
    def api(self):
        """property setter for im api"""
        return self._api

    @api.setter
    def api(self, cls):
        """property getter for im api"""
        self._api = cls

    def execute(self):
        """calls the associated api"""
        return self.api.call(self)

    def is_ready(self):
        """test to see if any params with required values are missing"""
        for param in self._params:
            if not param.is_ready and not param.default:
                sys.stderr.write("param not ready: %s\n" % param)
                return 0
        return 1

    def __dict__(self):
        result = {}
        for param in self._params:
            result[param.name] = param.value
        return result

    def as_dict(self):
        """alias for __dict__"""
        return self.__dict__()

    def from_dict(self, params_dict):
        """set param values manually from a dictionary"""
        for param in self._params:
            if param.name in params_dict.keys():
                param.value_set(params_dict[param.name])