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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2015-2017 European Synchrotron Radiation Facility
#
# 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.
#
# ###########################################################################*/
"""This module provides a simple generic notification system."""
from __future__ import absolute_import, division, unicode_literals
__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "25/07/2016"
import logging
from silx.utils.weakref import WeakList
_logger = logging.getLogger(__name__)
# Notifier ####################################################################
class Notifier(object):
"""Base class for object with notification mechanism."""
def __init__(self):
self._listeners = WeakList()
def addListener(self, listener):
"""Register a listener.
Adding an already registered listener has no effect.
:param callable listener: The function or method to register.
"""
if listener not in self._listeners:
self._listeners.append(listener)
else:
_logger.warning('Ignoring addition of an already registered listener')
def removeListener(self, listener):
"""Remove a previously registered listener.
:param callable listener: The function or method to unregister.
"""
try:
self._listeners.remove(listener)
except ValueError:
_logger.warn('Trying to remove a listener that is not registered')
def notify(self, *args, **kwargs):
"""Notify all registered listeners with the given parameters.
Listeners are called directly in this method.
Listeners are called in the order they were registered.
"""
for listener in self._listeners:
listener(self, *args, **kwargs)
def notifyProperty(attrName, copy=False, converter=None, doc=None):
"""Create a property that adds notification to an attribute.
:param str attrName: The name of the attribute to wrap.
:param bool copy: Whether to return a copy of the attribute
or not (the default).
:param converter: Function converting input value to appropriate type
This function takes a single argument and return the
converted value.
It can be used to perform some asserts.
:param str doc: The docstring of the property
:return: A property with getter and setter
"""
if copy:
def getter(self):
return getattr(self, attrName).copy()
else:
def getter(self):
return getattr(self, attrName)
if converter is None:
def setter(self, value):
if getattr(self, attrName) != value:
setattr(self, attrName, value)
self.notify()
else:
def setter(self, value):
value = converter(value)
if getattr(self, attrName) != value:
setattr(self, attrName, value)
self.notify()
return property(getter, setter, doc=doc)
class HookList(list):
"""List with hooks before and after modification."""
def __init__(self, iterable):
super(HookList, self).__init__(iterable)
self._listWasChangedHook('__init__', iterable)
def _listWillChangeHook(self, methodName, *args, **kwargs):
"""To override. Called before modifying the list.
This method is called with the name of the method called to
modify the list and its parameters.
"""
pass
def _listWasChangedHook(self, methodName, *args, **kwargs):
"""To override. Called after modifying the list.
This method is called with the name of the method called to
modify the list and its parameters.
"""
pass
# Wrapping methods that modify the list
def _wrapper(self, methodName, *args, **kwargs):
"""Generic wrapper of list methods calling the hooks."""
self._listWillChangeHook(methodName, *args, **kwargs)
result = getattr(super(HookList, self),
methodName)(*args, **kwargs)
self._listWasChangedHook(methodName, *args, **kwargs)
return result
# Add methods
def __iadd__(self, *args, **kwargs):
return self._wrapper('__iadd__', *args, **kwargs)
def __imul__(self, *args, **kwargs):
return self._wrapper('__imul__', *args, **kwargs)
def append(self, *args, **kwargs):
return self._wrapper('append', *args, **kwargs)
def extend(self, *args, **kwargs):
return self._wrapper('extend', *args, **kwargs)
def insert(self, *args, **kwargs):
return self._wrapper('insert', *args, **kwargs)
# Remove methods
def __delitem__(self, *args, **kwargs):
return self._wrapper('__delitem__', *args, **kwargs)
def __delslice__(self, *args, **kwargs):
return self._wrapper('__delslice__', *args, **kwargs)
def remove(self, *args, **kwargs):
return self._wrapper('remove', *args, **kwargs)
def pop(self, *args, **kwargs):
return self._wrapper('pop', *args, **kwargs)
# Set methods
def __setitem__(self, *args, **kwargs):
return self._wrapper('__setitem__', *args, **kwargs)
def __setslice__(self, *args, **kwargs):
return self._wrapper('__setslice__', *args, **kwargs)
# In place methods
def sort(self, *args, **kwargs):
return self._wrapper('sort', *args, **kwargs)
def reverse(self, *args, **kwargs):
return self._wrapper('reverse', *args, **kwargs)
class NotifierList(HookList, Notifier):
"""List of Notifiers with notification mechanism.
This class registers itself as a listener of the list items.
The default listener method forward notification from list items
to the listeners of the list.
"""
def __init__(self, iterable=()):
Notifier.__init__(self)
HookList.__init__(self, iterable)
def _listWillChangeHook(self, methodName, *args, **kwargs):
for item in self:
item.removeListener(self._notified)
def _listWasChangedHook(self, methodName, *args, **kwargs):
for item in self:
item.addListener(self._notified)
self.notify()
def _notified(self, source, *args, **kwargs):
"""Default listener forwarding list item changes to its listeners."""
# Avoid infinite recursion if the list is listening itself
if source is not self:
self.notify(*args, **kwargs)
|
