aboutsummaryrefslogtreecommitdiff
path: root/crosperf/field.py
blob: 6b5ea1106b21b4bfac8097194230a08863b81872 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# -*- coding: utf-8 -*-
# Copyright 2011 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Module to represent a Field in an experiment file."""


class Field(object):
    """Class representing a Field in an experiment file."""

    def __init__(self, name, required, default, inheritable, description):
        self.name = name
        self.required = required
        self.assigned = False
        self.default = default
        self._value = default
        self.inheritable = inheritable
        self.description = description

    def Set(self, value, parse=True):
        if parse:
            self._value = self._Parse(value)
        else:
            self._value = value
        self.assigned = True

    def Append(self, value):
        self._value += self._Parse(value)
        self.assigned = True

    def _Parse(self, value):
        return value

    def Get(self):
        return self._value

    def GetString(self):
        return str(self._value)


class TextField(Field):
    """Class of text field."""

    def __init__(
        self,
        name,
        required=False,
        default="",
        inheritable=False,
        description="",
    ):
        super(TextField, self).__init__(
            name, required, default, inheritable, description
        )

    def _Parse(self, value):
        return str(value)


class BooleanField(Field):
    """Class of boolean field."""

    def __init__(
        self,
        name,
        required=False,
        default=False,
        inheritable=False,
        description="",
    ):
        super(BooleanField, self).__init__(
            name, required, default, inheritable, description
        )

    def _Parse(self, value):
        if value.lower() == "true":
            return True
        elif value.lower() == "false":
            return False
        raise TypeError(
            "Invalid value for '%s'. Must be true or false." % self.name
        )


class IntegerField(Field):
    """Class of integer field."""

    def __init__(
        self, name, required=False, default=0, inheritable=False, description=""
    ):
        super(IntegerField, self).__init__(
            name, required, default, inheritable, description
        )

    def _Parse(self, value):
        return int(value)


class FloatField(Field):
    """Class of float field."""

    def __init__(
        self, name, required=False, default=0, inheritable=False, description=""
    ):
        super(FloatField, self).__init__(
            name, required, default, inheritable, description
        )

    def _Parse(self, value):
        return float(value)


class ListField(Field):
    """Class of list field."""

    def __init__(
        self,
        name,
        required=False,
        default=None,
        inheritable=False,
        description="",
    ):
        super(ListField, self).__init__(
            name, required, default, inheritable, description
        )

    def _Parse(self, value):
        return value.split()

    def GetString(self):
        return " ".join(self._value)

    def Append(self, value):
        v = self._Parse(value)
        if not self._value:
            self._value = v
        else:
            self._value += v
        self.assigned = True


class EnumField(Field):
    """Class of enum field."""

    def __init__(
        self,
        name,
        options,
        required=False,
        default="",
        inheritable=False,
        description="",
    ):
        super(EnumField, self).__init__(
            name, required, default, inheritable, description
        )
        self.options = options

    def _Parse(self, value):
        if value not in self.options:
            raise TypeError(
                "Invalid enum value for field '%s'. Must be one of (%s)"
                % (self.name, ", ".join(self.options))
            )
        return str(value)