summaryrefslogtreecommitdiff
path: root/factory/containers.py
blob: 48a4015803cd168465ad4aff11cf3566041c3274 (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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# Copyright (c) 2010 Mark Sandstrom
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

from declarations import OrderedDeclaration, SubFactory


ATTR_SPLITTER = '__'

class ObjectParamsWrapper(object):
    """A generic container that allows for getting but not setting of attributes.

    Attributes are set at initialization time."""

    initialized = False

    def __init__(self, attrs):
        self.attrs = attrs
        self.initialized = True

    def __setattr__(self, name, value):
        if not self.initialized:
            return super(ObjectParamsWrapper, self).__setattr__(name, value)
        else:
            raise AttributeError('Setting of object attributes is not allowed')

    def __getattr__(self, name):
        try:
            return self.attrs[name]
        except KeyError:
            raise AttributeError("The param '{0}' does not exist. Perhaps your declarations are out of order?".format(name))


class OrderedDeclarationDict(object):
    def __init__(self, **kwargs):
        self._order = {}
        self._values = {}
        for k, v in kwargs.iteritems():
            self[k] = v

    def __contains__(self, key):
        return key in self._values

    def __getitem__(self, key):
        return self._values[key]

    def __setitem__(self, key, val):
        if key in self:
            del self[key]
        self._values[key] = val
        self._order[val.order] = key

    def __delitem__(self, key):
        self.pop(key)

    def pop(self, key):
        val = self._values.pop(key)
        del self._order[val.order]
        return val

    def items(self):
        return list(self.iteritems())

    def iteritems(self):
        order = sorted(self._order.keys())
        for i in order:
            key = self._order[i]
            yield (key, self._values[key])

    def __iter__(self):
        order = sorted(self._order.keys())
        for i in order:
            yield self._order[i]

class DeclarationsHolder(object):
    """Holds all declarations, ordered and unordered."""

    def __init__(self, defaults=None):
        if not defaults:
            defaults = {}
        self._ordered = OrderedDeclarationDict()
        self._unordered = {}
        self.update_base(defaults)

    def update_base(self, attrs):
        """Updates the DeclarationsHolder from a class definition.

        Takes into account all public attributes and OrderedDeclaration
        instances; ignores all attributes starting with '_'.

        Returns a dict containing all remaining elements.
        """
        remaining = {}
        for key, value in attrs.iteritems():
            if isinstance(value, OrderedDeclaration):
                self._ordered[key] = value
            elif not key.startswith('_'):
                self._unordered[key] = value
            else:
                remaining[key] = value
        return remaining

    def __contains__(self, key):
        return key in self._ordered or key in self._unordered

    def __getitem__(self, key):
        try:
            return self._unordered[key]
        except KeyError:
            return self._ordered[key]

    def iteritems(self):
        for pair in self._unordered.iteritems():
            yield pair
        for pair in self._ordered.iteritems():
            yield pair

    def items(self):
        return list(self.iteritems())

    def _extract_sub_fields(self, base):
        """Extract all subfields declaration from a given dict-like object.

        Will compare with attributes declared in the current object, and
        will pop() values from the given base.
        """
        sub_fields = dict()

        for key in list(base):
            if ATTR_SPLITTER in key:
                cls_name, attr_name = key.split(ATTR_SPLITTER, 1)
                if cls_name in self:
                    sub_fields.setdefault(cls_name, {})[attr_name] = base.pop(key)
        return sub_fields

    def build_attributes(self, factory, create=False, extra=None):
        """Build the list of attributes based on class attributes."""
        if not extra:
            extra = {}

        factory.sequence = factory._generate_next_sequence()

        attributes = {}
        sub_fields = {}
        for base in (self._unordered, self._ordered, extra):
            sub_fields.update(self._extract_sub_fields(base))

        def make_value(key, val):
            if key in extra:
                val = extra.pop(key)
            if isinstance(val, SubFactory):
                new_val = val.evaluate(factory, create, sub_fields.get(key, {}))
            elif isinstance(val, OrderedDeclaration):
                wrapper = ObjectParamsWrapper(attributes)
                new_val = val.evaluate(factory, wrapper)
            else:
                new_val = val

            return new_val

        # For fields in _unordered, use the value from extra if any; otherwise,
        # use the default value.
        for key, value in self._unordered.iteritems():
            attributes[key] = make_value(key, value)
        for key, value in self._ordered.iteritems():
            attributes[key] = make_value(key, value)
        attributes.update(extra)
        return attributes

class StubObject(object):
    """A generic container."""

    pass