aeidon/mutables.py

Source code for module aeidon.mutables from file aeidon/mutables.py.

  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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# -*- coding: utf-8 -*-

# Copyright (C) 2006 Osmo Salomaa
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""Observable versions of built-in mutable objects."""

import copy
import functools

__all__ = ("ObservableDict", "ObservableList", "ObservableSet",)


def _mutation(function):
    """Decorator for sending a notification after mutating object."""
    @functools.wraps(function)
    def wrapper(*args, **kwargs):
        value = function(*args, **kwargs)
        args[0].master.notify(args[0].name)
        return value
    return wrapper


class ObservableDict(dict):

    """
    Observable version of ``dict``.

    :ivar master: Master instance with a ``notify`` method
    :ivar name: Argument passed when calling :attr:`master`'s ``notify`` method
    """

    def __init__(self, *args, **kwargs):
        dict.__init__(self, *args[:-2], **kwargs)
        self.master = args[-2]
        self.name = args[-1]

    def __copy__(self):
        dic = dict(copy.copy(x) for  x in self.items())
        return self.__class__(dic, self.master, self.name)

    def __deepcopy__(self, memo):
        dic = dict(copy.deepcopy(x) for  x in self.items())
        return self.__class__(dic, self.master, self.name)

    @_mutation
    def __delitem__(self, *args, **kwargs):
        return dict.__delitem__(self, *args, **kwargs)

    @_mutation
    def __setitem__(self, *args, **kwargs):
        return dict.__setitem__(self, *args, **kwargs)

    @_mutation
    def clear(self, *args, **kwargs):
        return dict.clear(self, *args, **kwargs)

    @_mutation
    def pop(self, *args, **kwargs):
        return dict.pop(self, *args, **kwargs)

    @_mutation
    def popitem(self, *args, **kwargs):
        return dict.popitem(self, *args, **kwargs)

    @_mutation
    def setdefault(self, *args, **kwargs):
        return dict.setdefault(self, *args, **kwargs)

    @_mutation
    def update(self, *args, **kwargs):
        return dict.update(self, *args, **kwargs)


class ObservableList(list):

    """
    Observable version of ``list``.

    :ivar master: Master instance with a ``notify`` method
    :ivar name: Argument passed when calling :attr:`master`'s ``notify`` method
    """

    def __init__(self, *args, **kwargs):
        list.__init__(self, *args[:-2], **kwargs)
        self.master = args[-2]
        self.name = args[-1]

    def __copy__(self):
        lst = list(copy.copy(x) for x in self)
        return self.__class__(lst, self.master, self.name)

    def __deepcopy__(self, memo):
        lst = [copy.deepcopy(x) for x in self]
        return self.__class__(lst, self.master, self.name)

    @_mutation
    def __delitem__(self, *args, **kwargs):
        return list.__delitem__(self, *args, **kwargs)

    @_mutation
    def __iadd__(self, *args, **kwargs):
        return list.__iadd__(self, *args, **kwargs)

    @_mutation
    def __imul__(self, *args, **kwargs):
        return list.__imul__(self, *args, **kwargs)

    @_mutation
    def __setitem__(self, *args, **kwargs):
        return list.__setitem__(self, *args, **kwargs)

    @_mutation
    def append(self, *args, **kwargs):
        return list.append(self, *args, **kwargs)

    @_mutation
    def extend(self, *args, **kwargs):
        return list.extend(self, *args, **kwargs)

    @_mutation
    def insert(self, *args, **kwargs):
        return list.insert(self, *args, **kwargs)

    @_mutation
    def pop(self, *args, **kwargs):
        return list.pop(self, *args, **kwargs)

    @_mutation
    def remove(self, *args, **kwargs):
        return list.remove(self, *args, **kwargs)

    @_mutation
    def reverse(self, *args, **kwargs):
        return list.reverse(self, *args, **kwargs)

    @_mutation
    def sort(self, *args, **kwargs):
        return list.sort(self, *args, **kwargs)


class ObservableSet(set):

    """
    Observable version of ``set``.

    :ivar master: Master instance with a ``notify`` method
    :ivar name: Argument passed when calling :attr:`master`'s ``notify`` method
    """

    def __init__(self, *args, **kwargs):
        set.__init__(self, *args[:-2], **kwargs)
        self.master = args[-2]
        self.name = args[-1]

    def __copy__(self):
        zet = set(copy.copy(x) for x in self)
        return self.__class__(zet, self.master, self.name)

    def __deepcopy__(self, memo):
        zet = set(copy.deepcopy(x) for x in self)
        return self.__class__(zet, self.master, self.name)

    @_mutation
    def __iand__(self, *args, **kwargs):
        return set.__iand__(self, *args, **kwargs)

    @_mutation
    def __ior__(self, *args, **kwargs):
        return set.__ior__(self, *args, **kwargs)

    @_mutation
    def __isub__(self, *args, **kwargs):
        return set.__isub__(self, *args, **kwargs)

    @_mutation
    def __ixor__(self, *args, **kwargs):
        return set.__ixor__(self, *args, **kwargs)

    @_mutation
    def add(self, *args, **kwargs):
        return set.add(self, *args, **kwargs)

    @_mutation
    def clear(self, *args, **kwargs):
        return set.clear(self, *args, **kwargs)

    @_mutation
    def difference_update(self, *args, **kwargs):
        return set.difference_update(self, *args, **kwargs)

    @_mutation
    def discard(self, *args, **kwargs):
        return set.discard(self, *args, **kwargs)

    @_mutation
    def intersection_update(self, *args, **kwargs):
        return set.intersection_update(self, *args, **kwargs)

    @_mutation
    def pop(self, *args, **kwargs):
        return set.pop(self, *args, **kwargs)

    @_mutation
    def remove(self, *args, **kwargs):
        return set.remove(self, *args, **kwargs)

    @_mutation
    def symmetric_difference_update(self, *args, **kwargs):
        return set.symmetric_difference_update(self, *args, **kwargs)

    @_mutation
    def update(self, *args, **kwargs):
        return set.update(self, *args, **kwargs)